На этой странице объясняется, как приложения Google Chat могут идентифицировать или указывать пользователей Chat.
Чтобы выполнить любое из следующих действий, приложение Chat должно указать пользователя:
- Создайте сообщение, в котором @ упоминает пользователя .
- Пригласите или добавьте пользователя в существующее пространство или добавьте пользователя в новое пространство .
- Найдите прямые сообщения между приложением Chat и указанным пользователем или между двумя пользователями.
- Получите сведения о членстве пользователя в пространстве .
- Отправьте личное сообщение пользователю.
- Подпишитесь на пользователя с помощью API Google Workspace Events, чтобы получать события об изменениях его членства.
Как Chat идентифицирует пользователей
API Google Chat создает ресурс User
для каждого человека, использующего чат. Ниже приведены два важных поля User
:
-
name
— это имя ресурса в форматеusers/{user}
, где{user}
представляет собой уникальный и стабильный идентификатор.users/app
можно использовать в качестве псевдонима для вызывающего приложения чата. -
type
— тип пользователя. Этот тип сообщает Chat, является ли пользователь приложением Chat или человеком. Для приложений чата значением являетсяBOT
. Для людей ценностью являетсяHUMAN
.
Укажите пользователя при вызове API Google Chat
Чтобы указать пользователя, используйте следующие значения для значения {user}
:
Для пользователей в вашей организации Google Workspace используйте один из следующих подходов:
-
name
ресурсаUser
в Chat API, напримерusersusers/123456789
. -
{person_id}
для имени ресурсаPerson
в API People, гдеresourceName
—people/{person_id}
— например,users/123456789
в API чата представляют того же человека, что иpeople/123456789
в API People. -
id
ресурсаUser
в API каталога — например,users/123456789
в API чата представляют того же человека, что иusers/123456789
в API каталога.
-
Для пользователя во внешней организации Google Workspace или пользователя, использующего учетную запись Google, используйте псевдоним электронной почты, например
users/ EMAIL_USERNAME @ WORKSPACE_DOMAIN .com
илиusers/ EMAIL_USERNAME @gmail.com
.
Идентификация пользователя по событию взаимодействия
Каждый раз, когда пользователь взаимодействует с приложением Chat, Chat отправляет событие взаимодействия с информацией о взаимодействии и пользователе. Например, когда пользователь упоминает приложение Chat в сообщении, приложение Chat получает информацию о взаимодействии, в том числе о том, что говорится в сообщении и кто его отправил. Приложения чата ссылаются на пользователей при получении информации о ресурсах чата.
Чтобы идентифицировать пользователя, который взаимодействовал с приложением чата, получите значение свойства name
ресурса User
, которое можно получить из Event.user.name
.
В следующем примере JSON показан ожидаемый формат удостоверения пользователя при взаимодействии с приложением чата:
{
...,
"user": {
"name": "users/12345678901234567890",
"displayName": "Sasha",
"avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
"email": "sasha@example.com"
}
}
Сообщение — это особый тип взаимодействия. Чтобы идентифицировать пользователя, отправившего сообщение в приложение чата, получите значение свойства name
ресурса User
, используя одно из следующих действий:
похожие темы
- Добавьте пользователя в пространство .
- Управляйте участниками в пространстве .
- @упомяните пользователя в сообщении .