Notifications push

Ce document explique comment utiliser les notifications push qui informent votre application lorsqu'une ressource change.

Présentation

L'API Google Agenda fournit des notifications push qui vous permettent de surveiller les modifications apportées aux ressources. Vous pouvez utiliser cette fonctionnalité pour améliorer les performances de votre application. Il vous permet d'éliminer les coûts de réseau et de calcul supplémentaires liés à l'interrogation des ressources pour déterminer si elles ont changé. Chaque fois qu'une ressource observée change, l'API Google Calendar envoie une notification à votre application.

Pour utiliser les notifications push, vous devez effectuer deux opérations :

  • Configurez votre URL de réception ou votre récepteur de rappel "webhook".

    Il s'agit d'un serveur HTTPS qui gère les messages de notification de l'API déclenchés lorsqu'une ressource change.

  • Configurez un canal de notification pour chaque point de terminaison de ressource que vous souhaitez surveiller.

    Un canal spécifie les informations de routage pour les messages de notification. Lors de la configuration du canal, vous devez identifier l'URL spécifique à laquelle vous souhaitez recevoir les notifications. Chaque fois que la ressource d'un canal change, l'API Google Calendar envoie un message de notification sous la forme d'une requête POST à cette URL.

Actuellement, l'API Google Agenda est compatible avec les notifications de modification des ressources Acl, CalendarList, Events et Settings.

Créer des canaux de notification

Pour demander des notifications push, vous devez configurer un canal de notification pour chaque ressource que vous souhaitez surveiller. Une fois vos canaux de notification configurés, l'API Google Agenda informe votre application lorsque des ressources observées sont modifiées.

Envoyer des requêtes à la montre

Chaque ressource de l'API Google Agenda pouvant être observée est associée à une méthode watch à un URI du format suivant :

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

Pour configurer un canal de notification pour les messages concernant les modifications apportées à une ressource spécifique, envoyez une requête POST à la méthode watch pour la ressource.

Chaque canal de notification est associé à un utilisateur et à une ressource (ou un ensemble de ressources) spécifiques. Une requête watch ne sera pas traitée, sauf si l'utilisateur actuel possède cette ressource ou est autorisé à y accéder.

Exemple

Commencez à surveiller les modifications apportées à une collection d'événements dans un agenda donné :

POST https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events/watch
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab",
  "type": "web_hook",
  "address": "https://mydomain.com/notifications",
  ...
  "token": "target=myApp-myCalendarChannelDest",
  "expiration": 1426325213000
}

Dans le corps de la requête, indiquez le id de votre chaîne, le type comme web_hook et votre URL de réception dans address. Vous pouvez également fournir les informations facultatives suivantes :

  • Un token à utiliser comme jeton de chaîne.
  • expiration en millisecondes pour le délai d'expiration de la chaîne que vous avez demandé.

Propriétés obligatoires

Pour chaque requête watch, vous devez fournir les champs suivants :

  • Chaîne de propriété id qui identifie de manière unique ce nouveau canal de notification dans votre projet. Nous vous recommandons d'utiliser un identifiant unique universel (UUID) ou toute chaîne unique similaire. Longueur maximale : 64 caractères.

    La valeur d'ID que vous définissez est renvoyée dans l'en-tête HTTP X-Goog-Channel-Id de chaque message de notification que vous recevez pour ce canal.

  • Chaîne de propriété type définie sur la valeur web_hook.

  • Chaîne de propriété address définie sur l'URL qui écoute et répond aux notifications pour ce canal de notification. Il s'agit de l'URL de rappel de votre webhook, qui doit utiliser HTTPS.

    Notez que l'API Google Agenda ne peut envoyer de notifications à cette adresse HTTPS que si un certificat SSL valide est installé sur votre serveur Web. Les certificats non valides sont :

    • les certificats auto-signés ;
    • Certificats signés par une source non fiable
    • Certificats révoqués
    • Certificats dont l'objet ne correspond pas au nom d'hôte cible.

Propriétés facultatives

Vous pouvez également spécifier ces champs facultatifs avec votre requête watch :

  • Propriété token qui spécifie une valeur de chaîne arbitraire à utiliser comme jeton de canal. Vous pouvez utiliser les jetons de canal de notification à différentes fins. Par exemple, vous pouvez utiliser le jeton pour vérifier que chaque message entrant est destiné à un canal créé par votre application (pour vous assurer que la notification n'est pas usurpée) ou pour acheminer le message vers la bonne destination dans votre application en fonction de l'objectif de ce canal. Longueur maximale : 256 caractères.

    Le jeton est inclus dans l'en-tête HTTP X-Goog-Channel-Token de chaque message de notification que votre application reçoit pour ce canal.

    Si vous utilisez des jetons de canal de notification, nous vous recommandons de :

    • Utilisez un format d'encodage extensible, tel que les paramètres de requête d'URL. Exemple : forwardTo=hr&createdBy=mobile

    • N'incluez pas de données sensibles, comme des jetons OAuth.

  • Chaîne de propriété expiration définie sur un timestamp Unix (en millisecondes) de la date et de l'heure auxquelles vous souhaitez que l'API Google Agenda cesse d'envoyer des messages pour ce canal de notification.

    Si un canal a une heure d'expiration, elle est incluse en tant que valeur de l'en-tête HTTP X-Goog-Channel-Expiration (au format lisible par l'homme) dans chaque message de notification que votre application reçoit pour ce canal.

Pour en savoir plus sur la requête, consultez la méthode watch pour les ressources Acl, CalendarList, Events et Settings dans la documentation de référence de l'API.

Regarder la réponse

Si la requête watch crée un canal de notification, elle renvoie un code d'état HTTP 200 OK.

Le corps du message de la réponse de la montre fournit des informations sur le canal de notification que vous venez de créer, comme illustré dans l'exemple ci-dessous.

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events",
  "token": "target=myApp-myCalendarChannelDest",
  "expiration": 1426325213000
}

Le corps de la réponse fournit des informations sur la chaîne, telles que :

  • kind : identifie cette ressource comme une ressource de canal d'API.
  • id : ID que vous avez spécifié pour ce canal.
  • resourceId : ID de la ressource observée.
  • resourceUri : ID spécifique à la version de la ressource observée.
  • token : jeton fourni dans le corps de la requête.
  • expiration : délai d'expiration du canal sous forme d'horodatage Unix en millisecondes.

En plus des propriétés que vous avez envoyées dans votre requête, les informations renvoyées incluent également resourceId et resourceUri pour identifier la ressource surveillée sur ce canal de notification.

Vous pouvez transmettre les informations renvoyées à d'autres opérations de canal de notification, par exemple lorsque vous souhaitez cesser de recevoir des notifications.

Pour en savoir plus sur la réponse, consultez la méthode watch pour les ressources Acl, CalendarList, Events et Settings dans la documentation de référence de l'API.

Message de synchronisation

Après avoir créé un canal de notification pour surveiller une ressource, l'API Google Agenda envoie un message sync pour indiquer que les notifications commencent. La valeur de l'en-tête HTTP X-Goog-Resource-State pour ces messages est sync. En raison de problèmes de synchronisation du réseau, il est possible de recevoir le message sync avant même de recevoir la réponse de la méthode watch.

Vous pouvez ignorer la notification sync sans problème, mais vous pouvez aussi l'utiliser. Par exemple, si vous décidez de ne pas conserver le canal, vous pouvez utiliser les valeurs X-Goog-Channel-ID et X-Goog-Resource-ID dans un appel à arrêter de recevoir des notifications. Vous pouvez également utiliser la notification sync pour effectuer une initialisation en vue d'événements ultérieurs.

Le format des messages sync que l'API Google Agenda envoie à votre URL de réception est indiqué ci-dessous.

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

Les messages de synchronisation ont toujours une valeur d'en-tête HTTP X-Goog-Message-Number de 1. Chaque notification ultérieure pour ce canal comporte un numéro de message supérieur au précédent, mais les numéros de message ne sont pas séquentiels.

Renouveler les canaux de notification

Un canal de notification peut avoir une durée d'expiration, avec une valeur déterminée soit par votre demande, soit par les limites ou les valeurs par défaut internes de l'API Google Calendar (la valeur la plus restrictive est utilisée). Le cas échéant, l'heure d'expiration de la chaîne est incluse sous la forme d'un code temporel Unix (en millisecondes) dans les informations renvoyées par la méthode watch. De plus, la date et l'heure d'expiration (au format lisible par l'humain) sont incluses dans chaque message de notification que votre application reçoit pour ce canal dans l'en-tête HTTP X-Goog-Channel-Expiration.

Il n'existe actuellement aucun moyen automatique de renouveler un canal de notification. Lorsqu'un canal est sur le point d'expirer, vous devez le remplacer par un nouveau en appelant la méthode watch. Comme toujours, vous devez utiliser une valeur unique pour la propriété id du nouveau canal. Notez qu'il y aura probablement une période de "chevauchement" pendant laquelle les deux canaux de notification pour la même ressource seront actifs.

Recevoir des notifications

Chaque fois qu'une ressource observée change, votre application reçoit un message de notification décrivant la modification. L'API Google Agenda envoie ces messages en tant que requêtes HTTPS POST à l'URL que vous avez spécifiée comme propriété address pour ce canal de notification.

Interpréter le format des messages de notification

Tous les messages de notification incluent un ensemble d'en-têtes HTTP avec des préfixes X-Goog-. Certains types de notifications peuvent également inclure un corps de message.

En-têtes

Les messages de notification publiés par l'API Google Agenda sur votre URL de réception incluent les en-têtes HTTP suivants :

En-tête Description
Toujours présent
X-Goog-Channel-ID UUID ou autre chaîne unique que vous avez fournie pour identifier ce canal de notification.
X-Goog-Message-Number Nombre entier qui identifie ce message pour ce canal de notification. La valeur est toujours 1 pour les messages sync. Les numéros de message augmentent pour chaque message suivant sur le canal, mais ils ne sont pas séquentiels.
X-Goog-Resource-ID Valeur opaque identifiant la ressource surveillée. Cet ID est stable dans toutes les versions de l'API.
X-Goog-Resource-State Le nouvel état de la ressource qui a déclenché la notification. Valeurs possibles : sync, exists ou not_exists.
X-Goog-Resource-URI Identifiant spécifique à la version de l'API pour la ressource surveillée.
Parfois présent
X-Goog-Channel-Expiration Date et heure d'expiration du canal de notification, exprimées dans un format lisible par l'humain. N'est présent que s'il est défini.
X-Goog-Channel-Token Jeton de canal de notification défini par votre application et que vous pouvez utiliser pour vérifier la source de la notification. N'est présent que s'il est défini.

Les messages de notification publiés par l'API Google Agenda sur votre URL de réception n'incluent pas de corps de message. Ces messages ne contiennent pas d'informations spécifiques sur les ressources mises à jour. Vous devrez effectuer un autre appel d'API pour afficher tous les détails des modifications.

Exemples

Message de notification de modification d'une collection d'événements :

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: 4ba78bf0-6a47-11e2-bcfd-0800200c9a66
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events
X-Goog-Resource-State:  exists
X-Goog-Message-Number: 10

Répondre à des notifications

Pour indiquer la réussite, vous pouvez renvoyer l'un des codes d'état suivants : 200, 201, 202, 204 ou 102.

Si votre service utilise la bibliothèque cliente des API Google et renvoie 500, 502, 503 ou 504, l'API Google Agenda effectue une nouvelle tentative avec backoff exponentiel. Tout autre code d'état de retour est considéré comme un échec de message.

Comprendre les événements de notification de l'API Google Agenda

Cette section fournit des informations sur les messages de notification que vous pouvez recevoir lorsque vous utilisez les notifications push avec l'API Google Calendar.

X-Goog-Resource-State Applicable à Livré lorsque
sync LCA, listes d'agendas, événements, paramètres. Une chaîne a bien été créée. Vous devriez commencer à recevoir des notifications à ce sujet.
exists LCA, listes d'agendas, événements, paramètres. Une ressource a été modifiée. Les modifications possibles incluent la création d'une ressource, ou la modification ou la suppression d'une ressource existante.

Arrêter les notifications

La propriété expiration contrôle le moment où les notifications s'arrêtent automatiquement. Vous pouvez choisir de ne plus recevoir de notifications pour un canal spécifique avant son expiration en appelant la méthode stop à l'URI suivant :

https://www.googleapis.com/calendar/v3/channels/stop

Cette méthode exige que vous fournissiez au moins les propriétés id et resourceId du canal, comme indiqué dans l'exemple ci-dessous. Notez que si l'API Google Agenda comporte plusieurs types de ressources avec des méthodes watch, il n'existe qu'une seule méthode stop.

Seuls les utilisateurs disposant des autorisations appropriées peuvent arrêter un canal. En particulier :

  • Si la chaîne a été créée par un compte utilisateur standard, seul le même utilisateur du même client (identifié par les ID client OAuth 2.0 des jetons d'authentification) qui a créé la chaîne peut l'arrêter.
  • Si le canal a été créé par un compte de service, tout utilisateur du même client peut l'arrêter.

L'exemple de code suivant montre comment arrêter de recevoir des notifications :

POST https://www.googleapis.com/calendar/v3/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}