Action

描述提交表单时的行为的操作。例如，您可以调用 Apps 脚本来处理表单。如果触发了该操作，表单值会发送到服务器。

适用于 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

可选。在此列表中填写此 Action 需要的小组件名称，以便有效提交。

如果此处列出的小组件在调用此操作时没有值，则表单提交会中止。

适用于 Google Chat 应用和 Google Workspace 插件。
allWidgetsAreRequired

boolean

可选。如果此值为 true，则此操作会将所有 widget 视为必需。

适用于 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 插件。