Events: watch

Behalten Sie Änderungen an den Ressourcen für Google Kalender im Auge.

Anfrage

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 primären Kalender des aktuell angemeldeten Nutzers zugreifen möchten, verwenden Sie das Keyword „primary“.
Optionale Abfrageparameter
eventTypes string Ereignistypen der zu beobachtenden Ressourcen. Optional. Dieser Parameter kann mehrmals wiederholt werden, um Ressourcen verschiedener Typen zu beobachten. Wenn nicht festgelegt, werden alle Ereignistypen zurückgegeben.

Zulässige Werte sind:
  • "birthday": Ganztägige spezielle Veranstaltungen, die jährlich stattfinden.
  • „default“: Regelmäßig stattfindende Ereignisse.
  • „focusTime“: Fokuszeittermine.
  • „fromGmail“: Termine aus Gmail
  • „outOfOffice“: Außer-Haus-Termine.
  • „workingLocation“: Ereignisse für den Arbeitsort

Autorisierung

Diese Anfrage lässt eine Autorisierung mit mindestens einem der folgenden Bereiche zu:

Umfang
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
  }
}
Name der Eigenschaft Wert Beschreibung Hinweise
id string Ein UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert.
token string Ein beliebiger String, der mit jeder Benachrichtigung über diesen Kanal an die Zieladresse 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 Channel, bei dem Nachrichten per HTTP-Anfrage gesendet werden.
address string Die Adresse, an die Benachrichtigungen für diesen Kanal gesendet werden.
params object Zusätzliche Parameter, die das Verhalten des Übermittlungskanals steuern. Optional.
params.ttl string Die Gültigkeitsdauer in Sekunden für den Benachrichtigungskanal. 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 Gibt an, dass es sich hierbei um einen Benachrichtigungskanal handelt, der zum Überwachen von Änderungen an einer Ressource verwendet wird (api#channel).
id string Ein UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert.
resourceId string Eine intransparente ID, die die Ressource identifiziert, die auf diesem Kanal angesehen wird. Sie sind für verschiedene API-Versionen stabil.
resourceUri string Eine versionsspezifische Kennung für die überwachte Ressource.
token string Ein beliebiger String, der mit jeder Benachrichtigung über diesen Kanal an die Zieladresse gesendet wird. Optional.
expiration long Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals als Unix-Zeitstempel in Millisekunden. Optional.