User

Um usuário no Google Chat.

Quando retornado como uma saída de uma solicitação, se o app do Chat se autenticar como um usuário, a saída de um recurso User (como nas APIs Messages e Memberships) vai preencher apenas os campos name e type para usuários internos e externos, a menos que eles sejam participantes do espaço ou tenham afinidade anterior com o usuário que fez a chamada.

Representação JSON
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
Campos
name

string

Nome do recurso para um user do Google Chat.

Formato: users/{user}. users/app pode ser usado como um alias para o usuário do app de chamada bot.

Para human users, {user} é o mesmo identificador de usuário que:

  • o id da Person na API People. Por exemplo, users/123456789 na API Chat representa a mesma pessoa que o ID do perfil 123456789 na API People.

  • o id de um usuário na API Directory do SDK Admin.

  • O endereço de e-mail do usuário pode ser usado como um alias para {user} em solicitações de API. Por exemplo, se o ID do perfil da API People para user@example.com for 123456789, você poderá usar users/user@example.com como um alias para se referir a users/123456789. Somente o nome canônico do recurso (por exemplo, users/123456789) será retornado da API.

displayName

string

Apenas saída. O nome de exibição do usuário.

Preenchido para autenticação de app e de usuário. Esse campo é sempre preenchido para solicitações feitas com autenticação do app. Ao chamar as APIs Messages e Memberships com autenticação de usuário, esse campo é preenchido para usuários internos e externos no sender de uma mensagem, usuários em annotations (como menções de usuários) e em recursos Membership, desde que o usuário seja membro do espaço ou tenha afinidade anterior com o usuário que fez a chamada.

avatarUrl

string

Apenas saída. O URL da imagem do avatar do usuário.

Ao chamar as APIs Messages e Memberships com autenticação de usuário, esse campo é preenchido para usuários internos e externos no sender de uma mensagem, usuários em annotations (como menções de usuários) e em recursos Membership, desde que o usuário seja membro do espaço ou tenha afinidade anterior com o usuário que fez a chamada.

email

string

Apenas saída. O endereço de e-mail do usuário.

Ao chamar as APIs Messages e Memberships com autenticação de usuário, esse campo é preenchido para usuários internos e externos no sender de uma mensagem, usuários em annotations (como menções de usuários) e em recursos Membership, desde que o usuário seja membro do espaço ou tenha afinidade anterior com o usuário que fez a chamada.

domainId

string

Identificador exclusivo do domínio do Google Workspace do usuário.

type

enum (Type)

Tipo de usuário.

isAnonymous

boolean

Apenas saída. Quando true, o usuário é excluído ou o perfil dele não fica visível, como quando um usuário é mencionado em um espaço sem ser membro e sem afinidade prévia com o usuário que fez a chamada.

Tipo

Tipos enumerados
TYPE_UNSPECIFIED Valor padrão para a enumeração. NÃO USE.
HUMAN Usuário humano.
BOT Usuário do app Chat.