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

Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям.

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

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

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

HTTP

• Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
• Создайте проект Google Cloud .
• Настройте экран согласия OAuth .
• Включите следующие API Google Workspace :
  • API чата Google
  • API надстроек Google Workspace
    Вы не можете использовать API надстроек Google Workspace для создания развертываний приложения Chat и управления ими. Подробности см. в разделе Ограничения и известные проблемы .
• Конечная точка HTTP, в которой размещена архитектура службы для вашего приложения Chat.

Скрипт приложений

• Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
• Создайте проект Google Cloud .
• Настройте экран согласия OAuth .
• Включите API Google Chat .
• Создайте автономный проект Apps Script и включите расширенную службу чата .
• Настройте Chat в манифесте , добавив объект addons.chat и все необходимые области ( oauthScopes ) или префиксы URL-адресов HTTPS ( urlFetchWhitelist ).

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

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

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

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

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

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

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

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

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

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

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

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

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

      • Получайте сообщения 1:1 . Пользователи могут устанавливать приложение Chat и обмениваться сообщениями в выделенном пространстве между пользователем и приложением Chat.

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

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

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

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

      Примечание. Если для Apps Script вы не обновляете триггеры, вам необходимо использовать соответствующие функции обратного вызова, указанные в этом разделе (например, onMessage , onAddedToSpace и onRemovedFromSpace ).
      • ADDED_TO_SPACE : пользователь добавляет приложение чата в групповой разговор или пространство или устанавливает приложение чата для сообщений 1:1.
      • СООБЩЕНИЕ : пользователь отправляет сообщение в приложение чата. Например, отправляет прямое сообщение в приложение Chat или @упоминает приложение Chat в пространстве с несколькими людьми.
      • REMOVED_FROM_SPACE : пользователь удаляет приложение Chat из пространства.

   4. Необязательно: добавьте другие интерактивные функции, такие как команды с косой чертой или предварительный просмотр ссылок .

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

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

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

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

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

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

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

• Если вы создали надстройку с помощью Apps Script:

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

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

Связанные темы

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