list method

Future<ListCollectionsResponse> list(
  1. String merchantId, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists the collections in your Merchant Center account.

The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.

Request parameters:

merchantId - Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

pageSize - The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.

pageToken - Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

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

Completes with a ListCollectionsResponse.

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<ListCollectionsResponse> list(
  core.String merchantId, {
  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_ = commons.escapeVariable('$merchantId') + '/collections';

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