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

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

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

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

Примечание: На этой странице объясняется, как настроить приложение Chat с помощью Apps Script или HTTP-сервиса. Dialogflow и Pub/Sub недоступны. Подробности см. в разделе Ограничения и известные проблемы .

Предпосылки

• Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .
• Создайте проект Google Cloud .
• Настройте экран согласия OAuth .
• Включите API чата Google .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Похожие темы

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