User

Un utilisateur dans Google Chat.

Lorsqu'il est renvoyé en tant que résultat d'une requête, si votre application Chat s'authentifie en tant qu'utilisateur, le résultat d'une ressource User (comme dans les API Messages et Memberships) ne renseigne les champs name et type que pour les utilisateurs internes et externes, sauf s'ils sont membres de l'espace ou s'ils ont une affinité préalable avec l'utilisateur appelant.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
Champs
name

string

Nom de ressource pour un user Google Chat.

Format : users/{user}. users/app peut être utilisé comme alias pour l'utilisateur bot de l'application appelante.

Pour human users, {user} est le même identifiant utilisateur que :

  • id pour Person dans l'API People. Par exemple, users/123456789 dans l'API Chat représente la même personne que l'ID de profil de personne 123456789 dans l'API People.

  • le id d'un utilisateur dans l'API Directory du SDK Admin.

  • L'adresse e-mail de l'utilisateur peut être utilisée comme alias pour {user} dans les requêtes API. Par exemple, si l'ID de profil de personne de l'API People pour user@example.com est 123456789, vous pouvez utiliser users/user@example.com comme alias pour faire référence à users/123456789. Seul le nom canonique de la ressource (par exemple, users/123456789) sera renvoyé par l'API.

displayName

string

Uniquement en sortie. Nom à afficher de l'utilisateur.

Renseigné pour l'authentification des applications et des utilisateurs. Ce champ est toujours renseigné pour les requêtes effectuées avec l'authentification de l'application. Lorsque vous appelez les API Messages et Memberships avec l'authentification des utilisateurs, ce champ est renseigné pour les utilisateurs internes et externes pour le sender d'un message, les utilisateurs dans annotations (tels que les mentions d'utilisateur) et dans les ressources Membership, à condition que l'utilisateur soit membre de l'espace ou ait une affinité préalable avec l'utilisateur appelant.

avatarUrl

string

Uniquement en sortie. URL de l'avatar de l'utilisateur.

Lorsque vous appelez les API Messages et Memberships avec l'authentification des utilisateurs, ce champ est renseigné pour les utilisateurs internes et externes pour le sender d'un message, les utilisateurs dans annotations (tels que les mentions d'utilisateur) et dans les ressources Membership, à condition que l'utilisateur soit membre de l'espace ou ait une affinité préalable avec l'utilisateur appelant.

email

string

Uniquement en sortie. Adresse e-mail de l'utilisateur.

Lorsque vous appelez les API Messages et Memberships avec l'authentification des utilisateurs, ce champ est renseigné pour les utilisateurs internes et externes pour le sender d'un message, les utilisateurs dans annotations (tels que les mentions d'utilisateur) et dans les ressources Membership, à condition que l'utilisateur soit membre de l'espace ou ait une affinité préalable avec l'utilisateur appelant.

domainId

string

Identifiant unique du domaine Google Workspace de l'utilisateur.

type

enum (Type)

Type d'utilisateur.

isAnonymous

boolean

Uniquement en sortie. Lorsque la valeur est true, l'utilisateur est supprimé ou son profil n'est pas visible, par exemple lorsqu'un utilisateur est mentionné dans un espace sans en être membre et sans affinité préalable avec l'utilisateur appelant.

Type

Enums
TYPE_UNSPECIFIED Valeur par défaut de l'énumération. N'UTILISEZ PAS CE CHAMP.
HUMAN Utilisateur humain.
BOT Utilisateur de l'application Chat.