Method: subscriptions.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Списки подписок, управляемых реселлером. В список могут входить все подписки, все подписки клиента или все передаваемые подписки клиента.
При желании этот метод может фильтровать ответ по customerNamePrefix . Дополнительную информацию см. в разделе Управление подписками .
HTTP-запрос
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
| Параметры |
|---|
customerAuthToken | string Строка запроса customerAuthToken требуется при создании перепродаваемой учетной записи, которая передает подписку прямого клиента или передает подписку другого клиента-посредника в управление вашего торгового посредника. Это шестнадцатеричный токен аутентификации, необходимый для завершения передачи подписки. Дополнительную информацию см. в справочном центре администратора . |
customerId | string Это может быть либо основное доменное имя клиента, либо уникальный идентификатор клиента. Если доменное имя клиента изменится, старое доменное имя нельзя будет использовать для доступа к клиенту, но всегда можно использовать уникальный идентификатор клиента (возвращаемый API). Мы рекомендуем хранить уникальный идентификатор в ваших системах, где это возможно. |
customerNamePrefix | string При получении всех ваших подписок и фильтрации по конкретным клиентам вы можете ввести префикс для имени клиента. Используя пример группы клиентов, включающей exam.com , example20.com и example.com : -
exa — возвращает все имена клиентов, начинающиеся с «exa», которые могут включать в себя exam.com , example20.com и example.com . Префикс имени аналогичен использованию звездочки в регулярном выражении exa*. -
example — Возвращает example20.com и example.com .
|
maxResults | integer ( uint32 format) При получении большого списка maxResults — это максимальное количество результатов на странице. Значение nextPageToken приведет вас на следующую страницу. По умолчанию — 20. |
pageToken | string Токен для указания следующей страницы в списке |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Подписка управляет связью плана оплаты клиента Google с номером SKU продукта, пользовательскими лицензиями, статусом 30-дневной бесплатной пробной версии и вариантами продления. Основная роль реселлера – управление подписками клиентов Google.
В случае успеха тело ответа содержит данные следующей структуры:
| JSON-представление |
|---|
{
"kind": string,
"subscriptions": [
{
object (Subscription)
}
],
"nextPageToken": string
} |
| Поля |
|---|
kind | string Идентифицирует ресурс как коллекцию подписок. Значение: реселлер#подписки |
subscriptions[] | object ( Subscription ) Подписки на этой странице результатов. |
nextPageToken | string Токен продолжения, используемый для постраничного просмотра больших наборов результатов. Укажите это значение в последующем запросе, чтобы вернуть следующую страницу результатов. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/apps.order -
https://www.googleapis.com/auth/apps.order.readonly
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],null,["# Method: subscriptions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Subscriptions.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.\n\nOptionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions).\n\n### HTTP request\n\n`GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerAuthToken` | `string` The `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the [administrator help center](//support.google.com/a/bin/answer.py?answer=142336). |\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `customerNamePrefix` | `string` When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes `exam.com`, `example20.com` and `example.com`: - `exa` -- Returns all customer names that start with 'exa' which could include `exam.com`, `example20.com`, and `example.com`. A name prefix is similar to using a regular expression's asterisk, exa\\*. - `example` -- Returns `example20.com` and `example.com`. \u003cbr /\u003e |\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` When retrieving a large list, the `maxResults` is the maximum number of results per page. The `nextPageToken` value takes you to the next page. The default is 20. |\n| `pageToken` | `string` Token to specify next page in the list |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA subscription manages the relationship of a Google customer's payment plan with a product's SKU, user licenses, 30-day free trial status, and renewal options. A primary role of a reseller is to manage the Google customer's subscriptions.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"subscriptions\": [ { object (/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions |\n| `subscriptions[]` | `object (`[Subscription](/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription)`)` The subscriptions in this page of results. |\n| `nextPageToken` | `string` The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/apps.order`\n- `\n https://www.googleapis.com/auth/apps.order.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
