Method: subscriptions.list

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.