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

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

В Google Chat дополнения отображаются для пользователей как приложения Google Chat. Чтобы узнать больше, см. обзор Extend Google Chat .

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

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

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

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

Триггеры

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Ответить с помощью API чата Google

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

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

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