Cette page explique comment les applications Google Chat peuvent recevoir des événements 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 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 :
- Surveiller les nouveaux messages dans un espace et y répondre, par exemple en recherchant des mots clés ou des expressions.
- Envoyez un message de bienvenue aux utilisateurs lorsqu'ils rejoignent l'espace pour leur expliquer les consignes de l'espace 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 les messages qui reçoivent le plus de réactions ou de réponses.
- Communiquez sur différentes plates-formes de messagerie. Par exemple, les utilisateurs peuvent envoyer et recevoir des messages d'utilisateurs d'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 à votre application Chat des informations sur le type d'activité qui s'est produite et sur la ressource de l'API Chat qui a été affectée.
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 et à ne recevoir que le type d'informations dont vous avez besoin, et vous permettent de gérer des activités similaires de la même manière.
Le tableau suivant montre comment une activité dans Chat affecte une ressource de l'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 mis à jour |
| 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 recevoir les événements au fur et à mesure qu'ils se produisent.
- Interrogez les événements récents en appelant l'API Chat.
Le tableau suivant explique la différence et les raisons d'interroger ou de s'abonner à des événements :
| S'abonner à des événements | Requête d'événements | |
|---|---|---|
| Cas d'utilisation |
|
|
| API | API Google Workspace Events | Chat API |
| Source des événements | Espaces, utilisateurs et organisations Google Workspace ( Preview développeur) | Espaces uniquement |
| Événements compatibles |
Pour obtenir la liste des types d'événements acceptés, consultez Types d'événements pour créer des abonnements dans la documentation de l'API Google Workspace Events. |
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 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 Données d'événement. | Charge utile JSON contenant les données de la ressource. 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 adhésions dans 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
Membershipet déclenche un événement de nouveau membre. - Un utilisateur devient gestionnaire d'espace, ce qui met à jour la ressource
Membershippour l'utilisateur et déclenche un événement de membre mis à jour. - Un utilisateur quitte l'espace, ce qui supprime la ressource
Membershipde l'utilisateur et déclenche un événement de suppression de membre.
S'abonner aux événements d'adhésion
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 d'appartenance. Une fois l'abonnement créé, l'application Chat peut commencer à recevoir des événements d'appartenance.
Dans la figure 2, l'application Chat dispose d'un abonnement actif à l'espace. Elle reçoit donc un événement chaque fois qu'un membre de 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é pour le 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.
Requête pour les événements d'adhésion récents
Au lieu de recevoir les événements d'appartenance au fur et à mesure qu'ils se produisent, une application Chat peut appeler l'API Chat pour lister les événements d'espace récents liés à l'activité d'appartenance.
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'appartenance ont eu lieu, et filtre la requête pour les événements d'appartenance nouveaux, mis à jour et supprimés. L'API Chat renvoie une liste de ressources spaceEvent qui représentent chacune des modifications d'appartenance.
L'application Chat peut ensuite traiter l'activité récente ou y répondre, 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 et comportements de diffusion
Limites générales
- Pour recevoir des événements d'appartenance, l'utilisateur ou l'application Chat doit être un membre direct de l'espace. S'ils ont été ajoutés, mis à jour ou supprimés indirectement d'un espace via un groupe Google, l'abonnement ne reçoit pas ces événements d'appartenance. Pour comprendre le fonctionnement des appartenances à un groupe Google, consultez Ajouter un groupe Google à un espace.
Abonnements utilisateur
-
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.
Abonnements client
Les limites suivantes s'appliquent aux abonnements client :
- L'organisation Google Workspace doit disposer d'au moins une licence Enterprise.
- Une application Chat ne peut créer qu'un seul abonnement client pour une organisation Google Workspace donnée. Une organisation Google Workspace peut avoir jusqu'à cinq abonnements client au total (créés par différentes applications Chat).
Pour les abonnements client, la diffusion des événements suit les règles générales suivantes :
- Événements d'espace : envoyés uniquement si l'événement se produit dans un espace géré par votre organisation Google Workspace.
- Événements utilisateur : ne sont envoyés que si l'événement se produit pour un utilisateur appartenant à votre organisation Google Workspace.
La seule exception à ces règles concerne les événements de souscription. Votre abonnement peut recevoir des événements d'appartenance provenant d'espaces gérés par votre organisation et d'espaces gérés par des organisations externes. Toutefois, la manière dont ils sont diffusés dépend de l'organisation qui gère l'espace :
Espaces gérés par votre organisation Google Workspace
Si un changement d'adhésion se produit dans un espace géré par l'organisation Google Workspace, il est diffusé en tant qu'événement d'espace.
Le nom de ressource d'un événement d'espace utilise le format suivant :
spaces/{spaceId}/spaceEvents/{spaceEventId}
Espaces gérés par des organisations externes
Si l'appartenance d'un utilisateur géré par votre organisation Google Workspace change dans un espace géré par une organisation externe (par exemple, un espace nommé externe ou un message privé créé par un utilisateur externe), votre abonnement reçoit cet événement en tant qu'événement utilisateur.
Le nom de ressource d'un événement utilisateur utilise le format suivant :
users/{userId}/userEvents/{userEventId}