Gérer les événements de Google Chat

Cette page explique comment les applications Google Chat peuvent recevoir des événements dans Google Chat et y répondre.

Un événement Google Chat représente une activité ou une modification dans Chat, comme l'arrivée d'un nouveau message dans un espace. Votre application Chat peut utiliser des événements pour comprendre ce qui s'est passé et prendre des mesures ou répondre de manière significative pour vos utilisateurs.

Voici quelques exemples d'utilisation des événements:

  • Surveillez les nouveaux messages dans un espace et répondez-y, par exemple en recherchant des mots ou des expressions clés.
  • Envoyez un message de bienvenue aux utilisateurs lorsqu'ils rejoignent l'espace pour leur expliquer les consignes ou leur donner des conseils pour utiliser efficacement l'application Chat.
  • Suivez et analysez l'activité Chat. Par exemple, vous pouvez envoyer un rapport mensuel sur les nouveaux membres, ou sur les messages qui obtiennent le plus de réactions ou de réponses.
  • Communiquez entre différentes plates-formes de messagerie. Par exemple, les utilisateurs peuvent envoyer et recevoir des messages d'utilisateurs sur une autre plate-forme de messagerie sans quitter Chat.

Fonctionnement des événements

Chaque fois qu'un événement se produit dans Google Chat, une ressource d'API Google Chat est créée, mise à jour ou supprimée. Chat utilise des événements pour fournir à votre application Chat des informations sur le type d'activité qui s'est produite et la ressource de l'API Chat concernée.

Exemple montrant comment un message publié dans un espace Google Chat déclenche un événement.
Figure 1 : Un utilisateur publie un message dans un espace Chat, ce qui crée une ressource Message. Chat crée ensuite un événement contenant des données sur le nouveau message.

Chat classe les événements par type. Les types d'événements vous permettent de filtrer et de recevoir uniquement le type d'informations dont vous avez besoin, et de gérer des activités similaires de la même manière.

Le tableau suivant montre l'impact d'une activité dans Chat sur une ressource d'API Chat associée, ainsi que le type d'événement que votre application Chat reçoit:

Activité Ressource de l'API Chat Type d'événement
Un utilisateur publie un message dans un espace Chat Une ressource Message est créée. Nouveau message
Un utilisateur devient gestionnaire de l'espace. Une ressource Membership est mise à jour. Abonnement modifié
Un utilisateur réagit à un message. Une ressource Reaction est créée. Nouvelle réaction
Un utilisateur quitte un espace. Une ressource Membership est supprimée. Abonnement supprimé

Recevoir des événements Google Chat

Pour recevoir des événements, votre application Chat peut effectuer l'une des opérations suivantes:

  • Abonnez-vous à des événements à l'aide de l'API Google Workspace Events pour les recevoir à mesure qu'ils se produisent.
  • Recherchez des événements récents en appelant l'API Chat.

Le tableau suivant explique la différence et les raisons d'interroger des événements ou de s'y abonner:

S'abonner à des événements Requête pour des événements
Cas d'utilisation
  • Traitez les événements ou répondez aux événements en temps réel.
  • Surveillez l'activité des membres des utilisateurs et découvrez de nouveaux espaces à surveiller.
  • Traitez des événements ou répondez aux événements, périodiquement ou via un déclencheur.
  • Récupérez les événements manqués d'un abonnement (en raison d'une indisponibilité ou d'un abonnement inactif).
API API Google Workspace Events Chat API
Source des événements Espaces et utilisateurs Espaces uniquement
Événements compatibles
  • Messages
  • Souscriptions
  • Réactions
  • Espace

Pour obtenir la liste des types d'événements compatibles, consultez Types d'événements pour la création d'abonnements dans la documentation de l'API Google Workspace Events.
  • Messages
  • Souscriptions
  • Réactions
  • Espace

Pour obtenir la liste des types d'événements compatibles, consultez la ressource spaceEvents dans la documentation de référence de l'API Chat.
Format des événements Message Google Cloud Pub/Sub, formaté conformément à la spécification CloudEvent. Pour en savoir plus, consultez Structure des événements Google Workspace. Une ressource d'API Chat ( spaces.spaceEvent)
Données d'événement Chaîne encodée en base64 avec ou sans données de ressource. Pour obtenir des exemples de charges utiles, consultez la section Données d'événement. Charge utile JSON contenant des données de ressources. Certains types d'événements n'incluent que certains champs de ressources. Pour obtenir des exemples de charges utiles, consultez la documentation de référence.

Exemple: Envoyer une requête ou s'abonner à des événements sur les membres d'un espace

Dans cet exemple, une application Chat souhaite recevoir des informations sur les modifications apportées aux membres d'un espace Chat. Dans l'espace, l'activité d'adhésion suivante se produit:

  • Un utilisateur rejoint l'espace, ce qui crée une ressource Membership et déclenche un événement de nouveau membre.
  • Un utilisateur devient gestionnaire de l'espace, ce qui met à jour la ressource Membership pour lui et déclenche un événement de membre mis à jour.
  • Un utilisateur quitte l'espace, ce qui supprime la ressource Membership de l'utilisateur et déclenche un événement de suppression de membre.

S'abonner aux événements réservés aux membres

Pour recevoir des événements en temps réel, l'application Chat appelle la méthode subscriptions.create() de l'API Google Workspace Events afin de s'abonner à l'espace pour tous les types d'événements d'adhésion. Une fois l'abonnement créé, l'application Chat peut commencer à recevoir des événements d'appartenance.

Application Chat qui s'abonne aux événements à l'aide de l'API Google Workspace Events.
Figure 2. Une application Chat reçoit des événements d'appartenance via un abonnement utilisant l'API Google Workspace Events.

Dans la figure 2, l'application Chat dispose d'un abonnement actif à l'espace. Elle reçoit donc un événement chaque fois qu'une adhésion à l'espace change. L'application Chat peut alors traiter n'importe quelle activité ou y répondre en temps réel, par exemple en publiant un message de bienvenue privé à l'attention du membre qui a rejoint l'espace.

Pour en savoir plus sur la création d'abonnements à l'aide de l'API Google Workspace Events, consultez la documentation de l'API Google Workspace Events.

Requête pour les événements récents d'adhésion

Au lieu de recevoir les événements d'adhésion en temps réel, une application Chat peut appeler l'API Chat pour répertorier les événements récents liés à l'activité des membres de l'espace.

Application Chat qui interroge des événements à l'aide de l'API Chat
Figure 3. Une application Chat reçoit les événements d'adhésion récents en interrogeant des événements d'espace à l'aide de l'API Chat.

Dans la figure 3, une application Chat appelle la méthode spaces.spaceEvents.list() de l'API Chat une fois que toutes les activités d'adhésion ont eu lieu et filtre la requête pour identifier les événements d'adhésion nouveaux, mis à jour et supprimés. L'API Chat renvoie une liste de ressources spaceEvent qui représentent chacune des modifications apportées aux membres. L'application Chat peut ensuite traiter ou répondre en fonction de l'activité récente, par exemple en publiant un message hebdomadaire récapitulant les activités de membres de l'espace au cours des sept derniers jours.

Pour interroger des événements à l'aide de l'API Chat, consultez Répertorier les événements d'un espace Google Chat.

Limites

  • Pour les abonnements aux utilisateurs, les événements concernant les nouveaux membres dans les messages privés ou les chats de groupe sans nom (google.workspace.chat.membership.v1.created) ne se déclenchent qu'après la publication du premier message.
  • Pour recevoir des événements d'adhésion, l'utilisateur doit être un membre direct de l'espace. Si un utilisateur a été ajouté, mis à jour ou supprimé indirectement à un espace via un groupe Google, l'abonnement ne reçoit pas ces événements d'appartenance. Pour comprendre le fonctionnement des appartenances aux groupes Google, consultez Ajouter un groupe Google à un espace.