Определить и указать пользователей Google Chat,Определить и указать пользователей Google Chat

На этой странице объясняется, как приложения Google Chat могут идентифицировать или указывать пользователей Chat.

Чтобы выполнить любое из следующих действий, приложение Chat должно указать пользователя:

Как 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 в API чата, например users/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 , используя одно из следующих действий: