Method: partners.promotions.findEligible

Stay organized with collections Save and categorize content based on your preferences.

To find eligible promotions for the current user. The API requires user authorization via OAuth. The user is inferred from the authenticated OAuth credential.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "filter": string,
  "pageSize": integer,
  "pageToken": string
}
Fields
filter

string

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

  • Only the following features are supported:
    • Logical operator AND
    • Comparison operator = (no wildcards *)
    • Traversal operator .
    • Has operator : (no wildcards *)
  • Only the following fields are supported:
    • applicableProducts
    • regionCodes
    • youtubePayload.partnerEligibilityId
    • youtubePayload.postalCode
  • 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.

Response body

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

Response containing the found promotions for the current user.

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

object (Promotion)

The promotions for the current user.

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.