Как настроить приложение Google Chat

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

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

Требования

• Аккаунт Google Workspace версии Business или Enterprise с доступом к Google Chat.

• Проект Google Cloud. Чтобы создать его, см. статью Как создать облачный проект Google Cloud.

• Настройте окно запроса доступа OAuth.
• Включите Google Chat API.

Как выбрать отображаемое название, аватар и описание для приложения Chat

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

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

Прежде чем настраивать приложение Chat, подготовьте следующую информацию:

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

В следующем разделе вы укажете эту информацию в настройках конфигурации API Chat.

Как настроить приложение Chat в консоли Google Cloud

В консоли Google Cloud можно настроить сведения о приложении Chat, которые будут показываться пользователям в Chat, в том числе отображаемое название, аватар и описание. Эти данные показываются только в Chat. Чтобы опубликовать приложение Chat в каталоге Marketplace, вам также нужно указать сведения, которые будут показываться на странице приложения в каталоге.

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

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

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

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

3. В разделе Интерактивные функции включите параметр Включить интерактивные функции и выполните следующие действия:

   1. В разделе Функциональность выберите Присоединяться к чат-группам и групповым чатам, чтобы приложение Chat можно было установить и использовать.

      По умолчанию пользователи могут устанавливать приложения Chat и обмениваться сообщениями с ними в отдельных чат-группах. Также пользователи могут добавлять приложения Chat в чат-группы с несколькими участниками и взаимодействовать с ними.

   2. В разделе Настройки подключения выберите архитектуру, которую хотите использовать для получения объектов событий из Chat:

      • Чтобы использовать сервис HTTP, выберите URL конечной точки HTTP и укажите URL.
      • Чтобы использовать проект Google Apps Script, выберите Apps Script и укажите идентификатор развертывания для проекта.
      • Чтобы использовать агента Dialogflow, выберите Dialogflow, а затем Dialogflow CX или Dialogflow ES и укажите название ресурса агента.
      • Чтобы использовать Pub/Sub, выберите Cloud Pub/Sub и введите название темы.
      Предупреждение. Если идентификатор развертывания Apps Script уже указан, проект Cloud связан с существующим дополнением Google Workspace. Если вы измените идентификатор развертывания в Chat API, он обновится для вашего дополнения и может повлиять на его страницу в Google Workspace Marketplace. Чтобы проверить конфигурацию дополнения, ознакомьтесь с разделом Настройка приложения в Google Workspace Marketplace SDK в документации Google Workspace Marketplace.

   3. Чтобы получать объекты событий в несколько конечных точек или функций, перейдите в раздел Настройки подключения > Триггеры и укажите или обновите функции обратного вызова для следующих триггеров чата:

      Примечание. Если вы не обновите триггеры в Apps Script, вам нужно будет использовать соответствующие функции обратного вызова, которые указаны в этом разделе (например, onMessage, onAddedToSpace и onRemovedFromSpace).
      • Добавлено в чат-группу. Пользователь добавляет приложение Chat в групповой чат или чат-группу или устанавливает приложение Chat для прямых переписок.
      • Сообщение. Пользователь отправляет сообщение приложению Chat. Например, отправляет прямую переписку приложению Chat или @упоминает приложение Chat в чат-группе с несколькими пользователями.
      • Удалено из чат-группы. Пользователь удалил приложение Chat из чат-группы.
      • Команда приложения. Пользователь использует быструю команду или слеш-команду в приложении Chat.

   4. Вы также можете добавить другие интерактивные функции, например стартовые запросы, быстрые команды, команды со слешем или предварительный просмотр ссылок.

   5. В разделе Видимость укажите свой адрес электронной почты, чтобы установить и протестировать приложение Chat перед публикацией в Google Workspace Marketplace. Вы можете указать до пяти пользователей или одну или несколько групп Google из вашей организации Google Workspace.

4. Необязательно: в разделе Журналы установите флажок Регистрировать ошибки в Logging, чтобы использовать Google Cloud Logging. Подробнее о том, как запрашивать журналы ошибок для приложений Chat, рассказывается в документации по Chat API.

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

После сохранения конфигурации все, кто указан в настройке Видимость Chat API, смогут установить, протестировать или использовать приложение Chat. Чтобы начать тестирование и отладку приложения Chat, ознакомьтесь с разделом Как тестировать интерактивные функции приложений Google Chat в документации Chat API.

Рекомендации по использованию существующих дополнений Google Workspace

Приложения Chat требуют другой конфигурации по сравнению с дополнениями Google Workspace, которые расширяют другие приложения Google Workspace. Если ваше дополнение расширяет другие приложения Google Workspace, при настройке приложения Chat учитывайте следующие требования:

• Как обычные пользователи, так и администраторы Google Workspace должны иметь возможность установить ваше дополнение из Marketplace. Эти настройки установки задаются в Google Workspace Marketplace SDK.
• Приложения Chat не используют название и логотип, которые вы настраиваете для других приложений Google Workspace в объекте addons.common манифеста.
• Для дополнений, опубликованных в Google Workspace Marketplace, нельзя сохранить черновик изменений настроек конфигурации Google Chat API. После того как вы обновите и сохраните настройки конфигурации Chat API, обновленное приложение Chat станет доступно всем существующим пользователям. Чтобы изменить страницу приложения в каталоге, вы можете создать черновик, прежде чем отправлять изменения.

• Если вы создали дополнение с помощью Apps Script:

  • Используйте тот же идентификатор развертывания Apps Script, что и для остальной конфигурации дополнения.
  • Установить тестовые развертывания в Chat с помощью редактора Apps Script нельзя. Вместо этого вам нужно установить их непосредственно из интерфейса Chat.

• Если вы создали дополнение с помощью HTTP-сервиса, не указывайте в манифесте и развертываниях, созданных с помощью Google Workspace Add-ons API, сведения о конфигурации приложения Chat. Развертывания HTTP, указанные в Google Workspace Marketplace SDK, используются только для других приложений Google Workspace.

Статьи по теме

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