Events: watch

Achten Sie auf Änderungen an Ereignisressourcen.

Anfragen

HTTP-Anfrage

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

Parameter

Parametername Wert Beschreibung
Pfadparameter
calendarId string Kalender-ID. Rufen Sie die Methode calendarList.list auf, um Kalender-IDs abzurufen. Wenn Sie auf den Hauptkalender des aktuell angemeldeten Nutzers zugreifen möchten, verwenden Sie das Keyword „primary“.
Optionale Abfrageparameter
eventTypes string Ereignistypen von zu beobachtenden Ressourcen. Optional. Dieser Parameter kann mehrmals wiederholt werden, um Ressourcen unterschiedlicher Typen zu beobachten. Wenn nichts festgelegt ist, werden alle Ereignistypen zurückgegeben.

Zulässige Werte sind:
  • „default“: Regelmäßige Ereignisse.
  • „focusTime“: Fokuszeit-Ereignisse.
  • „outOfOffice“: Außer-Haus-Termine.
  • „workingLocation“: Arbeitsorte.

Autorisierung

Diese Anfrage ermöglicht die Autorisierung mit mindestens einem der folgenden Bereiche:

Bereich
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Geben Sie im Anfragetext Daten mit der folgenden Struktur ein:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
Property-Name Wert Beschreibung Hinweise
id string Eine UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert.
token string Eine beliebige Zeichenfolge, die an die Zieladresse gesendet wird, wobei jede Benachrichtigung über diesen Kanal gesendet wird. Optional.
type string Der für diesen Kanal verwendete Übermittlungsmechanismus. Gültige Werte sind „web_hook“ (oder „webhook“). Beide Werte beziehen sich auf einen Kanal, bei dem HTTP-Anfragen zum Senden von Nachrichten verwendet werden.
address string Die Adresse, an die Benachrichtigungen für diesen Kanal gesendet werden.
params object Zusätzliche Parameter, die das Verhalten des Bereitstellungskanals steuern. Optional.
params.ttl string Die Gültigkeitsdauer des Benachrichtigungskanals in Sekunden. Der Standardwert ist 604.800 Sekunden.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
Name der Eigenschaft Wert Beschreibung Hinweise
kind string Kennzeichnet dies als Benachrichtigungskanal zur Überwachung von Änderungen an einer Ressource (api#channel).
id string Eine UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert.
resourceId string Eine intransparente ID, die die auf diesem Kanal angesehene Ressource identifiziert. Stabil über verschiedene API-Versionen hinweg.
resourceUri string Eine versionsspezifische Kennung für die beobachtete Ressource.
token string Eine beliebige Zeichenfolge, die an die Zieladresse gesendet wird, wobei jede Benachrichtigung über diesen Kanal gesendet wird. Optional.
expiration long Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals als Unix-Zeitstempel in Millisekunden. Optional.