Surveillez les modifications apportées aux ressources Événements.
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 obtenir les ID d'agenda, appelez la méthode calendarList.list. Pour 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 à surveiller. Facultatif. Ce paramètre peut être répété plusieurs fois pour surveiller différents types de ressources. Si cette règle n'est pas définie, elle renvoie tous les types d'événements.
Les valeurs acceptées sont les suivantes :
|
Autorisation
Cette requête autorise une autorisation avec 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.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, fournissez des données en respectant la structure suivante:
{ "id": string, "token": string, "type": string, "address": string, "params": { "ttl": string } }
Nom de propriété | Valeur | Description | Notes |
---|---|---|---|
id |
string |
UUID ou chaîne unique similaire identifiant ce canal. | |
token |
string |
Chaîne arbitraire transmise à l'adresse cible avec chaque notification transmise sur 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 dans lequel les 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 des canaux 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. |
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 | Notes |
---|---|---|---|
kind |
string |
Identifie ceci comme 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 de l'API. | |
resourceUri |
string |
Identifiant spécifique à la version pour la ressource surveillée. | |
token |
string |
Chaîne arbitraire transmise à l'adresse cible avec chaque notification transmise sur ce canal. Facultatif. | |
expiration |
long |
Date et heure d'expiration du canal de notification, exprimées en horodatage Unix, en millisecondes. Facultatif. |