Method: partners.products.list
Stay organized with collections
Save and categorize content based on your preferences.
Currently, it doesn't support YouTube products.
Retrieves the products that can be resold by the partner. It should be autenticated with a service account.
HTTP request
GET https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/products
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 product 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:
regionCodesyoutubePayload.partnerEligibilityIdyoutubePayload.postalCode
- Unless explicitly mentioned above, other features are not supported. Example:
regionCodes:US AND youtubePayload.postalCode=94043 AND
youtubePayload.partnerEligibilityId=eligibility-id
|
pageSize |
integer
Optional. The maximum number of products 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 products.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to products.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response that contains the products.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"products": [
{
object (Product)
}
],
"nextPageToken": string
} |
| Fields |
products[] |
object (Product)
The products 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.
|
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\u003eRetrieve products for resale by a partner, requiring service account authentication.\u003c/p\u003e\n"],["\u003cp\u003eFilter products by region, eligibility ID, and postal code using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe API returns a paginated list of products with details and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eYouTube products are currently not supported by this API.\u003c/p\u003e\n"]]],["This API endpoint retrieves resalable products for a specified partner, excluding YouTube products. It requires service account authentication. The `GET` request uses the URL `https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/products`. The `parent` path parameter, representing the partner, is mandatory. Optional query parameters include `filter` for specific product criteria, `pageSize` to limit results, and `pageToken` for pagination. The request body must be empty, and the response includes a list of `products` and an optional `nextPageToken`.\n"],null,["# Method: partners.products.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.ListProductsResponse.SCHEMA_REPRESENTATION)\n\nCurrently, it doesn't support **YouTube** products.\n\nRetrieves the products that can be resold by the partner. It should be autenticated with a service account.\n\n### HTTP request\n\n`GET https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/products`\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 product 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: - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id` |\n| `pageSize` | `integer` Optional. The maximum number of products 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 `products.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `products.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 products.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"products\": [ { object (/payments/reseller/subscription/reference/rest/v1/partners.products#Product) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `products[]` | `object (`[Product](/payments/reseller/subscription/reference/rest/v1/partners.products#Product)`)` The products 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. |"]]