Method: partners.promotions.findEligible
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-12 UTC.
[null,null,["Last updated 2025-03-12 UTC."],[[["\u003cp\u003eFind eligible promotions for the current user based on specified filters.\u003c/p\u003e\n"],["\u003cp\u003eRequires user authorization with at least the \u003ccode\u003eopenid\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eRequest body allows for filtering by applicable products, region codes, and YouTube payload details.\u003c/p\u003e\n"],["\u003cp\u003eResponse provides a list of eligible promotions and a token for pagination if more results are available.\u003c/p\u003e\n"]]],["The API uses a `POST` request to `https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/promotions:findEligible` to find eligible promotions. The `parent` path parameter is required, specifying the partner. The request body accepts optional `filter`, `pageSize`, and `pageToken` fields for querying. The response body includes an array of `promotions` and an optional `nextPageToken` for pagination. User authorization via OAuth with at least the `openid` scope is required.\n"],null,["# Method: partners.promotions.findEligible\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.FindEligiblePromotionsResponse.SCHEMA_REPRESENTATION)\n\nCurrently, it is only enabeld for **YouTube**.\n\nFinds 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.\n\n### HTTP request\n\n`POST https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/promotions:findEligible`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent, the partner that can resell. Format: partners/{partner} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------|\n| ``` { \"filter\": string, \"pageSize\": integer, \"pageToken\": string } ``` |\n\n| Fields ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional. Specifies the filters for the promotion results. The syntax is defined in \u003chttps://google.aip.dev/160\u003e 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` |\n| `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. |\n| `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. |\n\n### Response body\n\nResponse containing the found promotions for the current user.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"promotions\": [ { object (/payments/reseller/subscription/reference/rest/v1/partners.promotions#Promotion) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `promotions[]` | `object (`[Promotion](/payments/reseller/subscription/reference/rest/v1/partners.promotions#Promotion)`)` The promotions for the current user. |\n| `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. |"]]