Method: partners.promotions.list
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\u003eRetrieves available promotions, such as free trials, for partners to resell, excluding YouTube promotions currently.\u003c/p\u003e\n"],["\u003cp\u003eRequires authentication with a service account and uses a \u003ccode\u003eGET\u003c/code\u003e request to the specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of promotion results by \u003ccode\u003eapplicableProducts\u003c/code\u003e, \u003ccode\u003eregionCodes\u003c/code\u003e, \u003ccode\u003eyoutubePayload.partnerEligibilityId\u003c/code\u003e, and \u003ccode\u003eyoutubePayload.postalCode\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eResponses include a list of promotions and a token for pagination if more results are available.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses gRPC Transcoding and the request body should be empty.\u003c/p\u003e\n"]]],["This API retrieves partner promotions (excluding YouTube promotions) via a `GET` request to `https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/promotions`. Authentication with a service account is required. The `parent` path parameter specifies the partner. Optional query parameters include `filter` (to refine promotions), `pageSize` (to limit results), and `pageToken` (for pagination). The request body must be empty. The response contains a list of `promotions` and a `nextPageToken` for further pages.\n"],null,["# Method: partners.promotions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPromotionsResponse.SCHEMA_REPRESENTATION)\n\nCurrently, it doesn't support **YouTube** promotions.\n\nRetrieves the promotions, such as free trial, that can be used by the partner.\n\nIt should be autenticated with a service account.\n\n### HTTP request\n\n`GET https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/promotions`\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### Query parameters\n\n| Parameters ||\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### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse that contains the promotions.\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 specified partner. |\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. |"]]