GOgoogle
promotions

GET /{merchantId}/promotions

List all promotions from your Merchant Center account.

Request

  • Base URL
    https://shoppingcontent.googleapis.com/content/v2.1
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/content
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/content
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

merchantIdstring required

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

Query parameters

countryCodestring

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

languageCodestring

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

pageSizeinteger

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.

pageTokenstring

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.

Response

Successful response

nextPageTokenstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.