Настройте API Чата Google

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

Предварительные условия

Выберите отображаемое имя, аватар и описание для своего приложения чата.

Чтобы вызвать Chat API, вам необходимо настроить приложение Google Chat со следующей информацией:

Поле Описание Формат
Название приложения Отображаемое имя приложения чата. До 25 буквенно-цифровых символов
URL-адрес аватара Изображение, которое отображается в качестве аватара вашего приложения Chat. URL-адрес HTTPS, указывающий на квадратное графическое изображение (PNG или JPEG). Рекомендуемый размер — 256 на 256 пикселей и более.
Описание Краткое описание назначения приложения Чат. До 40 буквенно-цифровых символов

Имя, аватар и описание приложения Chat отображаются пользователям в пользовательском интерфейсе Chat. Для некоторых запросов на запись API Chat Chat использует эту информацию для атрибутирования действий, которые приложение Chat выполняет в Chat.

Например, если вы вызываете метод spaces.create() , Chat включает имя приложения Chat в описание того, кто создал пространство, как показано на следующем рисунке:

Приложение Google Chat создает пространство для пользователя.
Рисунок 1 . Сообщение об атрибуции, которое отображается в Chat, когда метод spaces.create() используется для создания пространства от имени пользователя.

Чтобы взаимодействовать с приложениями чата, пользователи также могут просматривать или использовать эту информацию следующими способами:

  • Запустите приложение «Чат», @упомянув его имя.
  • Найдите и начните прямое сообщение с помощью приложения Chat. В меню «Приложения» в личных сообщениях отображаются имя и аватар приложения Chat.
  • На панели создания сообщений пользователи могут просматривать приложения чата и видеть их имя, аватар и описание.

Настройте приложение Chat в консоли Google Cloud.

Получив сведения о приложении Chat, откройте свой облачный проект и настройте Chat API:

  1. В консоли Google Cloud перейдите на страницу Chat API и нажмите страницу конфигурации :

    Перейдите на страницу конфигурации API чата.

  2. В разделе «Информация о приложении» заполните поля «Название приложения» , «URL-адрес аватара» и «Описание» .

  3. В разделе «Интерактивные функции» установите переключатель « Включить интерактивные функции» в положение «выключено», чтобы отключить интерактивные функции для приложения Chat. Вы можете настроить это позже. Дополнительные сведения о настройке и создании интерактивных функций см. в разделе Получение и ответ на действия пользователя .

  4. Необязательно: в разделе «Журналы » установите флажок «Записывать ошибки в журнал», чтобы использовать облачный журнал Google. Дополнительные сведения см. в разделе Журналы ошибок запросов для приложений чата .

  5. Нажмите Сохранить .

Предоставьте другим людям разрешение на настройку Chat API.

Вы можете предоставить определенным пользователям доступ к странице конфигурации приложения Chat, предоставив им роль « Владелец приложений Chat» или «Просмотр приложений Chat» в Google Cloud Identity Access Management (IAM) . Пользователи с этими ролями не могут перейти на страницу конфигурации приложений Chat с помощью панели мониторинга API и служб , но могут получить доступ к странице конфигурации, перейдя в консоль Google Cloud для хост-проекта облака приложения Chat следующим образом:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

Где PROJECT_ID — это идентификатор проекта Google Cloud, в котором размещено приложение Chat.