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

Settings: watch

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

Requête

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

Nom du paramètre	Valeur	Description

Une autorisation est requise pour cette demande. Celle-ci doit inclure au moins l'un des champs d'application suivants:

Champ d'application
`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 selon la structure suivante:

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

Nom de propriété	Valeur	Description
`id`	`string`	UUID ou chaîne unique similaire qui identifie ce canal.
`token`	`string`	Chaîne arbitraire délivrée à l'adresse cible avec chaque notification envoyée sur ce canal. Facultatif.
`type`	`string`	Type de mécanisme de distribution utilisé pour ce canal. Les valeurs valides sont "`web_hook`" (ou "`webhook`"). Ces deux valeurs font référence à un canal dans lequel des requêtes HTTP sont utilisées pour distribuer des messages.
`address`	`string`	Adresse à laquelle les notifications sont envoyées pour ce canal.
`params`	`object`	Paramètres supplémentaires contrôlant le comportement du canal de distribution. Facultatif.
`params.ttl`	`string`	Valeur TTL (Time To Live) en secondes pour le canal de notification. La valeur par défaut est 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é	Valeur	Description
`kind`	`string`	Indique qu'il s'agit d'un canal de notification qui permet de surveiller les modifications apportées à une ressource, à savoir "`api#channel`".
`id`	`string`	UUID ou chaîne unique similaire qui identifie ce canal.
`resourceId`	`string`	ID opaque qui identifie la ressource surveillée sur ce canal. Stable dans les différentes versions de l'API.
`resourceUri`	`string`	Identifiant spécifique à la version de la ressource surveillée.
`token`	`string`	Chaîne arbitraire délivrée à l'adresse cible avec chaque notification envoyée sur ce canal. Facultatif.
`expiration`	`long`	Date et heure d'expiration du canal de notification, exprimées en code temporel Unix, en millisecondes. Facultatif.