Method: promotions.list

  • Lists all promotions from a specified Merchant Center account using the promotions.list method.

  • Allows filtering by country code, language, page size, and provides pagination with page tokens for retrieving large result sets.

  • Request body should be empty, and successful responses contain a list of Promotion objects and a nextPageToken if applicable.

  • Requires authorization with the https://www.googleapis.com/auth/content scope.

List all promotions from your Merchant Center account.

HTTP request

GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/promotions

Path parameters

Parameters
merchantId

string (int64 format)

Required. The ID of the account that contains the collection.

Query parameters

Parameters
pageSize

integer

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

string

A page token, received from a previous promotions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to promotions.list must match the call that provided the page token.
countryCode

string

CLDR country code (for example, "US"), used as a filter on promotions target country.
languageCode

string

The two-letter ISO 639-1 language code associated with the promotions, used as a filter.

Request body

The request body must be empty.

Response body

Response message for Promotions.List method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "nextPageToken": string
}
Fields
promotions[]

object (Promotion)

List of all available promotions for the merchant.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.