CalendarList: watch

Surveillez les modifications apportées aux ressources CalendarList.

Requête

Requête HTTP

POST https://www.googleapis.com/calendar/v3/users/me/calendarList/watch

Paramètres

Nom du paramètre Valeur Description

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants:

Portée
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Dans le corps de la requête, indiquez des données en utilisant la structure suivante:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
Nom de propriété Valeur Description Remarques
id string UUID ou chaîne unique similaire permettant d'identifier cette chaîne.
token string Chaîne arbitraire envoyée à l'adresse cible avec chaque notification envoyée via ce canal. Facultatif.
type string Type de mécanisme de diffusion utilisé pour ce canal. Les valeurs valides sont "web_hook" (ou "webhook"). Les deux valeurs font référence à un canal où les requêtes HTTP sont utilisées pour envoyer des messages.
address string Adresse à laquelle les notifications sont envoyées pour ce canal.
params object Paramètres supplémentaires qui contrôlent le comportement du canal de diffusion. Facultatif.
params.ttl string Durée de vie (en secondes) du canal de notification. La valeur par défaut est de 60 4800 secondes.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
Nom de propriété Valeur Description Remarques
kind string Indique qu'il s'agit d'un canal de notification utilisé pour surveiller les modifications apportées à une ressource, qui est "api#channel".
id string UUID ou chaîne unique similaire permettant d'identifier cette chaîne.
resourceId string ID opaque qui identifie la ressource regardée sur cette chaîne. Stable entre les différentes versions de l'API.
resourceUri string Identifiant spécifique à la version de la ressource surveillée.
token string Chaîne arbitraire envoyée à l'adresse cible avec chaque notification envoyée via ce canal. Facultatif.
expiration long Date et heure d'expiration du canal de notification, exprimées en code temporel Unix, en millisecondes. Facultatif.