Gérer les événements de Google Chat

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

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 les événements pour comprendre ce qui s'est passé et prendre des mesures ou répondre de manière pour vos utilisateurs.

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

  • Surveillez les nouveaux messages d'un espace et répondez-y, par exemple en vérifiant les clés des mots ou des expressions.
  • Envoyer un message de bienvenue aux utilisateurs lorsqu'ils rejoignent l'espace pour leur expliquer l'espace ou partager des conseils sur la façon d'utiliser efficacement les Application Chat
  • Suivez et analysez l'activité Chat. Par exemple, pour envoyer un un rapport mensuel sur les nouveaux membres ou sur les messages réactions ou 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 en quittant 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éées, mises à jour ou supprimées. Chat utilise des événements pour diffuser des informations à votre application Chat sur le type l'activité qui s'est produite et la ressource API Chat affecté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, qui crée une ressource Message. Chat crée ensuite un événement contenant des données sur le nouveau .

Chat classe les événements par type. Les types d'événements vous aident à filtrer et ne reçoivent que le type d'informations dont vous avez besoin et vous permettent de gérer les activités de la même manière.

Le tableau suivant montre comment une activité dans Chat affecte un ressource d'API Chat associée et le type d'événement auquel L'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:

  • S'abonner à des événements à l'aide de l'API Google Workspace Events pour recevoir des événements à mesure qu'ils surviennent.
  • Recherchez des événements récents en appelant l'API Chat.

Le tableau suivant explique la différence et les raisons de l'interrogation s'abonner à des événements:

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.
  • Surveiller les performances l'activité de vos membres et de découvrir de nouveaux espaces surveiller.
  • Traitez des événements ou répondez aux événements, périodiquement ou via un déclencheur.
  • Récupérer les événements manqués d'un abonnement (en raison d'une indisponibilité ou 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 pris en charge, voir Types d'événements pour la création d'abonnements dans la Documentation sur l'API Google Workspace Events.
  • Messages
  • Souscriptions
  • Réactions
  • Espace

Pour obtenir la liste des types d'événements pris en charge, consultez le Ressource spaceEvents dans l'API Chat documentation de référence.
Format des événements Un message Google Cloud Pub/Sub, formaté conformément aux de CloudEvent. 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 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 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 une événement "nouveau membre".
  • Un utilisateur devient gestionnaire de l'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 le 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 l'API Google Workspace Events subscriptions.create() permettant de s'abonner à l'espace pour tous les types d'événements d'adhésion. Après création de l'abonnement, l'application Chat peut commencer à recevoir des événements réservés aux membres.

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

Dans la figure 2, l'application Chat dispose d'un abonnement actif à l'espace, de sorte que l'application reçoit un événement chaque fois qu'une souscription à l'espace des modifications. L'application Chat peut alors traiter ou répondre dans en temps réel, par exemple en publiant un message de bienvenue privé le 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, L'application Chat peut appeler l'API Chat pour répertorier les événements récents de l'espace liés à l'activité des membres.

Application Chat qui interroge des événements à l'aide de API Chat.
Figure 3. A L'application Chat reçoit les événements récents d'adhésion par l'envoi de requêtes pour des événements d'espace à l'aide de l'API Chat.

Dans la figure 3, une application Chat appelle l'API Chat spaces.spaceEvents.list() une fois que toutes les activités d'adhésion ont eu lieu et filtre la requête des événements d'adhésion nouveaux, modifiés et supprimés. L'API Chat renvoie Une liste de ressources spaceEvent représentant chacune des modifications des membres. L'application Chat peut alors traiter ou répondre en fonction des activité récente telle que la publication d'un message hebdomadaire récapitulant les activités d'adhésion à l'espace au cours des 7 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éclenche 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é, modifié ou supprimé indirectement dans un espace via un groupe Google, l'abonnement n'est pas recevoir ces événements d'adhésion. Pour comprendre le fonctionnement des adhésions à Google Groupes, consultez Ajouter un groupe Google à un espace