Method: subscriptions.list

Listen der Abos, die vom Reseller verwaltet werden. 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 Abfragestring customerAuthToken ist erforderlich, wenn Sie ein Konto für einen Reseller erstellen, mit dem das Abo eines Direktkunden oder das Abo eines anderen Reseller-Kunden an Ihre Reseller-Verwaltung übertragen wird. Das ist ein hexadezimales Authentifizierungstoken, das für die Aboübertragung benötigt wird. 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 mehr für den Zugriff auf den Kunden verwendet werden. Es kann jedoch immer die eindeutige ID des Kunden (die von der API zurückgegeben wird) 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. Hier ein Beispiel für eine Kundengruppe mit exam.com, example20.com und example.com:

  • exa: Gibt alle Kundennamen zurück, die mit „exa“ beginnen. Dies kann exam.com, example20.com und example.com enthalten. Ein Namenspräfix ähnelt der Verwendung des Sternchens exa* eines regulären Ausdrucks.
  • 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. Mit dem 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

Mit einem Abo wird die Beziehung zwischen dem Preismodell eines Google-Kunden mit der Artikelnummer, den Nutzerlizenzen, dem Status der kostenlosen 30-tägigen Testversion und den Verlängerungsoptionen verwaltet. Eine Hauptaufgabe von Resellern besteht darin, die Abos von 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 Durchsuchen großer Ergebnissätze 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.