Cette page explique comment les applications Google Chat peuvent identifier ou spécifier Utilisateurs de Chat
Pour effectuer l'une des opérations suivantes, une application Chat doit spécifier un utilisateur:
- Créez un message qui @ mentionne un utilisateur :
- Inviter ou ajouter un utilisateur à un espace existant, ou ajouter un utilisateur nouvel espace.
- Rechercher des messages privés entre l'application Chat et un utilisateur donné ; ou entre deux utilisateurs.
- Obtenez les informations d'adhésion d'un utilisateur dans un espace.
- Envoyez un message privé à un utilisateur.
- S'abonner à un utilisateur à l'aide de la API Google Workspace Events pour obtenir les événements concernant les changements d'adhésion.
Comment Chat identifie les utilisateurs
L'API Google Chat génère un
Ressource User
pour chaque utilisateur de Chat. Voici deux exemples
Champs User
:
name
est le nom de la ressource, au formatusers/{user}
, où{user}
représente un identifiant unique et stable.users/app
peut être utilisé comme un alias pour l'application Chat appelante.type
est le type d'utilisateur. Ce type indique à Chat est une application Chat ou une personne. Pour Applications de chat, la valeur estBOT
. Pour les personnes, la valeur estHUMAN
Spécifier un utilisateur dans un appel à l'API Google Chat
Pour spécifier un utilisateur, utilisez les valeurs suivantes pour la valeur {user}
:
Pour les utilisateurs de votre organisation Google Workspace, utilisez l'une des approches suivantes:
- Le
name
de RessourceUser
dans l'API Chat, par exempleusers/123456789
. - Le
{person_id}
pour le nom d'un la ressourcePerson
dans l'API People ; oùresourceName
estpeople/{person_id}
(par exemple,users/123456789
dans l'API Chat représente la même personne en tant quepeople/123456789
dans l'API People. - Le
id
d'une ressourceUser
dans l'API Directory, par exemple :users/123456789
dans l'API Chat représente la même personne en tant queusers/123456789
dans l'API Directory.
- Le
Pour un utilisateur d'une organisation Google Workspace externe ou un utilisateur qui utilise un compte Google, un alias d'adresse e-mail, par exemple
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com
ouusers/EMAIL_USERNAME@gmail.com
.
Identifier un utilisateur à partir d'un événement d'interaction
Chaque fois qu'un utilisateur interagit avec une application Chat, Chat envoie une événement d'interaction contenant des informations l’interaction et l’utilisateur. Par exemple, lorsqu'un mentionne une application Chat dans un message, le L'application Chat reçoit des informations sur l'interaction, y compris ce que dit le message et qui l'a envoyé. Applications de chat référencer les utilisateurs lors de la récupération d'informations sur les ressources Chat.
Pour identifier l'utilisateur qui a interagi avec une application Chat, procédez comme suit :
récupérez la valeur de la propriété name
au niveau de
Ressource User
,
que vous pouvez obtenir
Event.user.name
L'exemple JSON suivant montre le format attendu de l'identité de l'utilisateur dans un interaction avec une application Chat:
{
...,
"user": {
"name": "users/12345678901234567890",
"displayName": "Sasha",
"avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
"email": "sasha@example.com"
}
}
Un message est un type spécifique d'interaction. Pour identifier un utilisateur qui a envoyé
un message à une application Chat,
récupérez la valeur de la propriété name
au niveau de
Ressource User
, en utilisant l'une des
suivantes:
Articles associés
- Ajoutez un utilisateur à un espace.
- Gérer les membres d'un espace
- Mentionner un utilisateur avec "@" dans un message