list method
List all promotions from your Merchant Center account.
Request parameters:
merchantId
- Required. The ID of the account that contains the
collection.
countryCode
-
CLDR country code
(for example, "US"), used as a filter on promotions target country.
languageCode
- The two-letter ISO 639-1 language code associated with
the promotions, used as a filter.
pageSize
- The maximum number of promotions to return. The service may
return fewer than this value. If unspecified, at most 50 labels will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
pageToken
- A page token, received from a previous ListPromotion
call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListPromotion
must match the call that provided
the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListPromotionResponse.
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<ListPromotionResponse> list(
core.String merchantId, {
core.String? countryCode,
core.String? languageCode,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (countryCode != null) 'countryCode': [countryCode],
if (languageCode != null) 'languageCode': [languageCode],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = commons.escapeVariable('$merchantId') + '/promotions';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListPromotionResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}