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 diese Methode die Antwort nach einem customerNamePrefix filtern. 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 Abfragestring customerAuthToken ist erforderlich, wenn Sie ein weiterverkauftes Konto erstellen, mit dem 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 Aboübertragung erforderlich ist. Weitere Informationen finden Sie in der Hilfe für Administratoren.

customerId

string

Das kann entweder der primäre Domainname des Kunden oder die eindeutige Kennung des Kunden sein. Wenn sich der Domainname für einen Kunden ändert, kann der alte Domainname nicht für den Zugriff auf den Kunden verwendet werden. Die eindeutige Kennung des Kunden, die von der API zurückgegeben wird, kann jedoch immer verwendet werden. Wir empfehlen, die eindeutige Kennung gegebenenfalls in Ihren Systemen zu speichern.

customerNamePrefix

string

Wenn Sie alle Ihre Abos abrufen und nach bestimmten Kunden filtern, können Sie ein Präfix für einen Kundennamen eingeben. Beispiel für eine Kundengruppe mit exam.com, example20.com und example.com:

  • exa: Gibt alle Kundennamen zurück, die mit „exa“ beginnen. Dazu gehören exam.com, example20.com und example.com. Ein Namenspräfix ähnelt der Verwendung des Sternchens eines regulären Ausdrucks, exa*.
  • example: Gibt example20.com und example.com zurück.

maxResults

integer (uint32 format)

Beim Abrufen einer langen Liste gibt maxResults die maximale Anzahl von Ergebnissen pro Seite an. Über den Wert nextPageToken gelangen Sie zur nächsten Seite. Der Standardwert ist 20.

pageToken

string

Token zur Angabe der nächsten Seite in der Liste

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Ein Abo verwaltet die Beziehung zwischen dem Preismodell eines Google-Kunden und der Artikelnummer eines Produkts, Nutzerlizenzen, dem Status einer kostenlosen 30-tägigen Testversion und Verlängerungsoptionen. Eine primäre Rolle 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

Kennzeichnet 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.