Package google.apps.card.v1

string

当包含元素被点击或以其他方式激活时要调用的自定义函数。

如需查看使用示例，请参阅读取表单数据。

ActionParameter

操作参数列表。

LoadIndicator

指定在调用操作时操作显示的加载指示器。

bool

指示表单值在操作后是否保持不变。默认值为 false。

如果值为 true，则在触发操作后，表单值会保留。如需允许用户在操作处理期间进行更改，请将 LoadIndicator 设置为 NONE。对于 Chat 应用中的卡片消息，您还必须将操作的 ResponseType 设置为 UPDATE_MESSAGE，并使用包含该操作的卡片中的同一 card_id。

如果值为 false，则在触发操作时清除表单值。为防止用户在处理操作期间进行更改，请将 LoadIndicator 设置为 SPINNER。

Interaction

可选。打开对话框时必须提供。

在与用户互动时（例如用户点击卡片消息中的按钮）应执行的操作。

如果未指定，应用会像往常一样通过执行 action（例如打开链接或运行函数）来做出响应。

通过指定 interaction，应用可以以特殊的互动方式做出响应。例如，通过将 interaction 设置为 OPEN_DIALOG，应用可以打开一个对话框。如果指定此值，则不会显示加载指示器。如果为插件指定了此属性，则整个卡片都会被剥离，并且客户端中不会显示任何内容。

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

string

可选。使用相应操作需要哪些 widget 的名称填充此列表，以便有效提交。

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

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

bool

可选。如果为 true，则此操作会认为所有 widget 都是必需的。

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

string

操作脚本的参数名称。

string

参数的值。

BorderType

边框类型。

Color

当类型为 BORDER_TYPE_STROKE 时要使用的颜色。

如需设置描边颜色，请为 red、green 和 blue 字段指定值。该值必须是介于 0 到 1 之间的浮点数，基于 RGB 颜色值，其中 0 (0/255) 表示没有颜色，1 (255/255) 表示颜色强度最大。

例如，以下代码会将颜色设置为红色，并达到最大强度：

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha 字段不适用于笔画颜色。如果指定，则系统会忽略此字段。

int32

边框的圆角半径。

string

按钮内显示的文字。

Icon

显示在按钮内的图标。如果同时设置了 icon 和 text，则图标会显示在文字前面。

Color

可选。按钮的颜色。如果设置了此属性，按钮 type 会设置为 FILLED，并且 text 和 icon 字段的颜色会设置为对比鲜明的颜色，以便于阅读。例如，如果按钮颜色设置为蓝色，则按钮中的任何文字或图标都会设置为白色。

如需设置按钮颜色，请为 red、green 和 blue 字段指定值。该值必须是介于 0 到 1 之间的浮点数，基于 RGB 颜色值，其中 0 (0/255) 表示没有颜色，1 (255/255) 表示颜色强度最大。

例如，以下代码会将颜色设置为红色，并达到最大强度：

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha 字段不适用于按钮颜色。如果指定，则系统会忽略此字段。

OnClick

必需。用户点击按钮时要执行的操作，例如打开超链接或运行自定义函数。

bool

如果值为 true，则按钮会以非活动状态显示，并且不会响应用户操作。

string

用于辅助功能的替代文字。

设置描述性文本，让用户了解按钮的作用。例如，如果某个按钮会打开一个超链接，您可以这样写：“打开一个新的浏览器标签页，并前往 https://developers.google.com/workspace/chat" 处的 Google Chat 开发者文档”。

Type

可选。按钮的类型。如果未设置，按钮类型默认为 OUTLINED。如果设置了 color 字段，则按钮类型会被强制设置为 FILLED，并且系统会忽略为此字段设置的任何值。

Button

按钮数组。

CardHeader

卡片的标题。标题通常包含一张前导图片和一个标题。标题始终显示在卡片的顶部。

Section

包含 widget 的集合。每个部分都有自己的可选标题。各部分之间用分隔线在视觉上隔开。如需查看 Google Chat 应用中的示例，请参阅定义卡片的一部分。

DividerStyle

标题、部分和页脚之间的分隔线样式。

CardAction

卡片的操作。操作会添加到卡片的工具栏菜单中。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

例如，以下 JSON 会构建一个包含 Settings 和 Send Feedback 选项的卡片操作菜单：

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

卡片的名称。在卡片导航中用作卡片标识符。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

CardFixedFooter

此卡片底部显示的固定页脚。

如果设置了 fixedFooter 但未指定 primaryButton 或 secondaryButton，则会导致错误。对于 Chat 应用，您可以在对话框中使用固定页脚，但不能在卡片消息中使用。

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

DisplayStyle

在 Google Workspace 插件中，设置 peekCardHeader 的显示属性。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

CardHeader

显示情境内容时，预览卡片标题会充当占位符，以便用户在首页卡片和情境卡片之间向前导航。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

ExpressionData

卡片的表情数据。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

string

显示为操作菜单项的标签。

OnClick

相应待办项的 onClick 操作。

Button

固定页脚的主要按钮。按钮必须是设置了文字和颜色的文字按钮。

Button

固定页脚的辅助按钮。按钮必须是设置了文字和颜色的文字按钮。如果设置了 secondaryButton，则还必须设置 primaryButton。

string

必需。卡片标题的标题。标题的高度是固定的：如果同时指定了标题和副标题，则每个标题各占一行。如果仅指定了标题，则标题会占据两行。

string

卡片标题的副标题。如果指定，则显示在 title 下方的单独一行中。

ImageType

用于剪裁图片的形状。

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

string

卡片标题中图片的 HTTPS 网址。

string

此图片的替代文本，用于实现无障碍功能。

TextParagraph

文本段落 widget。

ButtonList

一个按钮列表 widget。

Image

图片 widget。

string

显示在部分顶部的文字。支持简单的 HTML 格式文本。如需详细了解如何设置文本格式，请参阅 Google Chat 应用中的文本格式和 Google Workspace 加载项中的文本格式。

Widget

相应部分中的所有 widget。必须包含至少一个 widget。

bool

指示相应部分是否可收起。

可收起的部分会隐藏部分或全部 widget，但用户可以点击显示更多来展开该部分，从而显示隐藏的 widget。用户可以点击减少显示再次隐藏微件。

如需确定哪些 widget 已隐藏，请指定 uncollapsibleWidgetsCount。

int32

即使在某个部分折叠时仍保持可见的不可折叠 widget 的数量。

例如，如果某个部分包含 5 个 widget，且 uncollapsibleWidgetsCount 设置为 2，则系统始终会显示前两个 widget，并默认收起后三个 widget。只有当 collapsible 为 true 时，系统才会考虑 uncollapsibleWidgetsCount。

string

分配给部分的唯一 ID，用于标识要发生变异的部分。ID 的字符数上限为 64 个字符，格式应为 [a-zA-Z0-9-]+。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

CollapseControl

可选。定义部分的展开和收起按钮。仅当相应部分可折叠时，系统才会显示此按钮。如果未设置此字段，则使用默认按钮。

CarouselCard

轮播界面中包含的卡片列表。

NestedWidget

轮播卡片中显示的 widget 列表。微件会按指定顺序显示。

NestedWidget

轮播界面卡片底部显示的 widget 列表。微件会按指定顺序显示。

Icon

图标图片。如果同时设置了 icon 和 text，则图标会显示在文字前面。

string

条状标签内显示的文字。

OnClick

可选。用户点击条状标签时要执行的操作，例如打开超链接或运行自定义函数。

bool

芯片是否处于有效状态并响应用户操作。默认为 true。已弃用。请改用 disabled。

bool

芯片是否处于非活动状态并忽略用户操作。默认为 false。

string

用于辅助功能的替代文字。

设置描述性文字，让用户了解相应条状标签的作用。例如，如果某个功能块会打开超链接，请写明：“打开新的浏览器标签页，并前往 https://developers.google.com/workspace/chat" 上的 Google Chat 开发者文档”。

Layout

指定的条状标签列表布局。

Chip

一个芯片数组。

HorizontalAlignment

展开和收起按钮的水平对齐方式。

Button

可选。定义一个可自定义的按钮以展开该部分。必须同时设置 expandButton 和 collapseButton 字段。仅设置一个字段集不会生效。如果未设置此字段，则使用默认按钮。

Button

可选。定义一个可自定义的按钮，用于收起相应部分。必须同时设置 expandButton 和 collapseButton 字段。仅设置一个字段集不会生效。如果未设置此字段，则使用默认按钮。

Column

列数组。您可以在卡片或对话框中添加最多 2 列。

HorizontalSizeStyle

指定列如何填充卡片的宽度。

HorizontalAlignment

指定 widget 是与列的左侧、右侧还是中心对齐。

VerticalAlignment

指定 widget 是与列的顶部、底部还是中心对齐。

Widgets

列中包含的 widget 数组。widget 会按其指定顺序显示。

TextParagraph

TextParagraph微件。

Image

Image微件。

DecoratedText

DecoratedText微件。

ButtonList

ButtonList微件。

TextInput

TextInput微件。

SelectionInput

SelectionInput微件。

DateTimePicker

DateTimePicker微件。

ChipList

ChipList微件。

string

ActionRule 的唯一标识符。

ExpressionDataCondition

由表达式数据确定的条件。

ConditionType

条件的类型。

HostAppDataActionMarkup

定义如何更新 Google Workspace 数据。

Action

数据来自远程数据提供方。

PlatformDataSource

数据来自 Google Workspace 应用。

string

在表单输入事件中标识 DateTimePicker 的名称。

如需详细了解如何处理表单输入，请参阅接收表单数据。

string

提示用户输入日期、时间或日期和时间的文本。例如，如果用户正在安排预约，请使用 Appointment date 或 Appointment date and time 等标签。

DateTimePickerType

相应 widget 是否支持输入日期、时间或日期和时间。

int64

微件中显示的默认值，以自 Unix 纪元时间以来的毫秒数表示。

根据选择器的类型 (DateTimePickerType) 指定值：

• DATE_AND_TIME：世界协调时间 (UTC) 的日历日期和时间。例如，如需表示 2023 年 1 月 1 日中午 12:00（世界协调时间），请使用 1672574400000。
• DATE_ONLY：世界协调时间 (UTC) 00:00:00 的日历日期。例如，如需表示 2023 年 1 月 1 日，请使用 1672531200000。
• TIME_ONLY：世界协调时间 (UTC) 中的时间。例如，如需表示下午 12:00，请使用 43200000（或 12 * 60 * 60 * 1000）。

int32

表示与世界协调时间 (UTC) 的时区偏移量（以分钟为单位）的数字。如果设置了此参数，则 value_ms_epoch 会以指定的时区显示。如果未设置，该值默认为用户的时区设置。

Action

当用户在 DateTimePicker 界面中点击保存或清除时触发。

HostAppDataSourceMarkup

Google Workspace 宿主应用特有的数据源，例如 Gmail 电子邮件、Google 日历活动或 Google Chat 消息。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

Icon

已弃用，取而代之的是 startIcon。

Icon

显示在文本前面的图标。

VerticalAlignment

可选。开始图标的垂直对齐方式。如果未设置，图标将垂直居中。

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

string

显示在 text 上方的文字。始终会截断。

TextParagraph

TextParagraph 等效于 top_label。始终会截断。支持比 top_label 更复杂的格式设置。

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

string

必需。主要文本。

支持简单格式。如需详细了解如何设置文本格式，请参阅 Google Chat 应用中的文本格式和 Google Workspace 加载项中的文本格式。

TextParagraph

TextParagraph 等效于 text。支持比 text 更复杂的格式设置。

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

bool

文字环绕设置。如果值为 true，则文本会换行并显示在多行中。否则，文本会被截断。

仅适用于 text，不适用于 topLabel 和 bottomLabel。

string

显示在 text 下方的文字。始终换行。

TextParagraph

TextParagraph 等效于 bottom_label。始终换行。支持比 bottom_label 更复杂的格式设置。

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

OnClick

当用户点击 topLabel 或 bottomLabel 时，系统会触发此操作。

Button

用户可点击以触发操作的按钮。

SwitchControl

一种开关 widget，用户可以点击它来更改其状态并触发操作。

Icon

显示在文字后面的图标。

支持内置和自定义图标。

string

开关 widget 在表单输入事件中的标识名称。

如需详细了解如何处理表单输入，请参阅接收表单数据。

string

用户输入的值，作为表单输入事件的一部分返回。

如需详细了解如何处理表单输入，请参阅接收表单数据。

bool

当 true 时，开关处于选中状态。

Action

开关状态发生变化时要执行的操作，例如要运行的函数。

ControlType

开关在界面中的显示方式。

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

Action

对于 Google Chat 中的插件，用于关闭对话框的操作。

string

ActionRule 的唯一标识符。

Trigger

在执行 EventAction 后将触发的触发器列表。

CommonWidgetAction

常见 widget 操作。

UpdateVisibilityAction

用于更新 widget 可见性的操作。

Visibility

新的公开范围。

string

ExpressionData 的唯一标识符。

string

未编译的表达式。

Condition

由表达式评估结果确定的条件列表。

EventAction

ExpressionData 可用于执行的操作的列表。

Suggestions

string

这是一个无操作架构字段，可能出现在标记中以进行语法检查。

string

网格标题中显示的文字。

GridItem

要在网格中显示的项。

BorderStyle

要应用于每个网格项的边框样式。

int32

要在网格中显示的列数。如果未指定此字段，系统会使用默认值，而该默认值会因网格的显示位置（对话框与随播广告）而异。

OnClick

每个网格项都会重复使用此回调，但会将相应项的标识符和在项列表中的索引添加到回调的参数中。

string

相应网格项的用户指定标识符。此标识符在父网格的 onClick 回调参数中返回。

ImageComponent

网格项中显示的图片。

string

网格项的标题。

string

网格项的副标题。

GridItemLayout

用于网格项的布局。

string

可选。用于辅助功能的图标的说明。如果未指定，则系统会提供默认值 Button。最佳实践是，您应为图标显示的内容以及（如果适用）图标执行的操作设置有用的说明。例如，A user's account portrait 或 Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat。

如果图标是在 Button 中设置的，当用户将鼠标悬停在按钮上时，altText 会显示为辅助文本。不过，如果按钮还设置了 text，则会忽略图标的 altText。

ImageType

应用于图片的剪裁样式。在某些情况下，应用 CIRCLE 裁剪会导致绘制的图片比内置图标大。

string

显示 Google Workspace 提供的内置图标之一。

例如，如需显示飞机图标，请指定 AIRPLANE。对于公交车，请指定 BUS。

如需查看受支持的图标的完整列表，请参阅内置图标。

string

显示托管在 HTTPS 网址中的自定义图标。

例如：

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

支持的文件类型包括 .png 和 .jpg。

MaterialIcon

显示一个 Google Material 图标。

例如，如需显示复选框图标，请使用

"materialIcon": {
  "name": "check_box"
}

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

string

托管图片的 HTTPS 网址。

例如：

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

当用户点击图片时，点击操作会触发此操作。

string

此图片的替代文本，用于实现无障碍功能。

string

图片网址。

string

图片的无障碍功能标签。

ImageCropStyle

要应用于图片的剪裁样式。

BorderStyle

要应用于图片的边框样式。

ImageCropType

裁剪类型。

double

如果剪裁类型为 RECTANGLE_CUSTOM，则要使用的宽高比。

例如，以下展示了如何应用 16:9 的宽高比：

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

string

用于返回到插件的链接的网址。

string

用于返回到插件的链接的标题。

Card

显示第三方服务中链接的相关信息的卡片。

string

链接预览的智能条状标签中显示的标题。如果未设置，智能条状标签会显示 previewCard 的标题。

string

链接预览中显示的标题。如果未设置，链接预览会显示 previewCard 的标题。

string

Google Material 图标中定义的图标名称，例如 check_box。所有无效名称都会被舍弃并替换为空字符串，从而导致图标无法呈现。

bool

图标是否以填充状态呈现。默认值为 false。

如需预览不同的图标设置，请前往 Google 字体图标，然后调整自定义下的设置。

int32

图标的描边粗细。您可以从 {100, 200, 300, 400, 500, 600, 700} 中选择。如果不存在，则默认值为 400。如果指定了任何其他值，则使用默认值。

如需预览不同的图标设置，请前往 Google 字体图标，然后调整自定义下的设置。

int32

粗细和等级会影响符号的粗细。与调整粗细相比，调整等级更加精细，对符号大小的影响也较小。可选择 {-25, 0, 200}。如果未提供，则默认值为 0。如果指定了任何其他值，则使用默认值。

如需预览不同的图标设置，请前往 Google 字体图标，然后调整自定义下的设置。

UpdateWidget

对于 Google Chat 中的插件，此方法会更新卡片或对话框中的 widget。

SelectionInputWidgetSuggestions

对于 selectionInput widget，多选菜单中建议项的数组。当多选菜单使用外部数据源来填充其项时，微件可以根据用户在菜单中输入的内容动态填充建议。如需了解详情，请参阅收集 Google Chat 用户的信息。

SelectionItem

用户在多选菜单中输入内容后显示的可选项目数组。

bool

弹出除根卡片之外的所有卡片。

bool

弹出一张卡。

string

弹出指定卡片名称之上的所有卡片。

Card

将卡片推送到卡片堆栈。

对于 Google Chat 中的对话框，用于打开或更新对话框。

Card

使用新卡片更新顶部卡片，并保留已填写的表单字段值。对于非等效字段，系统会舍弃相应值。

对于 Google Chat 中的对话框，用于打开或更新对话框。

EndNavigation

对于 Google Chat 中的插件，关闭对话框。

string

要为通知显示的纯文本，不含 HTML 标记。

Action

如果指定，则通过此 onClick 触发操作。

OpenLink

如果指定，此 onClick 会触发打开链接操作。

Action

当操作需要打开链接时，插件会触发此操作。这与上面的 open_link 不同，因为此链接需要与服务器通信才能获取。因此，在打开链接操作响应返回之前，需要为 Web 客户端做一些准备工作。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

Card

点击后，系统会将新卡片推送到卡片堆栈（如果已指定）。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

OverflowMenu

如果指定，此 onClick 会打开溢出菜单。

string

要打开的网址。HTTP 网址会转换为 HTTPS 网址。

OpenAs

如何打开链接。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

OnClose

客户端在打开链接后是忘记该链接，还是会一直观察该链接直到窗口关闭。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

OverflowMenuItem

必需。菜单选项列表。

Icon

显示在文本前面的图标。

string

必需。用于向用户标识或描述商品的文本。

OnClick

必需。选择菜单选项时调用的操作。此 OnClick 不得包含 OverflowMenu，任何指定的 OverflowMenu 都会被舍弃，并且菜单项会被停用。

bool

菜单选项是否已停用。默认值为 false。

Action

插件可用于更新界面的操作。

Google Chat 中的插件。

HostAppActionMarkup

由各个宿主应用处理的操作。

string

这是一个无操作架构字段，可能出现在标记中以进行语法检查。

Navigation

推送、弹出或更新卡片。

Google Chat 中的插件。

OpenLink

在新标签页或弹出式窗口中打开目标链接。

Notification

当用户与卡片互动时，在宿主 Google Workspace 应用中显示通知。

对于 Google Chat 中的插件，当用户提交并关闭对话框时，显示通知。

LinkPreview

适用于 Google 文档、Google 表格和 Google 幻灯片。包含智能条状标签和卡片的预览链接。如需了解详情，请参阅包含智能条状标签的预览链接。

Link

可在 Google 文档中使用。返回第三方资源的链接，并将其转换为宿主应用中的智能条状标签。格式为包含一项内容的数组。

如需了解详情，请参阅通过“@”菜单创建第三方资源。

ModifyCard

对于 Google Chat 中的插件，根据用户互动更新卡片。该数组只能包含一个对象。

string

必需。用于在表单输入事件中标识选择输入的名称。

如需详细了解如何处理表单输入，请参阅接收表单数据。

string

界面中显示在选择输入字段上方的文字。

指定有助于用户输入应用所需信息的文字。例如，如果用户要从下拉菜单中选择工单的紧急程度，则标签可能是“紧急程度”或“选择紧急程度”。

SelectionType

在 SelectionInput widget 中向用户显示的商品类型。选择类型支持不同类型的互动。例如，用户可以选择一个或多个复选框，但只能从下拉菜单中选择一个值。

SelectionItem

可选择项的数组。例如，单选按钮或复选框的数组。最多支持 100 个项目。

Action

如果指定了该属性，则当选择发生更改时，系统会提交表单。如果未指定，您必须指定一个单独的按钮来提交表单。

如需详细了解如何处理表单输入，请参阅接收表单数据。

int32

对于多选菜单，用户在菜单返回建议的选择项之前输入的文本字符数。

如果未设置，多选菜单将使用以下默认值：

• 如果菜单使用 SelectionInput 项的静态数组，则默认为 0 个字符，并立即从数组中填充项。
• 如果菜单使用动态数据源 (multi_select_data_source)，则默认在查询数据源以返回建议项之前使用 3 个字符。

DataSourceConfig

可选。选择控件的数据源配置。此字段可更精细地控制数据源。

如果指定了此字段，则忽略 multi_select_max_selected_items 字段、multi_select_min_query_length 字段、external_data_source 字段和 platform_data_source 字段。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

int32

对于多选菜单，用户可选择的项数上限。最小值为 1 项。如果未指定，则默认为 3 项。

string

可选。显示在选择输入字段下方的文字，旨在通过提示用户输入特定值来帮助他们。此文本始终可见。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

Action

外部数据源，例如关系型数据库。

PlatformDataSource

Google Workspace 中的数据源。

CommonDataSource

由所有 Google Workspace 应用共享的数据源，例如 Google Workspace 组织中的用户。

HostAppDataSourceMarkup

Google Workspace 宿主应用（例如 Google Chat 中的聊天室）特有的数据源。

此字段支持 Google API 客户端库，但在 Cloud 客户端库中不可用。如需了解详情，请参阅安装客户端库。

string

用于向用户标识或描述商品的文本。

string

与相应商品关联的值。客户端应将此值用作表单输入值。

如需详细了解如何处理表单输入，请参阅接收表单数据。

bool

相应项是否默认处于选中状态。如果选择输入仅接受一个值（例如对于单选按钮或下拉菜单），则仅为一个项设置此字段。

string

对于多选菜单，显示在相应项的 text 字段下方的文本说明或标签。

string

RenderActions

一组渲染指令，用于指示卡片执行操作，和/或指示插件宿主应用执行应用特有的操作。

bool

卡片的状态是否已更改，以及现有卡片中的数据是否已过时。

string

这是一个空操作架构字段，可能出现在标记中以进行语法检查。

SuggestionItem

用于文本输入字段中的自动补全建议的建议列表。

string

文本输入字段的建议输入值。这相当于用户自行输入的内容。

string

在表单输入事件中用于标识文本输入的名称。

如需详细了解如何处理表单输入，请参阅接收表单数据。

string

显示在界面中文字输入字段上方的文字。

指定有助于用户输入应用所需信息的文字。例如，如果您要询问某人的姓名，但特别需要对方的姓氏，请使用 surname 而不是 name。

如果未指定 hintText，则必须提供此值。否则，为可选。

string

显示在文本输入字段下方的文字，旨在通过提示用户输入特定值来帮助用户。此文本始终可见。

如果未指定 label，则必须提供此值。否则，为可选。

string

用户输入的值，作为表单输入事件的一部分返回。

如需详细了解如何处理表单输入，请参阅接收表单数据。

Type

文本输入字段在界面中的显示方式。例如，字段是单行还是多行。

Action

当文本输入字段发生更改时应执行的操作。例如，用户向字段中添加内容或删除文本。

可采取的操作包括运行自定义函数或在 Google Chat 中打开对话框。

Suggestions

用户可以输入的建议值。当用户点击文本输入字段时，系统会显示这些值。随着用户输入内容，建议值会动态过滤，以匹配用户输入的内容。

例如，编程语言的文本输入字段可能会建议 Java、JavaScript、Python 和 C++。当用户开始输入 Jav 时，建议列表会过滤为仅显示 Java 和 JavaScript。

建议值有助于引导用户输入您的应用可以理解的值。在提及 JavaScript 时，有些用户可能会输入 javascript，而另一些用户可能会输入 java script。建议 JavaScript 可以标准化用户与应用的互动方式。

如果指定了 TextInput.type，则该值始终为 SINGLE_LINE，即使将其设置为 MULTIPLE_LINE 也是如此。

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

Action

可选。指定当文本输入字段向与之互动的用户提供建议时要采取的操作。

如果未指定，建议由 initialSuggestions 设置，并由客户端处理。

如果指定了此属性，应用会执行此处指定的操作，例如运行自定义函数。

适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

Validation

指定此文本字段所需的输入格式验证。

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

string

当文本输入字段为空时，该字段中显示的文本。使用此文本提示用户输入值。例如 Enter a number from 0 to 100。

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

HostAppDataSourceMarkup

Google Workspace 宿主应用特有的数据源，例如 Gmail 电子邮件、Google 日历活动或 Google Chat 消息。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

string

widget 中显示的文本。

int32

widget 中显示的最大文本行数。如果文本超过指定的最大行数，多余的内容会隐藏在显示更多按钮后面。如果文本的行数等于或少于指定的最大行数，则不会显示显示更多按钮。

默认值为 0，表示显示所有上下文。系统会忽略负值。

TextSyntax

文本的语法。如果未设置，则文本会呈现为 HTML。

适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

string

ActionRule 的唯一标识符。

int32

指定文本输入 widget 的字符数限制。请注意，此属性仅用于文本输入，其他 widget 会忽略此属性。

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

InputType

指定输入微件的类型。

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

HorizontalAlignment

指定 widget 是与列的左侧、右侧还是中心对齐。

string

分配给 widget 的唯一 ID，用于标识要发生变异的 widget。ID 的字符数上限为 64 个字符，应采用 [a-zA-Z0-9-]+ 格式。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

Visibility

指定 widget 是可见还是隐藏。默认值为 VISIBLE。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

EventAction

指定可对 widget 执行的事件操作。

适用于扩展 Google Workspace 工作流程的 Google Workspace 加购项，这些加购项是 Gemini Alpha 版计划的一部分。不适用于 Google Chat 应用。

TextParagraph

显示文本段落。支持简单的 HTML 格式文本。如需详细了解如何设置文本格式，请参阅 Google Chat 应用中的文本格式和 Google Workspace 加载项中的文本格式。

例如，以下 JSON 会创建粗体文本：

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

显示图片。

例如，以下 JSON 会创建带有替代文本的图片：

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

显示带装饰的文本项。

例如，以下 JSON 会创建一个显示电子邮件地址的装饰文本 widget：

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

按钮列表。

例如，以下 JSON 会创建两个按钮。第一个是蓝色文字按钮，第二个是用于打开链接的图片按钮：

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

TextInput

显示一个文本框，供用户输入内容。

例如，以下 JSON 会创建一个电子邮件地址的文本输入：

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

再举一个例子，以下 JSON 会创建一个文本输入，用于输入带有静态建议的编程语言：

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

SelectionInput

显示一个选择控件，供用户选择项目。选择控件可以是复选框、单选按钮、开关或下拉菜单。

例如，以下 JSON 会创建一个下拉菜单，供用户选择尺寸：

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

DateTimePicker

显示一个微件，让用户输入日期、时间或日期和时间。

例如，以下 JSON 会创建一个用于安排预约的日期时间选择器：

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": 796435200000
}

Divider

在 widget 之间显示水平线分隔线。

例如，以下 JSON 会创建一个分隔线：

"divider": {
}

Grid

显示包含一系列项的网格。

网格支持任意数量的列和项。行数由商品数量上限除以列数确定。一个包含 10 个项和 2 列的网格有 5 行。一个包含 11 个项和 2 列的网格有 6 行。

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

例如，以下 JSON 会创建一个包含单个商品的 2 列网格：

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}

Columns

最多可显示 2 列。

如需添加 2 列以上的列，或使用行，请使用 Grid widget。

例如，以下 JSON 会创建 2 个列，每个列都包含文本段落：

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

Carousel

轮播界面包含一组嵌套的 widget。例如，以下是包含两个文本段落的轮播界面的 JSON 表示法。

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

ChipList

一个 chip 列表。

例如，以下 JSON 会创建两个 chip。第一个是文字 chip，第二个是用于打开链接的图标 chip：

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}