Method: subscriptions.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Listen der vom Reseller verwalteten Abos. Die Liste kann alle Abos, alle Abos eines Kunden oder alle übertragbaren Abos eines Kunden enthalten.
Optional kann mit dieser Methode die Antwort nach einem customerNamePrefix gefiltert werden. Weitere Informationen finden Sie unter Abos verwalten.
HTTP-Anfrage
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
| Parameter |
customerAuthToken |
string
Der customerAuthToken-Suchstring ist erforderlich, wenn Sie ein Reseller-Konto erstellen, über das das Abo eines Direktkunden oder das Abo eines anderen Reseller-Kunden an Ihre Reseller-Verwaltung übertragen wird. Dies ist ein hexadezimales Authentifizierungstoken, das für die Übertragung des Abos erforderlich ist. Weitere Informationen finden Sie in der Administratorhilfe.
|
customerId |
string
Dies kann entweder der primäre Domainname des Kunden oder seine eindeutige Kennung sein. Wenn sich der Domainname eines Kunden ändert, kann der alte Domainname nicht mehr zum Zugriff auf den Kunden verwendet werden. Die eindeutige Kennung des Kunden (wie von der API zurückgegeben) kann jedoch immer verwendet werden. Wir empfehlen, die eindeutige Kennung gegebenenfalls in Ihren Systemen zu speichern.
|
customerNamePrefix |
string
Wenn du alle deine Abos abrufen und nach bestimmten Kunden filtern möchtest, kannst du ein Präfix für einen Kundennamen eingeben. Angenommen, Sie haben eine Kundengruppe mit den Kunden exam.com, example20.com und example.com: exa – Gibt alle Kundennamen zurück, die mit „exa“ beginnen, z. B. exam.com, example20.com und example.com. Ein Namenspräfix ist mit dem Sternchen eines regulären Ausdrucks vergleichbar, z. B. exa*.example – Gibt example20.com und example.com zurück.
|
maxResults |
integer (uint32 format)
Beim Abrufen einer großen Liste ist maxResults die maximale Anzahl von Ergebnissen pro Seite. Über den Wert nextPageToken gelangen Sie zur nächsten Seite. Der Standardwert ist 20.
|
pageToken |
string
Token, um die nächste Seite in der Liste anzugeben
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Ein Abo verwaltet die Beziehung zwischen dem Abrechnungsmodell eines Google-Kunden und der Artikelnummer eines Produkts, den Nutzerlizenzen, dem Status des 30-tägigen Testzeitraums und den Verlängerungsoptionen. Eine Hauptaufgabe eines Resellers besteht darin, die Abos des Google-Kunden zu verwalten.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"kind": string,
"subscriptions": [
{
object (Subscription)
}
],
"nextPageToken": string
} |
| Felder |
kind |
string
Identifiziert die Ressource als Sammlung von Abos. Wert: reseller#subscriptions
|
subscriptions[] |
object (Subscription)
Die Abos auf dieser Ergebnisseite.
|
nextPageToken |
string
Das Fortsetzungstoken, das zum Durchblättern großer Ergebnismengen verwendet wird. Geben Sie diesen Wert in einer nachfolgenden Anfrage an, um die nächste Ergebnisseite zurückzugeben.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/apps.order
https://www.googleapis.com/auth/apps.order.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]
