Cette page décrit les événements Chat auxquels une application Chat peut s'abonner à l'aide de l'API Google Workspace Events. Une fois que vous avez déterminé les types d'événements dont vous avez besoin, créez un abonnement pour commencer à recevoir des événements de Chat.
En plus de vous abonner à des événements, vous pouvez également les interroger en appelant l'API Google Chat. L'appel de l'API Chat vous permet de récupérer des événements de manière périodique ou de rattraper les événements que vous avez peut-être manqués d'un abonnement en raison d'une panne. Pour découvrir comment recevoir des événements Chat et y répondre, consultez Utiliser les événements de Chat dans la documentation Chat.
Événements Chat compatibles
Les abonnements Google Workspace vous permettent de recevoir des événements concernant les types de modifications suivants dans Chat :
- Messages ajoutés, modifiés ou supprimés dans l'espace.
- Nouvelles réactions ou réactions supprimées sur un message
- Ajout, modification ou suppression de membres dans l'espace
- Modifications apportées à l'espace auquel vous êtes abonné, comme la mise à jour du nom ou de la description de l'espace.
- Modifications de la disponibilité de l'utilisateur.
- Modifications apportées à l'état spaceReadState ou threadReadState de l'utilisateur.
Ressources dont vous pouvez surveiller les événements
Pour recevoir des événements, vous devez spécifier une ressource Chat à surveiller, appelée ressource cible de l'abonnement.
L'API Google Workspace Events est compatible avec les ressources cibles suivantes pour Chat :
| Ressource cible | Format | Limites |
|---|---|---|
| Espace |
où SPACE est l'ID dans le
nom de ressource de la ressource |
L'utilisateur Chat ou l'application Chat qui autorise l'abonnement doit être membre de l'espace via son compte Google Workspace ou son compte Google. Formats acceptés : |
| Tous les espaces d'un utilisateur |
|
L'abonnement ne reçoit que les événements des espaces dont l'utilisateur est membre via son compte Google Workspace ou son compte Google. Seule l'authentification des utilisateurs est acceptée. |
| Utilisateur |
où USER est l'ID dans le
nom de ressource de la ressource |
L'abonnement ne reçoit que les événements concernant l'utilisateur qui l'a autorisé. Un utilisateur ne peut pas autoriser un abonnement pour le compte d'autres utilisateurs. Seule l'authentification des utilisateurs est acceptée. |
| Client |
où CUSTOMER est l'ID client. Vous pouvez également utiliser l'alias |
L'abonnement reçoit des événements pour tous les espaces et utilisateurs gérés par le domaine du client. Seule l'authentification des applications avec l'approbation de l'administrateur est acceptée. |
Types d'événements pour la création d'abonnements
Lorsque vous créez un abonnement, utilisez le champ eventTypes[] pour spécifier les types d'événements que vous souhaitez recevoir. Les types d'événements sont formatés conformément à la spécification CloudEvents, par exemple google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.
Par exemple, pour recevoir des événements concernant les utilisateurs qui rejoignent un espace Chat, spécifiez l'espace comme ressource cible et le type d'événement comme google.workspace.chat.membership.v1.created. Pour recevoir des événements concernant un utilisateur donné rejoignant un espace, spécifiez l'utilisateur comme ressource cible et le type d'événement comme google.workspace.chat.membership.v1.created. Pour en savoir plus sur le fonctionnement des événements, consultez Structure des événements Google Workspace.
Le tableau suivant indique les types d'événements compatibles avec les abonnements aux espaces et aux utilisateurs. Pour en savoir plus sur les exceptions concernant les déclencheurs d'événements, consultez Limites.
| Type d'événement | Format | Données de ressources | ||
|---|---|---|---|---|
| Abonnements à des espaces | ||||
| Un message est publié. |
|
|
||
| Un message est modifié. |
|
|
||
| Un message est supprimé. |
|
|
||
| Une réaction est créée. |
|
|
||
| Une réaction est supprimée. |
|
|
||
| Un membre est ajouté à l'espace. |
|
|
||
| Un membre est modifié dans l'espace. |
|
|
||
| Un membre est supprimé de l'espace. |
|
|
||
| L'espace est mis à jour. |
|
|
||
| L'espace est supprimé. |
|
|
||
| Abonnements aux utilisateurs | ||||
| L'utilisateur devient membre d'un espace.
Tous les nouveaux membres ne déclenchent pas d'événements. Pour en savoir plus, consultez Limites. |
|
|
||
| L'appartenance de l'utilisateur à un espace est mise à jour. |
|
|
||
| L'utilisateur est supprimé en tant que membre direct d'un espace. |
|
|
||
| L'état de lecture de l'espace de l'utilisateur est mis à jour. |
|
|
||
| L'état de lecture du fil de discussion de l'utilisateur est mis à jour. |
|
|
||
| Abonnements aux clients | ||||
| Un événement se produit dans un espace, un message, une réaction, une adhésion ou l'état de lecture d'un utilisateur au sein de votre organisation Google Workspace. |
Compatible avec tous les types d'événements listés pour les abonnements aux espaces et aux utilisateurs. |
Dépend du type d'événement (par exemple, |
||
Types d'événements par lots (sortie uniquement)
En plus de recevoir les types d'événements auxquels vous vous abonnez, votre application Chat peut également recevoir des événements par lot. Un événement par lot est un événement qui représente de nombreux événements du même type qui se produisent sur une courte période. La charge utile d'un événement par lot contient la liste de toutes les ressources modifiées.
Par exemple, si un utilisateur ajoute 20 utilisateurs à un espace en même temps, votre application Chat peut recevoir un événement par lot (google.workspace.chat.membership.v1.batchCreated). La charge utile de l'événement contient une liste de toutes les nouvelles ressources Membership créées lorsque l'utilisateur a ajouté les membres à l'espace.
Vous recevez un événement par lot pour tout type d'événement auquel vous vous abonnez. Vous n'avez donc pas besoin de spécifier d'événements par lot lorsque vous créez un abonnement. Par exemple, si vous vous abonnez à de nouvelles réactions (google.workspace.chat.reaction.v1.created), votre application Chat est automatiquement configurée pour recevoir des événements de réaction par lot (google.workspace.chat.reaction.v1.batchCreated).
Le tableau suivant présente les événements de lot possibles pour un abonnement :
| Type d'événement par lot | Format |
|---|---|
| Plusieurs messages sont publiés. |
|
| Plusieurs messages sont mis à jour. |
|
| Plusieurs messages sont supprimés. |
|
| Plusieurs réactions sont créées. |
|
| Plusieurs réactions ont été supprimées. |
|
| Plusieurs membres sont ajoutés à l'espace auquel l'utilisateur est abonné, ou l'utilisateur abonné a été ajouté à plusieurs espaces. |
|
| Plusieurs adhésions sont mises à jour dans l'espace abonné ou pour l'utilisateur abonné. |
|
| Plusieurs membres sont supprimés de l'espace auquel l'utilisateur est abonné, ou l'utilisateur abonné a été supprimé de plusieurs espaces. |
|
| L'espace comporte plusieurs mises à jour. |
|
| Les états de lecture de plusieurs espaces sont mis à jour pour l'utilisateur abonné. |
|
| Les états de lecture de plusieurs fils de discussion sont mis à jour pour l'utilisateur abonné. |
|
Données d'événement
Cette section décrit les données d'événement et les exemples de charges utiles pour les événements dans Chat.
Lorsque votre abonnement Google Workspace reçoit un événement de Chat, le champ data contient la charge utile de l'événement. Cette charge utile contient des informations sur la ressource Google Workspace qui a été modifiée. Par exemple, si vous vous êtes abonné aux événements d'appartenance dans un espace, la charge utile de ces événements contient des informations sur la ressource spaces.membership qui a changé.
Données de ressource dans la charge utile de l'événement
Lorsque vous créez un abonnement, vous pouvez spécifier si vous souhaitez que la charge utile inclue des détails sur la ressource ou simplement le nom de la ressource. Par exemple, si vous souhaitez recevoir des événements concernant les membres d'un espace Chat, spécifiez les champs d'une ressource d'appartenance que vous souhaitez recevoir dans la charge utile de l'événement.
Le tableau suivant fournit des exemples de charges utiles JSON pour un abonnement à l'espace Chat spaces/AAAABBBBBB. Pour chaque événement reçu par l'abonnement, la charge utile apparaît dans le champ data de l'événement :
| Exemple | Type d'événement | Charge utile JSON |
|---|---|---|
Un utilisateur publie un message dans l'espace indiquant "Hello world". |
|
Inclut les données de ressources :
{
"message":
{
"name": "spaces/Exclut les données de ressources :
{
"message":
{
"name": "spaces/ |
| Un utilisateur devient gestionnaire d'un espace. |
|
Inclut les données de ressources :
{
"membership":
{
"name": "spaces/Exclut les données de ressources :
{
"membership":
{
"name": "spaces/ |
| Un utilisateur remplace la description de l'espace par "Équipe commerciale de Cymbal Labs". | google.workspace.chat.space.v1.updated |
Inclut les données de ressources :
{
"space":
{
"name": "spaces/Exclut les données de ressources :
{
"space":
{
"name": "spaces/ |
| Deux utilisateurs de Chat ont été ajoutés à l'espace en même temps. | google.workspace.chat.membership.v1.batchCreated |
Inclut les données de ressources :
{
"memberships": [
{
"membership": {
"name": "spaces/Exclut les données de ressources :
{
"memberships": [
{
"membership": {
"name": "spaces/ |
| Un utilisateur réagit à un message avec l'emoji 😊. | google.workspace.chat.reaction.v1.created |
Inclut les données de ressources :
{
"reaction":
{
"name": "spaces/Exclut les données de ressources :
{
"reaction":
{
"name": "spaces/ |
| Les utilisateurs réagissent à un message avec les emoji 😊 et 😸. | google.workspace.chat.reaction.v1.batchCreated |
Inclut les données de ressources :
{
"reactions": [
{
"reaction": {
"name": "spaces/Exclut les données de ressources :
{
"reactions": [
{
"reaction": {
"name": "spaces/ |
| Un utilisateur accède à un espace non lu, ce qui met à jour l'état de lecture de l'espace. | google.workspace.chat.spaceReadState.v1.updated |
Inclut les données de ressources :
{
"spaceReadState": {
"name": "users/Exclut les données de ressources :
{
"spaceReadState": {
"name": "users/ |
| Un utilisateur lit un message dans un fil de discussion, ce qui met à jour l'état de lecture du fil de discussion. | google.workspace.chat.threadReadState.v1.updated |
Inclut les données de ressources :
{
"threadReadState": {
"name": "users/Exclut les données de ressources :
{
"threadReadState": {
"name": "users/ |
| Un utilisateur devient disponible dans Chat. | google.workspace.chat.availability.v1.updated |
Inclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
"state": "ACTIVE"
}
}
Exclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
}
}
|
| Un utilisateur devient inactif dans Chat. | google.workspace.chat.availability.v1.updated |
Inclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
"state": "IDLE",
}
}
Exclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
}
}
|
Un utilisateur définit sa disponibilité sur Away dans Chat. |
google.workspace.chat.availability.v1.updated |
Inclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
"state": "AWAY",
}
}
Exclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
}
}
|
Un utilisateur définit sa disponibilité sur Do not disturb dans Chat. |
google.workspace.chat.availability.v1.updated |
Inclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
"state": "DO_NOT_DISTURB",
"doNotDisturbMetadata": {
"expirationTime": "2026-03-24T18:36:31.337Z"
}
}
}
Exclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
}
}
|
| Un utilisateur définit un état personnalisé dans Chat. | google.workspace.chat.availability.v1.updated |
Inclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
"state": "ACTIVE",
"customStatus": {
"text": "Be right back",
"emoji": {
"unicode": "👟"
},
"expireTime": "2026-03-24T18:38:05.583655Z"
}
}
}
Exclut les données de ressources :
{
"availability":
{
"name": "users/USER_ID/availability",
}
}
|
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}
Articles associés
- Structure des événements Google Workspace
- Choisir des habilitations OAuth
- Créer un abonnement pour recevoir des événements Chat