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

Une autorisation est nécessaire pour cette requête avec au moins l'un des champs d'application suivants:

Définition du champ d'application
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

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

Corps de la requête

Dans le corps de la requête, fournissez des données présentant 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 identifiant ce canal.
token string Chaîne arbitraire envoyée à l'adresse cible avec chaque notification transmise 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 sur lequel les requêtes HTTP sont utilisées pour transmettre des messages.
address string Adresse à laquelle les notifications sont envoyées pour cette chaîne.
params object Paramètres supplémentaires contrôlant le comportement des canaux de diffusion. Facultatif.
params.ttl string Valeur TTL (Time To Live) du canal de notification, en secondes. La valeur par défaut est 604 800 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 Identifie 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 identifiant ce canal.
resourceId string ID opaque qui identifie la ressource surveillée sur ce canal. Stable dans différentes versions d'API.
resourceUri string Identifiant spécifique à la version pour la ressource surveillée.
token string Chaîne arbitraire envoyée à l'adresse cible avec chaque notification transmise via ce canal. Facultatif.
expiration long Date et heure d'expiration du canal de notification, exprimées en code temporel Unix, en millisecondes. Facultatif.