Cette page a été traduite par l'API Cloud Translation.

Settings: watch

Surveillez les modifications apportées aux ressources des paramètres.

Demande

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

Nom du paramètre	Value	Description

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.settings.readonly`

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

Dans le corps de la requête, fournissez les données avec la structure suivante:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}

Nom de propriété	Value	Description
`id`	`string`	UUID ou chaîne similaire unique qui identifie ce canal.
`token`	`string`	Chaîne arbitraire fournie à l'adresse cible avec chaque notification diffusée sur ce canal. Facultatif.
`type`	`string`	Type de mécanisme de diffusion utilisé pour ce canal. Les valeurs valides sont "`web_hook`" (ou "`webhook`"). Ces deux valeurs font référence à un canal où des requêtes HTTP sont utilisées pour distribuer 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 du canal de diffusion. Facultatif.
`params.ttl`	`string`	Valeur TTL (Time To Live) en secondes du canal de notification. La valeur par défaut est de 604 800 secondes.

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é	Value	Description
`kind`	`string`	Identifie un canal de notification permettant de surveiller les modifications apportées à une ressource, "`api#channel`".
`id`	`string`	UUID ou chaîne similaire unique qui identifie ce canal.
`resourceId`	`string`	ID opaque qui identifie la ressource surveillée sur cette chaîne. Stabilité 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 fournie à l'adresse cible avec chaque notification diffusée sur ce canal. Facultatif.
`expiration`	`long`	Date et heure d'expiration du canal de notification, exprimées en millisecondes, Facultatif.