Создавайте интерфейсы Google Chat

На этой странице представлен обзор того, как создавать пользовательские интерфейсы (UI) для дополнений Google Workspace, расширяющих возможности Google Chat.

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

  • Триггеры : способы, которыми пользователи Google Chat могут вызвать приложение чата, например, добавить его в пространство или отправить ему сообщение.
  • Объекты событий : данные, которые приложения чата получают от триггеров или взаимодействий пользовательского интерфейса.
  • Действия : способы, которыми приложения чата могут реагировать на взаимодействия, например отправка сообщений или возврат пользовательского интерфейса на основе карточек.
Приложение чата получает объект события от триггера «Добавлено в пространство»
Рисунок 1 : Когда пользователь добавляет приложение Chat в чат-пространство, срабатывает триггер « Добавлено в чат-пространство» и отправляет объект события. Чтобы ответить сообщением, приложение Chat обрабатывает объект события и возвращает действие, создающее сообщение.

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

  • Сообщения , которые могут содержать текст, статические или интерактивные карточки и кнопки.
  • Диалоги , представляющие собой карточки, которые открываются в новом окне и обычно предлагают пользователям отправить информацию.
  • Предварительный просмотр ссылок, представляющий собой карточки, на которых отображается информация о внешнем сервисе.

Триггеры

В этом разделе описываются триггеры, которые надстройки Google Workspace используют в чате.

Триггеры — это конкретные способы, которыми пользователи вызывают приложение чата с помощью пользовательского интерфейса чата, например, с помощью @упоминаний или команд приложения.

В следующей таблице показаны триггеры чата, описание и то, как обычно реагируют приложения чата:

Курок Описание Типичный ответ
Добавлено в космос

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

 Приложение Chat отправляет приветственное сообщение, в котором объясняется, что оно делает и как пользователи могут с ним взаимодействовать.
Сообщение

Пользователь взаимодействует с приложением «Чат» в сообщении одним из следующих способов:

  • Отправляет сообщение в чат-зоне (DM) с помощью приложения «Чат».
  • @упоминает приложение Chat в любом типе пространства.
  • Отправляет сообщение, содержащее ссылку, которая соответствует шаблону URL для предварительного просмотра ссылок .
  • Вводит текст в меню множественного выбора виджета selectionInput .
 Приложение Chat реагирует на основе содержания сообщения. Например, на команду /about приложение Chat отвечает сообщением с описанием задач, которые оно может выполнять.
Удален из космоса

Пользователь удаляет приложение Chat из пространства, или администратор Google Workspace удаляет приложение Chat для пользователя в своей организации.

Пользователи не могут удалить приложения Chat, установленные администратором. Если пользователь ранее установил приложение Chat, оно останется установленным, даже если администратор Google Workspace попытается его удалить.

 Приложение Chat удаляет все входящие уведомления, настроенные для этого пространства (например, удаление вебхука), и очищает внутреннюю память. Приложения Chat не могут отвечать сообщениями на этот триггер, поскольку они больше не являются участниками этого пространства.
Команда приложения

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

 Приложение «Чат» реагирует на команду. Например, отправляет сообщение или открывает диалог.

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

Чтобы отреагировать на триггер, ознакомьтесь со следующими руководствами:

Объекты событий

Приложения чата получают объекты событий при срабатывании триггера чата или при взаимодействии пользователей чата с пользовательским интерфейсом приложения (например, при нажатии кнопки). Объект события содержит данные о взаимодействии, которые приложение чата может использовать для ответа или обновления пользовательского интерфейса.

Информацию об обработке объектов событий см. в следующих руководствах:

Дополнительные сведения о дополнительных объектах событий в Chat и других приложениях Google Workspace см. в разделе Объекты событий .

Действия в чате

В этом разделе объясняется, как чат-приложения могут использовать дополнительные действия для реагирования на взаимодействия с пользователем.

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

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

Чтобы реагировать на взаимодействия с пользователем, приложения чата должны обрабатывать соответствующий объект события и возвращать один из следующих объектов JSON:

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

Ответить, используя API Google Chat

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

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

Информацию об аутентификации и вызове API чата см. в разделе Обзор API чата .