GOgoogle
partners

POST /v1/partners/{partnersId}/promotions:findEligible

Currently, it is only enabled for YouTube. Finds eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope openid is sufficient, which will skip the consent screen.

Request

  • Base URL
    https://paymentsresellersubscription.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/sdm.service
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/sdm.service

Path parameters

partnersIdstring required

Request body

filterstring

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

pageSizeinteger

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

pageTokenstring

Optional. A page token, received from a previous FindEligiblePromotions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FindEligiblePromotions 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 empty, there are no subsequent pages.

Changes

No recorded changes to this operation across all 4 revisions of this API.