Merchant API (merchantapi:promotions_v1beta)

2024-06-14

3 new methods | New API

Additions

    Methods
  • merchantapi.accounts.promotions.insert

      Path : promotions/v1beta/{+parent}/promotions:insert

      Flat Path : promotions/v1beta/accounts/{accountsId}/promotions:insert

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The account where the promotion will be inserted. Format: accounts/{account}

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead.

  • merchantapi.accounts.promotions.get

      Path : promotions/v1beta/{+name}

      Flat Path : promotions/v1beta/accounts/{accountsId}/promotions/{promotionsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the promotion to retrieve. Format: `accounts/{account}/promotions/{promotions}`

          Pattern : ^accounts/[^/]+/promotions/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Retrieves the promotion from your Merchant Center account. After inserting or updating a promotion input, it may take several minutes before the updated promotion can be retrieved.

  • merchantapi.accounts.promotions.list

      Path : promotions/v1beta/{+parent}/promotions

      Flat Path : promotions/v1beta/accounts/{accountsId}/promotions

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The account to list processed promotions for. Format: `accounts/{account}`

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Output only. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of promotions will be returned.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Output only. 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.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : 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.