REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

Optional. Nicht veränderbar. Kennung. Ressourcenname des Abos.

Format: subscriptions/{subscription}

string

Nur Ausgabe. Vom System zugewiesene eindeutige Kennung für das Abo.

string

Erforderlich. Nicht veränderbar. Die Google Workspace-Ressource, die auf Ereignisse überwacht wird, formatiert als vollständiger Ressourcenname Weitere Informationen zu Zielressourcen und den von ihnen unterstützten Ereignissen finden Sie unter Unterstützte Google Workspace-Ereignisse.

Ein Nutzer kann Ihre App nur autorisieren, ein Abo für eine bestimmte Zielressource zu erstellen. Wenn Ihre App versucht, ein weiteres Abo mit denselben Nutzeranmeldedaten zu erstellen, gibt die Anfrage den Fehler ALREADY_EXISTS zurück.

string

Erforderlich. Nicht veränderbar. Unsortierte Liste. Eingabe zum Erstellen eines Abos. Andernfalls wird nur die Ausgabe verwendet. Ein oder mehrere Ereignistypen, die über die Zielressource empfangen werden sollen. Formatiert gemäß der CloudEvents-Spezifikation.

Die unterstützten Ereignistypen hängen von der Zielressource Ihres Abos ab. Weitere Informationen finden Sie im Hilfeartikel Unterstützte Google Workspace-Ereignisse.

Standardmäßig erhalten Sie auch Ereignisse zum Lebenszyklus Ihres Abos. Sie müssen für dieses Feld keine Lebenszyklusereignisse angeben.

Wenn Sie einen Ereignistyp angeben, der für die Zielressource nicht vorhanden ist, gibt die Anfrage den HTTP-Statuscode 400 Bad Request zurück.

object (PayloadOptions)

Optional. Optionen für die in die Ereignisnutzlast aufzunehmenden Daten. Wird nur für Google Chat-Termine unterstützt.

object (NotificationEndpoint)

Erforderlich. Nicht veränderbar. Der Endpunkt, an den das Abo Ereignisse liefert, z. B. ein Pub/Sub-Thema.

enum (State)

Nur Ausgabe. Der Status des Abos. Bestimmt, ob das Abo Ereignisse empfangen und an den Benachrichtigungsendpunkt senden kann.

enum (ErrorType)

Nur Ausgabe. Der Fehler, durch den das Abo gesperrt wurde.

Beheben Sie den Fehler und rufen Sie die Methode subscriptions.reactivate auf, um das Abo wieder zu aktivieren.

string

Nur Ausgabe. Der Nutzer, der die Erstellung des Abos autorisiert hat.

Format: users/{user}

Für Google Workspace-Nutzer ist der Wert {user} das Feld user.id aus der Directory API.

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem das Abo erstellt wird.

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem das Abo zuletzt aktualisiert wurde.

boolean

Nur Ausgabe. Wenn true, wird das Abo gerade aktualisiert.

string

Optional. Diese Prüfsumme wird vom Server basierend auf dem Wert anderer Felder berechnet und kann bei Aktualisierungsanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren einen aktuellen Wert hat.

string (Timestamp format)

Standardwert ist nicht leer. Der Zeitstempel in UTC für das Ablaufdatum des Abos. Wird immer in der Ausgabe angezeigt, unabhängig davon, was bei der Eingabe verwendet wurde.

string (Duration format)

Nur Eingabe. Die Gültigkeitsdauer (TTL) oder Dauer des Abos. Wenn nicht angegeben oder auf 0 festgelegt, wird die maximal mögliche Dauer verwendet.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

Optional. Gibt an, ob die Ereignisnutzlast Daten zur geänderten Ressource enthält. Beispiel: Bei einem Ereignis, bei dem eine Google Chat-Nachricht erstellt wurde, ob die Nutzlast Daten zur Ressource Message enthält. Bei „false“ enthält die Ereignisnutzlast nur den Namen der geänderten Ressource.

string (FieldMask format)

Optional. Die Liste der Felder, die in die Ereignisnutzlast einbezogen werden sollen, wenn includeResource auf true gesetzt ist. Trennen Sie einzelne Felder durch Kommas. Wenn Sie beispielsweise den Absender einer Google Chat-Nachricht und den Erstellungszeitpunkt angeben möchten, geben Sie message.sender,message.createTime ein. Wenn keine Angabe gemacht wird, enthält die Nutzlast alle Felder für die Ressource.

Wenn Sie ein Feld angeben, das für die Ressource nicht vorhanden ist, wird das Feld vom System ignoriert.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

Nicht veränderbar. Das Cloud Pub/Sub-Thema, das Ereignisse für das Abo empfängt.

Format: projects/{project}/topics/{topic}

Sie müssen das Thema in demselben Google Cloud-Projekt erstellen, in dem Sie auch dieses Abo erstellt haben.

Wenn das Thema Ereignisse empfängt, werden diese als Cloud Pub/Sub-Nachrichten codiert. Weitere Informationen finden Sie unter Google Cloud Pub/Sub-Protokollbindung für CloudEvents.