Action

Действие, которое описывает поведение при отправке формы. Например, вы можете вызвать скрипт Apps Script для обработки формы. Если действие активировано, значения формы отправляются на сервер.

Доступно для приложений Google Chat и дополнений Google Workspace.

JSON-представление 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Поля
function

string

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

Пример использования приведен в разделе Чтение данных формы.
parameters[]

object (ActionParameter)

Список параметров действия.
loadIndicator

enum (LoadIndicator)

Указывает индикатор загрузки, который отображается во время выполнения действия.
persistValues

boolean

Указывает, сохраняются ли значения формы после действия. Значение по умолчанию: false.

Если задано значение true, значения формы сохраняются после активации действия. Чтобы разрешить пользователю вносить изменения во время обработки действия, задайте для LoadIndicator значение NONE. Для сообщений в виде карточек в приложениях Chat необходимо также задать для ResponseType действия значение UPDATE_MESSAGE и использовать то же значение cardId, что и в карточке, содержащей действие.

Если задано значение false, то при активации действия значения формы будут очищены. Чтобы пользователь не мог вносить изменения во время обработки действия, задайте для LoadIndicator значение SPINNER.
interaction

enum (Interaction)

Необязательное поле. Обязательно при открытии диалогового окна.

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

Если значение не указано, приложение выполняет action, например открывает ссылку или запускает функцию, как обычно.

Указав interaction, приложение может реагировать особыми интерактивными способами. Например, если задать для interaction значение OPEN_DIALOG, приложение сможет открывать диалоговое окно. Если он указан, индикатор загрузки не показывается. Если это свойство задано для дополнения, вся карточка удаляется и в клиенте ничего не показывается.

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.
requiredWidgets[]

string

Необязательное поле. Заполните этот список названиями виджетов, которые необходимы для отправки этого действия.

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

Доступно для приложений Google Chat и дополнений Google Workspace.
allWidgetsAreRequired

boolean

Необязательное поле. Если это так, то все виджеты считаются обязательными для этого действия.

Доступно для приложений Google Chat и дополнений Google Workspace.

ActionParameter

Список строковых параметров, которые нужно передать при вызове метода действия. Например, можно добавить три кнопки: "Отложить", "Отложить на день" и "Отложить на неделю". Вы можете использовать action method = snooze(), передавая тип и время откладывания в списке строковых параметров.

Подробнее CommonEventObject…

Доступно для приложений Google Chat и дополнений Google Workspace.

JSON-представление 
{
  "key": string,
  "value": string
}
Поля
key

string

Название параметра для скрипта действия.
value

string

Значение параметра.

LoadIndicator

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

Доступно для приложений Google Chat и дополнений Google Workspace.

Перечисления
SPINNER Показывает спиннер, указывающий на то, что контент загружается.
NONE Ничего не отображается.

Взаимодействие

Необязательное поле. Обязательно при открытии диалогового окна.

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

Если значение не указано, приложение выполняет action, например открывает ссылку или запускает функцию, как обычно.

Указав interaction, приложение может реагировать особыми интерактивными способами. Например, если задать для interaction значение OPEN_DIALOG, приложение сможет открывать диалоговое окно.

Если он указан, индикатор загрузки не показывается. Если это свойство задано для дополнения, вся карточка удаляется и в клиенте ничего не показывается.

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Перечисления
INTERACTION_UNSPECIFIED Значение по умолчанию. action выполняется в обычном режиме.
OPEN_DIALOG

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

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

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.