Ressource: Abo
JSON-Darstellung |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Felder | |
---|---|
name |
Optional. Nicht veränderbar. ID. Ressourcenname des Abos. Format: |
uid |
Nur Ausgabe Vom System zugewiesene eindeutige Kennung für das Abo. |
targetResource |
Erforderlich. Nicht veränderbar. Die auf Ereignisse überwachte Google Workspace-Ressource im Format 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 deine App versucht, ein weiteres Abo mit denselben Nutzeranmeldedaten zu erstellen, gibt die Anfrage den Fehler |
eventTypes[] |
Erforderlich. Nicht veränderbar. Unsortierte Liste. Eingabe zum Erstellen eines Abos. Ansonsten nur Ausgabe. Mindestens ein Ereignistyp, der zur Zielressource empfangen werden soll. Gemäß der CloudEvents-Spezifikation formatiert Die unterstützten Ereignistypen hängen von der Zielressource Ihres Abos ab. Weitere Informationen finden Sie unter 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 |
payloadOptions |
Optional. Optionen dazu, welche Daten in die Ereignisnutzlast aufgenommen werden sollen. Wird nur für Google Chat-Ereignisse unterstützt. |
notificationEndpoint |
Erforderlich. Nicht veränderbar. Der Endpunkt, an dem das Abo Ereignisse sendet, z. B. ein Pub/Sub-Thema. |
state |
Nur Ausgabe Der Status des Abos. Bestimmt, ob das Abo Ereignisse empfangen und an den Benachrichtigungsendpunkt senden kann. |
suspensionReason |
Nur Ausgabe Der Fehler, durch den das Abo gesperrt wurde. Beheben Sie den Fehler und rufen Sie die Methode |
authority |
Nur Ausgabe Der Nutzer, der die Erstellung des Abos autorisiert hat. Format: Für Google Workspace-Nutzer ist der Wert |
createTime |
Nur Ausgabe Der Zeitpunkt, zu dem das Abo erstellt wird. |
updateTime |
Nur Ausgabe Der Zeitpunkt der letzten Aboaktualisierung. |
reconciling |
Nur Ausgabe Wenn |
etag |
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 über einen aktuellen Wert verfügt. |
Union-Feld Die maximale Ablaufzeit hängt davon ab, ob Ihr Abo Ressourcendaten in Ereignisnutzlasten enthält, die im Feld
Wenn ein Abo abläuft, wird es automatisch gelöscht. Sie erhalten 12 Stunden und eine Stunde vor Ablauf des Abos Lebenszyklusereignisse an Wenn Sie verhindern möchten, dass ein Abo abläuft, können Sie das Ablaufdatum mit der Methode |
|
expireTime |
Das Feld für den Standardwert ist nicht leer. Der Zeitstempel in UTC für den Ablauf des Abos. Wird bei der Ausgabe immer angezeigt, unabhängig davon, was bei der Eingabe verwendet wurde. |
ttl |
Nur Eingabe. Die Gültigkeitsdauer (TTL) oder Dauer des Abos. Wenn kein Wert angegeben oder auf |
PayloadOptions
Optionen dazu, welche Daten in die Ereignisnutzlast aufgenommen werden sollen. Wird nur für Google Chat-Ereignisse unterstützt.
JSON-Darstellung |
---|
{ "includeResource": boolean, "fieldMask": string } |
Felder | |
---|---|
includeResource |
Optional. Gibt an, ob die Ereignisnutzlast Daten über die geänderte Ressource enthält. Gibt an, ob die Nutzlast bei einem Ereignis, bei dem eine Google Chat-Nachricht erstellt wurde, beispielsweise Daten zur Ressource |
fieldMask |
Optional. Liste der Felder, die in die Ereignisnutzlast aufgenommen werden sollen, wenn Wenn Sie ein Feld angeben, das für die Ressource nicht vorhanden ist, wird das Feld vom System ignoriert. |
NotificationEndpoint
Der Endpunkt, an den das Abo Ereignisse sendet.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
pubsubTopic |
Nicht veränderbar. Das Cloud Pub/Sub-Thema, das Ereignisse für das Abo empfängt. Format: Sie müssen das Thema in dem Google Cloud-Projekt erstellen, in dem Sie auch dieses Abo erstellen. 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. |
Status
Mögliche Status für das Abo.
Enums | |
---|---|
STATE_UNSPECIFIED |
Standardwert Dieser Wert wird nicht verwendet. |
ACTIVE |
Das Abo ist aktiv und kann Ereignisse empfangen und an den Benachrichtigungsendpunkt senden. |
SUSPENDED |
Das Abo kann aufgrund eines Fehlers keine Termine empfangen. Informationen zum Ermitteln des Fehlers finden Sie im Feld . |
DELETED |
Das Abo wurde gelöscht. |
ErrorType
Mögliche Fehler für ein Abo.
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Standardwert Dieser Wert wird nicht verwendet. |
USER_SCOPE_REVOKED |
Der autorisierende Nutzer hat die Erteilung eines oder mehrerer OAuth-Bereiche widerrufen. Weitere Informationen zur Autorisierung für Google Workspace finden Sie unter OAuth-Zustimmungsbildschirm konfigurieren. |
RESOURCE_DELETED |
Die Zielressource für das Abo ist nicht mehr vorhanden. |
USER_AUTHORIZATION_FAILURE |
Der Nutzer, der die Erstellung des Abos autorisiert hat, hat keinen Zugriff mehr auf die Zielressource des Abos. |
ENDPOINT_PERMISSION_DENIED |
Die Google Workspace App hat keinen Zugriff, um Ereignisse an den Benachrichtigungsendpunkt deines Abos zu senden. |
ENDPOINT_NOT_FOUND |
Der Benachrichtigungsendpunkt des Abos ist nicht vorhanden oder er wurde nicht in dem Google Cloud-Projekt gefunden, in dem Sie das Abo erstellt haben. |
ENDPOINT_RESOURCE_EXHAUSTED |
Der Benachrichtigungsendpunkt des Abos konnte keine Ereignisse empfangen, weil das Kontingent unzureichend ist oder die Ratenbegrenzung erreicht wurde. |
OTHER |
Ein unbekannter Fehler ist aufgetreten. |
Methoden |
|
---|---|
|
Erstellt ein Google Workspace-Abo. |
|
Löscht ein Google Workspace-Abo. |
|
Ruft Details zu einem Google Workspace-Abo ab. |
|
Listet Google Workspace-Abos auf. |
|
Aktualisiert oder verlängert ein Google Workspace-Abo. |
|
Reaktiviert ein gesperrtes Google Workspace-Abo. |