list method

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

Lists the products in your Merchant Center account.

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

Request parameters:

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

maxResults - The maximum number of products to return in the response, used for paging. The default value is 25. The maximum value is 250.

pageToken - The token returned by the previous request.

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

Completes with a ProductsListResponse.

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

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

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