list method

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

Lists the promotions in your Merchant Center account.

The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting or updating a promotion, it may take several minutes before the updated processed promotion can be retrieved.

Request parameters:

parent - Required. The account to list processed promotions for. Format: accounts/{account} Value must have pattern ^accounts/\[^/\]+$.

pageSize - Optional. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned.

pageToken - Optional. A page token, received from a previous ListPromotions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPromotions must match the call that provided the page token.

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

Completes with a ListPromotionsResponse.

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<ListPromotionsResponse> 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_ =
      'promotions/v1/' + core.Uri.encodeFull('$parent') + '/promotions';

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