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

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

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

bool

适用于 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 字段指定一个值。该值必须是基于 RGB 颜色值介于 0 和 1 之间的浮点数，其中 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，并忽略为此字段设置的任何值。

适用于 Google Chat 应用，不适用于 Google Workspace 插件。

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

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

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

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

DisplayStyle

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

适用于 Google Workspace 插件，不适用于 Google Chat 应用。

CardHeader

显示上下文内容时，提示卡标题可充当占位符，以便用户可以在首页卡片和上下文卡片之间向前导航。

适用于 Google Workspace 插件，不适用于 Google Chat 应用。

string

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

OnClick

此操作项的 onClick 操作。

Button

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

Button

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

string

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

string

卡片标题的副标题。如果指定，则会显示在 title 下方自己的行中。

ImageType

用于剪裁图片的形状。

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

string

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

string

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

string

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

Widget

该部分中的所有微件。必须包含至少一个微件。

bool

指示此部分是否可收起。

可收起的部分会隐藏部分或全部微件，但用户可以通过点击展开来展开相应部分，以显示隐藏的微件。用户可以点击显示较少，再次隐藏这些微件。

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

int32

不可收起的微件的数量，即使某个版块处于收起状态，这些微件也会保持可见状态。

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

CollapseControl

可选。定义该部分的展开和收起按钮。只有当相应部分可以收起时，系统才会显示此按钮。如果未设置此字段，则使用默认按钮。 适用于 Google Chat 应用，但不适用于 Google Workspace 插件。

Icon

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

string

条状标签中显示的文本。

OnClick

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

bool

条状标签是否处于活动状态并响应用户操作。默认为 true。已弃用。请改用 disabled。

bool

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

string

用于无障碍功能的替代文本。

设置描述性文本，让用户知道条状标签的用途。例如，如果条状标签打开一个超链接，则输入以下内容：“打开新的浏览器标签页并转到 Google Chat 开发者文档 (https://developers.google.com/workspace/chat")”。

Layout

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

Chip

条状标签数组。

HorizontalAlignment

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

Button

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

Button

可选。定义一个可自定义的按钮来收起该部分。必须设置 expandButton 和 collapseButton 字段。只有一个字段集不会生效。如果未设置此字段，则使用默认按钮。

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

指定 widget 是沿列的左侧、右侧还是中间对齐。

VerticalAlignment

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

Widgets

列中包含的一组微件。微件会按照指定的顺序显示。

TextParagraph

TextParagraph微件。

Image

Image微件。

DecoratedText

DecoratedText微件。

ButtonList

ButtonList微件。

TextInput

TextInput微件。

SelectionInput

SelectionInput微件。

DateTimePicker

DateTimePicker微件。

ChipList

ChipList 微件。 适用于 Google Chat 应用，但不适用于 Google Workspace 插件。

string

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

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

string

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

DateTimePickerType

微件是否支持输入日期、时间或日期和时间。

int64

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

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

• DATE_AND_TIME：世界协调时间 (UTC) 的日历日期和时间。例如，如需表示世界协调时间 (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 界面中的保存或清除时触发。

Validation

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

Icon

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

Icon

在文字前面显示的图标。

string

text 上方显示的文本。始终截断。

string

必需。主要文本。

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

bool

“文本换行”设置。如果为 true，文本会换行显示。否则，文本会被截断。

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

string

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

OnClick

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

Button

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

SwitchControl

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

Icon

文本后面显示的图标。

支持内置和自定义图标。

string

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

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

string

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

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

bool

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

Action

开关状态更改时要执行的操作，例如要运行的函数。

ControlType

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

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

Action

用于让客户端结束对话框流程的呈现操作。

适用于 Google Chat 应用，但不适用于 Google Workspace 插件。

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

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

string

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

string

Google Material 图标中定义的图标名称，例如 check_box。系统会舍弃所有无效名称并将其替换为空字符串，这会导致图标无法呈现。

bool

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

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

int32

图标的描边粗细。从 {100、200、300、400、500、600、700} 中进行选择。如果不存在，则默认值为 400。如果指定任何其他值，则系统会使用默认值。

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

int32

Weight 和 Grade 会影响符号的粗细。调整 Grade 比调整 Weight 更精细，对符号大小的影响较小。从 {-25, 0, 200} 中进行选择。如果不存在，则默认值为 0。如果指定任何其他值，则系统会使用默认值。

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

bool

卡片堆栈会弹出除根卡以外的所有卡片。

bool

卡片堆叠弹出一张卡片。

string

卡片堆栈会弹出具有给定卡片名称的指定卡片上方的所有卡片。

Card

卡片堆叠将卡片推送到卡片堆叠。

Card

卡片堆叠会使用新卡片更新顶部卡片，并保留已填充的表单字段值。对于不等效的字段，系统会舍弃该值。

EndNavigation

Dialogflow 结束导航操作。如需了解详情，请参阅为 Google Chat 应用构建首页

适用于 Google Chat 应用，但不适用于 Google Workspace 插件。

string

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

Action

如果指定，系统会通过此 onClick 触发操作。

OpenLink

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

Action

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

适用于 Google Workspace 插件，不适用于 Google Chat 应用。

Card

点击后，新卡片会推送到卡片堆叠（如果指定）。

适用于 Google Workspace 插件，不适用于 Google Chat 应用。

OverflowMenu

如果指定，此 onClick 会打开菜单。 适用于 Google Chat 应用，但不适用于 Google Workspace 插件。

string

要打开的网址。

OpenAs

如何打开链接。

适用于 Google Workspace 插件，不适用于 Google Chat 应用。

OnClose

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

适用于 Google Workspace 插件，不适用于 Google Chat 应用。

OverflowMenuItem

必需。菜单选项列表。

Icon

在文字前面显示的图标。

string

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

OnClick

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

bool

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

Action

HostAppActionMarkup

由各个托管应用处理的操作。

string

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

Navigation

推送、弹出或更新显示的卡片。

OpenLink

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

Notification

向最终用户显示通知。

LinkPreview

向最终用户显示链接预览。

Link

从 Google Workspace 应用中创建的第三方资源的链接。格式为包含一个项的对象数组。如需了解详情，请参阅通过“@”菜单创建第三方资源。

string

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

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

string

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

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

SelectionType

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

SelectionItem

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

Action

如果已指定，则在选择发生变化时提交表单。如果未指定，则必须指定一个用于提交表单的单独按钮。

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

int32

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

int32

对于多选菜单，用户在应用查询之前输入的文本字符数会自动填充并在菜单中显示建议项。

如果未指定，则对于静态数据源，默认为 0 个字符；对于外部数据源，默认为 3 个字符。

Validation

对于下拉菜单，此选择输入字段的验证。

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

Action

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

PlatformDataSource

Google Workspace 中的数据源。

CommonDataSource

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

HostAppDataSourceMarkup

仅适用于 Google Workspace 托管应用（例如 Google Chat 中的聊天室）的数据源。

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

string

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

string

与此项关联的值。客户端应将其用作表单输入值。

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

bool

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

string

对于多选菜单，相应图标的网址会显示在该项的 text 字段旁边。支持 PNG 和 JPEG 文件。必须是 HTTPS 网址。例如 https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。

string

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

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 插件。

string

微件中显示的文本。

int32

在 widget 中显示的文本行数上限。如果文本超出指定的行数上限，多余的内容将隐藏在展开按钮后面。如果文本等于或短于指定的行数上限，系统不会显示展开按钮。

默认值为 0，此时会显示所有上下文。系统会忽略负值。适用于 Google Chat 应用，不适用于 Google Workspace 插件。

int32

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

InputType

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

HorizontalAlignment

指定 widget 是沿列的左侧、右侧还是中间对齐。

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 会创建一个显示电子邮件地址的装饰文本微件：

"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

在微件之间显示水平分隔线。

例如，以下 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"
          }
        }
      ]
    }
  ]
}

ChipList

条状标签列表。

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

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

适用于 Google Chat 应用，但不适用于 Google Workspace 插件。