Änderungen an Einstellungsressourcen beobachten.
Anfrage
HTTP-Anfrage
POST https://www.googleapis.com/calendar/v3/users/me/settings/watch
Parameter
| Parametername | Wert | Beschreibung |
|---|
Autorisierung
Für diese Anfrage ist eine Autorisierung mit mindestens einem der folgenden Bereiche erforderlich:
| Bereich |
|---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.settings.readonly |
https://www.googleapis.com/auth/calendar.settings |
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 |
Eine UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert. | |
token |
string |
Ein beliebiger String, der mit jeder über diesen Kanal zugestellten Benachrichtigung an die Zieladresse gesendet wird. Optional. | |
type |
string |
Der Typ des Übermittlungsmechanismus, der für diesen Kanal verwendet wird. Gültige Werte sind „web_hook“ (oder „webhook“). Beide Werte beziehen sich auf einen Kanal, in 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 Übermittlungskanals 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 |
Identifiziert dies als Benachrichtigungskanal, der verwendet wird, um Änderungen an einer Ressource zu beobachten, die „api#channel“ ist. |
|
id |
string |
Eine UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert. | |
resourceId |
string |
Eine intransparente ID, die die Ressource identifiziert, die in diesem Kanal beobachtet wird. Stabil über verschiedene API-Versionen hinweg. | |
resourceUri |
string |
Eine versionsspezifische Kennung für die überwachte Ressource. | |
token |
string |
Ein beliebiger String, der mit jeder über diesen Kanal zugestellten Benachrichtigung an die Zieladresse gesendet wird. Optional. | |
expiration |
long |
Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals, ausgedrückt als Unix-Zeitstempel in Millisekunden. Optional. |