list method
Lists all users of a Merchant Center account.
Request parameters:
parent
- Required. The parent, which owns this collection of users.
Format: accounts/{account}
Value must have pattern ^accounts/\[^/\]+$
.
pageSize
- Optional. The maximum number of users to return. The service
may return fewer than this value. If unspecified, at most 50 users will be
returned. The maximum value is 100; values above 100 will be coerced to
100
pageToken
- Optional. A page token, received from a previous ListUsers
call. Provide this to retrieve the subsequent page. When paginating, all
other parameters provided to ListUsers
must match the call that provided
the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListUsersResponse.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<ListUsersResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'accounts/v1/' + core.Uri.encodeFull('$parent') + '/users';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListUsersResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}