list method

Future<AccountsListResponse> list(
  1. String merchantId, {
  2. String? label,
  3. int? maxResults,
  4. String? name,
  5. String? pageToken,
  6. String? view,
  7. String? $fields,
})

Lists the sub-accounts in your Merchant Center account.

Request parameters:

merchantId - The ID of the managing account. This must be a multi-client account.

label - If view is set to "css", only return accounts that are assigned label with given ID.

maxResults - The maximum number of accounts to return in the response, used for paging.

name - If set, only the accounts with the given name (case sensitive) will be returned.

pageToken - The token returned by the previous request.

view - Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant". Possible string values are:

  • "MERCHANT" : Default. View is populated with Merchant Center fields.
  • "CSS" : View is populated with Comparison Shopping Services fields.

$fields - Selector specifying which fields to include in a partial response.

Completes with a AccountsListResponse.

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<AccountsListResponse> list(
  core.String merchantId, {
  core.String? label,
  core.int? maxResults,
  core.String? name,
  core.String? pageToken,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (label != null) 'label': [label],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (name != null) 'name': [name],
    if (pageToken != null) 'pageToken': [pageToken],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = commons.escapeVariable('$merchantId') + '/accounts';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return AccountsListResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}