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

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

Предпосылки

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

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

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

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

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

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

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

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

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

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

Когда у вас есть данные вашего приложения Chat, откройте свой проект Cloud и настройте API Chat:

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

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

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

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

  4. Необязательно: В разделе Logs установите флажок Log errors to Logging , чтобы использовать Google Cloud Logging. Для получения дополнительной информации см. Query error logs for Chat apps .

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

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

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

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

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