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

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

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

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

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

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

При включении API чата вы настраиваете параметры вашего приложения чата, которые отображаются пользователям в чате, включая отображаемое имя, аватар и описание. Эти данные отображаются только в чате. Чтобы опубликовать ваше приложение чата на Marketplace, необходимо также указать параметры, которые отображаются в описании вашего приложения чата на Marketplace .

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

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

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

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

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

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

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

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

Получив данные о своем приложении «Чат», откройте свой облачный проект и настройте API чата:

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

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

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

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

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

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

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

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

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

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