Sammlungspartner-Abos

Resource PartnerSubscription

Eine Ansicht eines Abonnements mit den Informationen, die zum Ausführen des Abonnements erforderlich sind. Ein Abo ist eine Vereinbarung zwischen dem Kunden und Google, die besagt, dass der Kunde eine bestimmte Ressource von Google für einen bestimmten Zeitraum erwirbt.

Ein Abo ist ein einzelner Kauf. Wenn der Nutzer seinen Einkauf storniert und neu beginnt oder die abonnierte Ressource ändert, einschließlich Upgrade oder Downgrade des Service Levels, wird dafür ein neues Abo eingerichtet. Das neue Abo hat einen neuen name, aber dieselbe externalAccountId wie das alte Abo.

JSON-Darstellung 

{
  "name": string,
  "externalAccountId": string,
  "version": string,
  "status": enum(Status),
  "subscribedResources": [
    {
      object(SubscribedResource)
    }
  ],
  "requiredApprovals": [
    {
      object(RequiredApproval)
    }
  ],
  "startDate": {
    object(Date)
  },
  "endDate": {
    object(Date)
  },
  "createTime": string,
  "updateTime": string,
}
Feldname Typ Beschreibung
name string Der Name für dieses Abo. Diese wird beim Erstellen des Abos automatisch generiert. Er hat das Format subscriptions/*, wobei * ein intransparenter String ist.
externalAccountId string Die ID für das Konto, dem dieses Abo gehört. Diese ID ist für ein bestimmtes Konto und einen bestimmten Abonnementanbieter eindeutig.
version string Eine intransparente Versionsnummer für diesen Eintrag. Damit können Sie ganz einfach nach Updates für ein Abo suchen.
status enum(Status) Der aktuelle Status dieses Abos.
subscribedResources[] object(SubscribedResource) Die in diesem Abo enthaltenen Ressourcen. Alle diese Ressourcen müssen zum gleichen Abonnementanbieter gehören.
requiredApprovals[] object(RequiredApproval) Stellt eine Reihe von Genehmigungen dar, die alle erteilt werden müssen, damit das Abo ACTIVE wird. Wenn für ein Abo null Genehmigungen erforderlich sind, ist zum AKTIVIEREN keine Genehmigung erforderlich.
startDate object(Date) Das Datum, an dem dieses Abo begann.
endDate object(Date) Das Datum, an dem dieses Abo beendet wurde, falls der Status COMPLETE ist. Andernfalls ist das Feld leer.
createTime string

Zeitstempel für die Erstellung des Abos. Eingaben werden in diesem Fall vom Server ignoriert. @OutputOnly

Ein Zeitstempel im Format RFC3339 UTC "Zulu" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
updateTime string

Zeitstempel für die letzte Änderung des Abos. Eingaben werden in diesem Fall vom Server ignoriert. @OutputOnly

Ein Zeitstempel im Format RFC3339 UTC "Zulu" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".

Status

Der aktuelle Status des Abos.

Aufzählungswert Beschreibung
UNKNOWN_STATUS Standardwert Dieser Wert sollte nie zurückgegeben werden.
ACTIVE Das Abo wurde verarbeitet und läuft jetzt.
COMPLETE Das Abo war einmal aktiv, ist jetzt aber beendet. Wenn ein Abo als abgeschlossen gekennzeichnet ist, wird es nie wieder ACTIVE.
PENDING Das Abo wurde erstellt, aber noch nicht begonnen. Das Startdatum kann in der Zukunft liegen und/oder ein oder mehrere RequiredApprovals erfordern.
CANCELED Das Abo konnte nicht ausgeführt werden. Es wurde storniert, bevor es ACTIVE wurde.

SubscriptionResource

Dient zur Identifizierung einer einzelnen Ressource, die von einem Abo erworben wurde, einschließlich des Abonnementanbieters, der Ressource und zusätzlicher Metadaten zur Identifizierung der erworbenen Ressource.

JSON-Darstellung 

{
  "subscriptionProvider": string,
  "resource": string,
  "labels": {
    string: string,
    ...
  },
}
Feldname Typ Beschreibung
subscriptionProvider string Der Name des Anbieters der Ressource, die abonniert wird. Wenn das Abo mit einer vorhandenen API verknüpft ist, sollte dies die URL für diese API sein (z. B. example.googleapis.com). Wenn die Ressource nicht mit einer vorhandenen API verknüpft ist, entspricht der Name der URL für diese API, der der Name des Anbieters vorangestellt ist (z. B. example-cloudbilling.googleapis.com).
resource string Der Name des Ressourcentyps, der abonniert werden soll. Dies ist ein Camel-Case-Name, der beschreibt, was erworben wird und der beim Konfigurieren eines neuen Ressourcentyps definiert wird.
labels map (key: string, value: string)

Die Sammlung von Labels für diese Ressource. Diese können verwendet werden, um eine benutzerdefinierte Konfiguration für diese Ressource bereitzustellen oder zusätzliche Metadaten zu speichern.

Labels werden häufig verwendet, um die Servicestufe für Abonnementtypen mit mehreren Stufen anzugeben. Für ein Supportabo mit Silber- und Goldstufe könnte beispielsweise ein Label mit dem Schlüssel "SupportLevel" verwendet werden, der die möglichen Werte "Gold" und "Silber" hat.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Erforderliche Genehmigung

Stellt eine Genehmigung dar, die vor Beginn des Abonnements erteilt werden muss. Dies kann entweder eine automatisierte oder eine manuelle Genehmigung sein. Genehmigungen werden automatisch bei der Erstellung des Abos erstellt. Eine Genehmigung kann genehmigt oder abgelehnt werden. Nach der Genehmigung oder Ablehnung kann der Status einer Genehmigung nicht mehr geändert werden.

JSON-Darstellung 

{
  "name": string,
  "status": enum(Status),
  "approvalTime": string,
  "approvalNote": string,
}
Feldname Typ Beschreibung
name string Der Name für diese Genehmigung. Sie muss den Wert "default-approval" haben.
status enum(Status) Der Status dieser Genehmigung. Wenn ein Abo mit einer Genehmigung erstellt wird, muss dieser Wert PENDING sein. Beim Aktualisieren einer Genehmigung sollte er auf APPROVED oder DENIED gesetzt werden.
approvalTime string

Der Zeitpunkt, zu dem diese Genehmigung erteilt oder verweigert wurde. Dies wird automatisch festgelegt. @OutputOnly

Ein Zeitstempel im Format RFC3339 UTC "Zulu" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
approvalNote string Eine Erklärung für die Statusänderung. Dies ist optional, wenn der Status APPROVED ist, und erforderlich, wenn der Status DENIED ist.

Status

Gibt den aktuellen Status der erforderlichen Genehmigung an.

Aufzählungswert Beschreibung
STATUS_UNSPECIFIED Standardwert Dieser Wert sollte nie zurückgegeben werden.
PENDING Die Genehmigung wurde weder erteilt noch abgelehnt.
APPROVED Die Genehmigung wurde erteilt.
DENIED Die Genehmigung wurde verweigert.

Datum

Stellt ein vollständiges Kalenderdatum dar, z. B. ein Geburtsdatum. Die Uhrzeit und die Zeitzone werden entweder an einer anderen Stelle angegeben oder sind nicht relevant. Das Datum wird relativ zum proleptischen gregorianischen Kalender angegeben. Als Tag kann 0 angegeben werden, wenn für eine Jahres- und Monatsangabe der Tag nicht von Belang ist, z. B. beim Ablaufdatum einer Kreditkarte. Für das Jahr kann 0 angegeben werden, wenn ein Monat und Tag unabhängig vom Jahr angegeben wird, z. B. ein Jahrestag. Vergleichbare Typen sind [google.typeTimeOfDay][] und google.protobuf.Timestamp.

JSON-Darstellung 

{
  "year": number,
  "month": number,
  "day": number,
}
Feldname Typ Beschreibung
year number Jahr des Datums. Es muss zwischen 1 und 9999 liegen oder kann 0 sein, wenn ein Datum ohne Jahresangabe angegeben wird.
month number Monat des Jahres. Möglich ist eine Angabe von 1 bis 12.
day number Tag des Monats. Die Angabe muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein. Sie kann auch 0 sein, wenn das Jahr bzw. der Monat angegeben wird und der Tag keine Bedeutung hat.

Methoden

Method Beschreibung
approve Ändert in einem Partnerabo den Status einer PENDING-Genehmigung in APPROVED.
deny Ändert in einem Partnerabo den Status einer PENDING-Genehmigung in DENIED.
get Ruft den aktuellen Status eines einzelnen Abos ab.
list Listet alle Abos für eine bestimmte externe Konto-ID auf.