Surveillez les modifications apportées aux ressources Events.
Requête
Requête HTTP
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
Paramètres
Nom du paramètre | Valeur | Description |
---|---|---|
Paramètres de chemin d'accès | ||
calendarId |
string |
Identifiant de l'agenda. Pour récupérer les ID d'agenda, appelez la méthode calendarList.list. Si vous souhaitez accéder à l'agenda principal de l'utilisateur actuellement connecté, utilisez le mot clé "primary ".
|
Paramètres de requête facultatifs | ||
eventTypes |
string |
Types d'événements de ressources à surveiller. Facultatif. Ce paramètre peut être répété plusieurs fois pour surveiller des ressources de différents types. Si la valeur n'est pas définie, tous les types d'événements sont renvoyés.
Les valeurs possibles sont les suivantes :
|
Autorisation
Cette requête autorise l'autorisation avec au moins l'une des portées suivantes:
Portée |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
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 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 sous la forme d'un code temporel Unix, en millisecondes. Facultatif. |