Method: subscriptions.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
listy subskrypcji zarządzanych przez sprzedawcę. Lista może zawierać wszystkie subskrypcje, wszystkie subskrypcje klienta lub wszystkie przenoszone subskrypcje klienta.
Opcjonalnie metoda może odfiltrować odpowiedź według customerNamePrefix. Więcej informacji znajdziesz w artykule o zarządzaniu subskrypcjami.
Żądanie HTTP
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
| Parametry |
customerAuthToken |
string
Parametr zapytania customerAuthToken jest wymagany podczas tworzenia konta sprzedawcy, które przenosi subskrypcję klienta indywidualnego lub przenosi subskrypcję innego klienta sprzedawcy do zarządzania przez sprzedawcę. To szesnastkowy token uwierzytelniania potrzebny do przeniesienia subskrypcji. Więcej informacji znajdziesz w Centrum pomocy dla administratorów.
|
customerId |
string
Może to być nazwa domeny podstawowej klienta lub jego unikalny identyfikator. Jeśli nazwa domeny klienta ulegnie zmianie, nie będzie można jej używać do uzyskiwania dostępu do klienta, ale zawsze można użyć jego unikalnego identyfikatora (zwracanego przez interfejs API). W stosownych przypadkach zalecamy przechowywanie w swoich systemach unikalnego identyfikatora.
|
customerNamePrefix |
string
Podczas pobierania wszystkich subskrypcji i filtrowania ich według konkretnych klientów możesz wpisać prefiks nazwy klienta. Na przykładzie grupy klientów, która obejmuje klientów exam.com, example20.com i example.com: exa – zwraca wszystkie nazwy klientów, które zaczynają się od „exa”, np. exam.com, example20.com i example.com. Prefiks nazwy jest podobny do gwiazdki w wyrażeniu regularnym, np. exa*.example – zwraca wartości example20.com i example.com.
|
maxResults |
integer (uint32 format)
Podczas pobierania dużej listy parametr maxResults to maksymalna liczba wyników na stronę. Wartość nextPageToken przekierowuje Cię na następną stronę. Wartość domyślna to 20.
|
pageToken |
string
Token określający następną stronę na liście
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Subskrypcja zarządza relacją abonamentu klienta Google z kodem SKU produktu, licencjami użytkownika, stanem 30-dniowego bezpłatnego okresu próbnego i opcjami odnowienia. Głównym zadaniem sprzedawcy jest zarządzanie subskrypcjami klienta Google.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"kind": string,
"subscriptions": [
{
object (Subscription)
}
],
"nextPageToken": string
} |
| Pola |
kind |
string
Identyfikuje zasób jako zbiór subskrypcji. Wartość: reseller#subscriptions
|
subscriptions[] |
object (Subscription)
subskrypcje na tej stronie wyników;
|
nextPageToken |
string
token kontynuacji, który służy do przewijania dużych zbiorów wyników. Aby pobrać kolejną stronę wyników, podaj tę wartość w koleistycznym żądaniu.
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/apps.order
https://www.googleapis.com/auth/apps.order.readonly
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]
