Method: partners.promotions.list

  • Retrieves available promotions, such as free trials, for partners to resell, excluding YouTube promotions currently.

  • Requires authentication with a service account and uses a GET request to the specified endpoint.

  • Allows filtering of promotion results by applicableProducts, regionCodes, youtubePayload.partnerEligibilityId, and youtubePayload.postalCode.

  • Responses include a list of promotions and a token for pagination if more results are available.

  • The API uses gRPC Transcoding and the request body should be empty.

Currently, it doesn't support YouTube promotions.

Retrieves the promotions, such as free trial, that can be used by the partner.

It should be autenticated with a service account.

HTTP request

GET https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/promotions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, the partner that can resell. Format: partners/{partner}

Query parameters

Parameters
filter

string

Optional. Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats:

  1. Only the following features are supported:
    • Logical operator AND
    • Comparison operator = (no wildcards *)
    • Traversal operator .
    • Has operator : (no wildcards *)
  2. Only the following fields are supported:
    • applicableProducts
    • regionCodes
    • youtubePayload.partnerEligibilityId
    • youtubePayload.postalCode
  3. Unless explicitly mentioned above, other features are not supported. Example:

applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id
pageSize

integer

Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. 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.

Request body

The request body must be empty.

Response body

Response that contains the promotions.

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

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

object (Promotion)

The promotions for the specified partner.
nextPageToken

string

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