User

Пользователь в Google Chat.

Если ваш чат-приложение аутентифицируется как пользователь и возвращается в качестве результата запроса, то в выходных данных ресурса User (например, в API Messages и Memberships) поля name и type заполняются только для внутренних и внешних пользователей, если только они не являются членами пространства или не имеют предварительной связи с вызывающим пользователем.

JSON-представление
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
Поля
name

string

Имя ресурса для user Google Chat.

Формат: users/{user} . users/app можно использовать в качестве псевдонима для пользователя, вызывающего bot приложения.

Для human users {user} — это тот же идентификатор пользователя, что и:

  • id пользователя в API пользователей. Например, users/123456789 в API чата представляет того же человека, что и идентификатор профиля пользователя 123456789 в API пользователей.

  • id пользователя в API каталога Admin SDK.

  • Адрес электронной почты пользователя можно использовать в качестве псевдонима для {user} в запросах API. Например, если идентификатор профиля пользователя в People API для user@example.com равен 123456789 , вы можете использовать users/user@example.com в качестве псевдонима для ссылки на users/123456789 . API вернет только каноническое имя ресурса (например, users/123456789 ).

displayName

string

Только вывод. Отображаемое имя пользователя.

Это поле заполняется как для аутентификации приложения, так и для аутентификации пользователя. Оно всегда заполняется для запросов, выполняемых с аутентификацией приложения . При вызове API сообщений и членства с аутентификацией пользователя это поле заполняется как для внутренних, так и для внешних пользователей: для sender сообщения, для пользователей в annotations (например, упоминаниях пользователей) и в ресурсах Membership , при условии, что пользователь является членом пространства или имеет предварительную связь с вызывающим пользователем.

avatarUrl

string

Только вывод. URL-адрес изображения аватара пользователя.

При вызове API сообщений и членства с аутентификацией пользователя это поле заполняется как для внутренних, так и для внешних пользователей: для sender сообщения, пользователей в annotations (например, упоминаниях пользователей) и в ресурсах Membership , при условии, что пользователь является членом пространства или имеет предварительную связь с вызывающим пользователем.

email

string

Только вывод. Адрес электронной почты пользователя.

При вызове API сообщений и членства с аутентификацией пользователя это поле заполняется как для внутренних, так и для внешних пользователей: для sender сообщения, пользователей в annotations (например, упоминаниях пользователей) и в ресурсах Membership , при условии, что пользователь является членом пространства или имеет предварительную связь с вызывающим пользователем.

domainId

string

Уникальный идентификатор домена Google Workspace пользователя.

type

enum ( Type )

Тип пользователя.

isAnonymous

boolean

Только для вывода. Если значение true , пользователь удаляется или его профиль не виден, например, когда пользователь упоминается в пространстве, не являясь его участником и не имея предварительной связи с вызывающим пользователем.

Тип

Перечисления
TYPE_UNSPECIFIED Значение по умолчанию для перечисления. НЕ ИСПОЛЬЗОВАТЬ.
HUMAN Пользователь-человек.
BOT Пользователь чат-приложения.