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 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 pertinente 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 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 sur l'utilisation efficace de l'application Chat.
  • suivre et analyser l'activité Chat. Par exemple, pour envoyer un rapport mensuel sur les nouveaux membres ou sur les messages qui suscitent le plus de réactions ou de réponses.
  • communiquer sur 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 de l'API Google Chat est créée, mise à jour ou supprimée. Chat utilise des événements pour fournir des informations à votre application Chat sur le type d'activité qui s'est produit et sur la ressource de l'API Chat qui a été affectée.

Exemple de la façon dont 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 aident à filtrer les informations et à ne recevoir que celles dont vous avez besoin. Ils vous permettent également de gérer les activités similaires de la même manière.

Le tableau suivant montre comment une activité dans Chat affecte 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 d'un 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 de Google Chat

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

  • Abonnez-vous aux événements à l'aide de l'API Google Workspace Events pour les recevoir dès qu'ils se produisent.
  • Interrogez l'API Chat pour obtenir les événements récents.

Le tableau suivant explique la différence et les raisons pour lesquelles vous pouvez interroger ou vous abonner à des événements :

S'abonner à des événements Requête d'événements
Cas d'utilisation
  • traiter les événements ou y répondre en temps réel ;
  • Surveillez l'activité des membres et découvrez de nouveaux espaces à surveiller.
  • Traitez les événements ou répondez-y périodiquement, ou à l'aide d'un déclencheur.
  • Récupérez les événements manqués d'un abonnement (en raison d'une panne 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 acceptés, 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 acceptés, consultez la ressource spaceEvents dans la documentation de référence de l'API Chat.
Format des événements Message Google Cloud Pub/Sub, mis en forme conformément à la spécification CloudEvents. Pour en savoir plus, consultez Structure des événements Google Workspace. Ressource de l'API Chat ( spaces.spaceEvent)
Données d'événement Chaîne encodée en base64 avec ou sans données de ressources. Pour obtenir des exemples de charges utiles, consultez Données d'événement. Charge utile JSON contenant les 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 : Interroger ou s'abonner à des événements concernant 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, les activités suivantes liées aux membres se produisent :

  • 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 d'un espace, ce qui met à jour la ressource Membership pour l'utilisateur et déclenche un événement de membre mis à jour.
  • Un utilisateur quitte l'espace, ce qui supprime la ressource Membership pour l'utilisateur et déclenche un événement de suppression de membre.

S'abonner aux événements liés aux souscriptions

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

Application Chat qui s'abonne aux événements à l'aide de l'API Google Workspace Events.
Figure 2 : Une application Chat reçoit les événements liés aux membres par le biais d'un abonnement à l'aide de 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 que l'appartenance à l'espace change. L'application Chat peut ensuite traiter ou répondre en temps réel à l'une des activités, par exemple en publiant un message de bienvenue privé au membre qui a rejoint l'espace.

Pour savoir comment créer des abonnements à l'aide de l'API Google Workspace Events, consultez la documentation de l'API Google Workspace Events.

Interroger les événements récents liés aux abonnements

Au lieu de recevoir les événements liés aux membres au fur et à mesure qu'ils se produisent, une application Chat peut appeler l'API Chat pour lister les événements récents liés à l'activité des membres dans un espace.

Application Chat qui interroge les événements à l'aide de l'API Chat.
Figure 3. A L'application Chat reçoit les événements récents liés aux membres en interrogeant les é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 liées aux membres ont eu lieu, et filtre la requête pour les événements d'adhésion nouveaux, mis à jour et supprimés. L'API Chat renvoie une liste de ressources spaceEvent qui représentent chacun des changements d'appartenance. L'application Chat peut ensuite traiter ou répondre en fonction de l'activité récente, par exemple en publiant un message hebdomadaire résumant l'activité des membres de l'espace au cours des sept derniers jours.

Pour interroger des événements à l'aide de l'API Chat, consultez Lister 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 liés aux membres, l'utilisateur doit être un membre à part entière de l'espace. Si un utilisateur a été ajouté, modifié ou supprimé indirectement d'un espace via un groupe Google, l'abonnement ne reçoit pas ces événements liés à l'appartenance. Pour comprendre comment fonctionnent les appartenances aux groupes Google, consultez Ajouter un groupe Google à un espace.