Cette page explique comment les applications Google Chat peuvent identifier ou spécifier les 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.
- Invitez ou ajoutez un utilisateur à un espace existant, ou ajoutez-en un à un nouvel espace.
- Recherchez les messages privés entre l'application Chat et un utilisateur spécifié, ou entre deux utilisateurs.
- Obtenir les informations concernant l'appartenance d'un utilisateur à un espace
- Envoyez un message privé à un utilisateur.
Comment Chat identifie les utilisateurs
L'API Google Chat génère une ressource User
pour chaque personne qui utilise Chat. Voici deux champs User
importants:
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 alias pour l'application Chat appelante.type
est le type d'utilisateur. Ce type indique à Chat si l'utilisateur est une application Chat ou une personne. Pour les applications 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, optez pour l'une des approches suivantes:
- Le
name
de la ressourceUser
dans l'API Chat, par exempleusers/123456789
- Le
{person_id}
pour le nom d'une ressourcePerson
dans l'API People, oùresourceName
estpeople/{person_id}
. Par exemple,users/123456789
dans l'API Chat représente la même personne 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 queusers/123456789
dans l'API Directory).
- Le
Dans le cas d'un utilisateur d'une organisation Google Workspace externe ou d'un compte Google, utilisez 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 un événement d'interaction contenant des informations sur l'interaction et l'utilisateur. Par exemple, lorsqu'un utilisateur mentionne une application Chat dans un message, celle-ci reçoit des informations sur l'interaction, y compris le contenu du message et son expéditeur. Les applications Chat référencent 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, obtenez la valeur de la propriété name
sur la ressource User
, que vous pouvez obtenir à partir de Event.user.name
.
L'exemple JSON suivant montre le format attendu de l'identité de l'utilisateur dans une 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, obtenez la valeur de la propriété name
sur la ressource User
à l'aide de l'une des méthodes suivantes:
Articles associés
- Ajoutez un utilisateur à un espace.
- Gérer les membres d'un espace
- @ mentionner un utilisateur dans un message ;