此页面由 Cloud Translation API 翻译。

Package google.apps.card.v1

索引

Action（消息）
Action.ActionParameter（消息）
Action.Interaction（枚举）
Action.LoadIndicator（枚举）
BorderStyle（消息）
BorderStyle.BorderType（枚举）
Button（消息）
Button.Type（枚举）
ButtonList（消息）
Card（消息）
Card.CardAction（消息）
Card.CardFixedFooter（消息）
Card.CardHeader（消息）
Card.DisplayStyle（枚举）
Card.DividerStyle（枚举）
Card.NestedWidget（消息）
Card.Section（消息）
Carousel（消息）
Carousel.CarouselCard（消息）
Chip（消息）
ChipList（消息）
ChipList.Layout（枚举）
CollapseControl（消息）
Columns（消息）
Columns.Column（消息）
Columns.Column.HorizontalSizeStyle（枚举）
Columns.Column.VerticalAlignment（枚举）
Columns.Column.Widgets（消息）
DateTimePicker（消息）
DateTimePicker.DateTimePickerType（枚举）
DecoratedText（消息）
DecoratedText.SwitchControl（消息）
DecoratedText.SwitchControl.ControlType（枚举）
Divider（消息）
Grid（消息）
Grid.GridItem（消息）
Grid.GridItem.GridItemLayout（枚举）
Icon（消息）
Image（消息）
ImageComponent（消息）
ImageCropStyle（消息）
ImageCropStyle.ImageCropType（枚举）
MaterialIcon（消息）
OnClick（消息）
OpenLink（消息）
OpenLink.OnClose（枚举）
OpenLink.OpenAs（枚举）
OverflowMenu（消息）
OverflowMenu.OverflowMenuItem（消息）
SelectionInput（消息）
SelectionInput.PlatformDataSource（消息）
SelectionInput.PlatformDataSource.CommonDataSource（枚举）
SelectionInput.SelectionItem（消息）
SelectionInput.SelectionType（枚举）
Suggestions（消息）
Suggestions.SuggestionItem（消息）
TextInput（消息）
TextInput.Type（枚举）
TextParagraph（消息）
TextParagraph.TextSyntax（枚举）
Validation（消息）
Validation.InputType（枚举）
Widget（消息）
Widget.HorizontalAlignment（枚举）
Widget.ImageType（枚举）
Widget.VerticalAlignment（枚举）

操作

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

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

字段
`function`	`string` 当包含元素被点击或以其他方式激活时调用的自定义函数。如需查看使用示例，请参阅读取表单数据。
`parameters[]`	`ActionParameter` 操作参数列表。
`load_indicator`	`LoadIndicator` 指定在调用操作时操作显示的加载指示器。
`persist_values`	`bool` 指明表单值在操作后是否会保留。默认值为 `false`。如果值为 `true`，则在触发操作后，表单值会保留。如需允许用户在操作处理期间进行更改，请将 `LoadIndicator` 设置为 `NONE`。对于聊天应用中的卡片消息，您还必须将操作的 `ResponseType` 设置为 `UPDATE_MESSAGE`，并使用包含该操作的卡片中的同一 `card_id`。如果值为 `false`，则在触发操作时清除表单值。为防止用户在处理操作期间进行更改，请将 `LoadIndicator` 设置为 `SPINNER`。
`interaction`	`Interaction` 可选。打开对话框时必须提供。在用户互动（例如用户点击卡片消息中的按钮）时应执行的操作。如果未指定，应用会像往常一样执行 `action`（例如打开链接或运行函数）来做出响应。通过指定 `interaction`，应用可以以特殊的互动方式做出响应。例如，通过将 `interaction` 设置为 `OPEN_DIALOG`，应用可以打开一个对话框。如果指定此标志，则不会显示加载指示器。如果为插件指定了此属性，则整个卡片都会被剥离，并且客户端中不会显示任何内容。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。
`required_widgets[]`	`string` 可选。使用此操作需要哪些 widget 的名称来填充此列表，以便进行有效提交。如果此处列出的 widget 在调用此操作时没有值，则会中止表单提交。适用于 Google Chat 应用和 Google Workspace 插件。
`all_widgets_are_required`	`bool` 可选。如果为 true，则此操作需要所有 widget。适用于 Google Chat 应用和 Google Workspace 插件。

ActionParameter

调用操作方法时要提供的字符串形参列表。例如，假设有三个延后按钮：立即延后、延后一天或延后到下周。您可以使用 action method = snooze()，并在字符串参数列表中传递延迟提醒类型和延迟提醒时间。

如需了解详情，请参阅 CommonEventObject。

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

字段

字段
`key`	`string` 操作脚本的参数名称。
`value`	`string` 参数的值。

key

string

操作脚本的参数名称。

value

string

参数的值。

互动

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

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

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

通过指定 interaction，应用可以以特殊的互动方式做出响应。例如，通过将 interaction 设置为 OPEN_DIALOG，应用可以打开一个对话框。

如果指定此标志，则不会显示加载指示器。如果为插件指定了此属性，则整个卡片都会被剥离，并且客户端中不会显示任何内容。

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

枚举

INTERACTION_UNSPECIFIED 默认值。action 会照常执行。

枚举
`INTERACTION_UNSPECIFIED`	默认值。`action` 会照常执行。
`OPEN_DIALOG`	打开一个对话框，这是一个基于卡片的窗口界面，供 Chat 应用与用户互动。仅受聊天应用支持，用于响应卡片消息上的按钮点击。如果为插件指定了此属性，则整个卡片都会被剥离，并且客户端中不会显示任何内容。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

OPEN_DIALOG

打开一个对话框，这是一个基于卡片的窗口界面，供 Chat 应用与用户互动。

仅受聊天应用支持，用于响应卡片消息上的按钮点击。如果为插件指定了此属性，则整个卡片都会被剥离，并且客户端中不会显示任何内容。

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

LoadIndicator

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

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

枚举
`SPINNER`	显示微调框，以指示内容正在加载。
`NONE`	不显示任何内容。

BorderStyle

卡片或 widget 边框的样式选项，包括边框类型和颜色。

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

字段

字段
`type`	`BorderType` 边框类型。
`stroke_color`	`Color` 当类型为 `BORDER_TYPE_STROKE` 时要使用的颜色。如需设置描边颜色，请为 `red`、`green` 和 `blue` 字段指定值。该值必须是介于 0 到 1 之间的浮点数，具体取决于 RGB 颜色值，其中 `0` (0/255) 表示没有颜色，`1` (255/255) 表示颜色强度最大。例如，以下代码会将颜色设置为红色，且强度最高： `"color": { "red": 1, "green": 0, "blue": 0, }` `alpha` 字段不适用于笔画颜色。如果指定，系统会忽略此字段。
`corner_radius`	`int32` 边框的圆角半径。

type

BorderType

边框类型。

stroke_color

Color

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

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

例如，以下代码会将颜色设置为红色，且强度最高：

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

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

corner_radius

int32

边框的圆角半径。

BorderType

表示应用于 widget 的边框类型。

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

枚举
`BORDER_TYPE_UNSPECIFIED`	请勿使用。未指定。
`NO_BORDER`	无边框。
`STROKE`	默认值。Outline。

按钮

用户可以点击的文本、图标或文本和图标按钮。如需查看 Google Chat 应用中的示例，请参阅添加按钮。

如需将图片设为可点击的按钮，请指定 Image（而非 ImageComponent），并设置 onClick 操作。

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

字段
`text`	`string` 按钮内显示的文字。
`icon`	`Icon` 按钮内显示的图标。如果同时设置了 `icon` 和 `text`，则图标会显示在文字前面。
`color`	`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` 字段不适用于按钮颜色。如果指定，系统会忽略此字段。
`on_click`	`OnClick` 必需。用户点击按钮时要执行的操作，例如打开超链接或运行自定义函数。
`disabled`	`bool` 如果值为 `true`，则按钮会以非活动状态显示，并且不会响应用户操作。
`alt_text`	`string` 用于辅助功能的替代文字。设置描述性文本，让用户了解按钮的作用。例如，如果某个按钮会打开一个超链接，您可能会写：“打开一个新的浏览器标签页，并前往 https://developers.google.com/workspace/chat" 处的 Google Chat 开发者文档”。
`type`	`Type` 可选。按钮的类型。如果未设置，按钮类型默认为 `OUTLINED`。如果设置了 `color` 字段，则按钮类型会被强制设置为 `FILLED`，并且系统会忽略为此字段设置的任何值。

类型

可选。按钮的类型。如果设置了 color 字段，则强制将 type 设置为 FILLED。

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

枚举
`TYPE_UNSPECIFIED`	请勿使用。未指定。
`OUTLINED`	轮廓按钮属于中强调度按钮。它们通常包含重要的操作，但不是 Chat 应用或插件中的主要操作。
`FILLED`	填充按钮的容器具有纯色。它具有最强的视觉冲击力，建议用于 Chat 应用或插件中的重要操作和主要操作。
`FILLED_TONAL`	填充色调按钮是填充按钮和轮廓按钮之间的中间替代方案。在低优先级按钮需要比轮廓按钮略高的强调度的情境下，它们非常有用。
`BORDERLESS`	按钮在默认状态下没有不可见的容器。它通常用于优先级最低的操作，尤其是在呈现多个选项时。

ButtonList

水平布局的按钮列表。如需查看 Google Chat 应用中的示例，请参阅添加按钮。

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

字段

字段
`buttons[]`	`Button` 按钮数组。

buttons[]

Button

按钮数组。

卡片

在 Google Chat 消息或 Google Workspace 插件中显示的卡片界面。

卡片支持已定义的布局、按钮等互动式界面元素以及图片等富媒体。使用卡片呈现详细信息、从用户那里收集信息，并引导用户采取下一步行动。

使用卡片构建器设计和预览卡片。

打开卡片构建器

如需了解如何构建卡片，请参阅以下文档：

对于 Google Chat 应用，请参阅设计卡片或对话框的组件。
对于 Google Workspace 插件，请参阅基于卡片的界面。

注意：每张卡片最多可添加 100 个 widget。超出此限制的任何 widget 都会被忽略。此限制适用于 Google Chat 应用中的卡片消息和对话框，以及 Google Workspace 插件中的卡片。

示例：Google Chat 应用的卡片消息

名片示例

如需在 Google Chat 中创建示例卡片消息，请使用以下 JSON：

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}

字段
`header`	`CardHeader` 卡片的标题。标题通常包含一张前导图片和一个标题。标题始终显示在卡片的顶部。
`sections[]`	`Section` 包含 widget 的集合。每个部分都有自己的可选标题。各部分之间用分隔线隔开。如需查看 Google Chat 应用中的示例，请参阅定义卡片的一部分。
`section_divider_style`	`DividerStyle` 标题、部分和页脚之间的分隔线样式。
`card_actions[]`	`CardAction` 卡片的操作。操作会添加到卡片的工具栏菜单中。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。例如，以下 JSON 会构建一个包含 `Settings` 和 `Send Feedback` 选项的卡片操作菜单： `"card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ]`
`name`	`string` 卡片的名称。在卡片导航中用作卡片标识符。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。
`fixed_footer`	`CardFixedFooter` 此卡片底部显示的固定页脚。在未指定 `primaryButton` 或 `secondaryButton` 的情况下设置 `fixedFooter` 会导致错误。对于 Chat 应用，您可以在对话框中使用固定页脚，但不能在卡片消息中使用。适用于 Google Chat 应用和 Google Workspace 插件。
`display_style`	`DisplayStyle` 在 Google Workspace 插件中，设置 `peekCardHeader` 的显示属性。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。
`peek_card_header`	`CardHeader` 显示情境化内容时，预览卡片标题会充当占位符，以便用户在首页卡片和情境化卡片之间向前导航。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

CardAction

卡片操作是指与卡片关联的操作。例如，账单卡片可能包含“删除账单”“通过电子邮件发送账单”或“在浏览器中打开账单”等操作。

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

字段

字段
`action_label`	`string` 显示为操作菜单项的标签。
`on_click`	`OnClick` 相应待办项的 `onClick` 操作。

action_label

string

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

on_click

OnClick

相应待办项的 onClick 操作。

CardFixedFooter

显示在卡片底部的持久性（粘性）页脚。

在未指定 primaryButton 或 secondaryButton 的情况下设置 fixedFooter 会导致错误。

对于 Chat 应用，您可以在对话框中使用固定页脚，但不能在卡片消息中使用。如需查看 Google Chat 应用中的示例，请参阅添加持久性页脚。

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

字段

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

primary_button

Button

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

secondary_button

Button

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

CardHeader

表示卡片标题。如需查看 Google Chat 应用中的示例，请参阅添加标题。

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

字段
`title`	`string` 必需。卡片标题的名称。标题的高度是固定的：如果同时指定了标题和副标题，则每个标题各占一行。如果仅指定了标题，则标题会占据两行。
`subtitle`	`string` 卡片标题的副标题。如果指定，则显示在 `title` 下方的单独一行中。
`image_type`	`ImageType` 用于剪裁图片的形状。适用于 Google Chat 应用和 Google Workspace 插件。
`image_url`	`string` 卡片标题中图片的 HTTPS 网址。
`image_alt_text`	`string` 此图片的替代文本，用于实现无障碍功能。

DisplayStyle

在 Google Workspace 插件中，用于确定卡片的显示方式。

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

枚举
`DISPLAY_STYLE_UNSPECIFIED`	请勿使用。未指定。
`PEEK`	卡片的标题显示在边栏底部，部分遮盖了堆栈中当前的顶部卡片。点击标题会将卡片弹出到卡片堆栈中。如果卡片没有标题，则系统会改用生成的标题。
`REPLACE`	默认值。该卡片通过替换卡片堆栈中顶部卡片的视图来显示。

DividerStyle

卡片的分隔线样式。目前仅用于卡片部分之间的分隔线。

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

枚举
`DIVIDER_STYLE_UNSPECIFIED`	请勿使用。未指定。
`SOLID_DIVIDER`	默认选项。渲染实线分隔线。
`NO_DIVIDER`	如果设置了该属性，则不会渲染分隔线。此样式会从布局中完全移除分隔线。结果相当于根本不添加分隔线。

NestedWidget

可在包含布局（例如 CarouselCard）中显示的 widget 的列表。

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

字段
联合字段 `data`。 `data` 只能是下列其中一项：
`text_paragraph`	`TextParagraph` 文本段落 widget。
`button_list`	`ButtonList` 一个按钮列表 widget。
`image`	`Image` 图片 widget。

部分

一个部分包含一组按指定顺序垂直呈现的 widget。

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

字段
`header`	`string` 显示在部分顶部的文字。支持简单的 HTML 格式文本。如需详细了解如何设置文本格式，请参阅 Google Chat 应用中的文本格式和 Google Workspace 加载项中的文本格式。
`widgets[]`	`Widget` 相应部分中的所有 widget。必须包含至少一个 widget。
`collapsible`	`bool` 指示相应部分是否可收起。可收起的部分会隐藏部分或全部 widget，但用户可以点击显示更多来展开该部分，从而显示隐藏的 widget。用户可以点击减少显示，再次隐藏这些微件。如需确定哪些 widget 已隐藏，请指定 `uncollapsibleWidgetsCount`。
`uncollapsible_widgets_count`	`int32` 即使在部分收起时仍保持可见的不可收起 widget 的数量。例如，如果某个部分包含 5 个 widget，且 `uncollapsibleWidgetsCount` 设置为 `2`，则系统始终会显示前两个 widget，并默认收起后三个 widget。只有当 `collapsible` 为 `true` 时，系统才会考虑 `uncollapsibleWidgetsCount`。
`collapse_control`	`CollapseControl` 可选。定义部分的展开和收起按钮。仅当相应部分可折叠时，系统才会显示此按钮。如果未设置此字段，则使用默认按钮。

轮播界面

轮播界面（也称为滑块）会以幻灯片的形式轮流显示 widget 列表，并提供用于前往上一个或下一个 widget 的按钮。

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

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

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

字段

字段
`carousel_cards[]`	`CarouselCard` 轮播界面中包含的卡片列表。

carousel_cards[]

CarouselCard

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

CarouselCard

可显示为轮播界面项的卡片。

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

字段

字段
`widgets[]`	`NestedWidget` 轮播卡片中显示的 widget 列表。微件会按其指定顺序显示。
`footer_widgets[]`	`NestedWidget` 轮播界面卡片底部显示的 widget 列表。微件会按其指定顺序显示。

widgets[]

NestedWidget

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

footer_widgets[]

NestedWidget

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

条状标签

用户可以点击的文字、图标或文字和图标组合的 chip。

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

字段
`icon`	`Icon` 图标图片。如果同时设置了 `icon` 和 `text`，则图标会显示在文字前面。
`label`	`string` 条状标签内显示的文字。
`on_click`	`OnClick` 可选。用户点击条状标签时要执行的操作，例如打开超链接或运行自定义函数。
`enabled (deprecated)`	`bool` 此项已弃用！相应 chip 是否处于有效状态并响应用户操作。默认为 `true`。已弃用。请改用 `disabled`。
`disabled`	`bool` 芯片是否处于非活动状态并忽略用户操作。默认为 `false`。
`alt_text`	`string` 用于辅助功能的替代文字。设置描述性文字，让用户了解相应条状标签的作用。例如，如果某个功能块会打开超链接，请写明：“打开新的浏览器标签页，并前往 https://developers.google.com/workspace/chat" 中的 Google Chat 开发者文档”。

ChipList

水平布局的条状标签列表，可以水平滚动或换行。

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

字段

字段
`layout`	`Layout` 指定的条状标签列表布局。
`chips[]`	`Chip` 一个芯片数组。

layout

Layout

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

chips[]

Chip

一个芯片数组。

布局

条状标签列表布局。

枚举
`LAYOUT_UNSPECIFIED`	请勿使用。未指定。
`WRAPPED`	默认值。如果横向空间不足，芯片列表会换行。
`HORIZONTAL_SCROLLABLE`	如果芯片无法放入可用空间，则会水平滚动。

CollapseControl

表示展开和收起控件。

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

字段

字段
`horizontal_alignment`	`HorizontalAlignment` 展开和收起按钮的水平对齐方式。
`expand_button`	`Button` 可选。定义一个可自定义的按钮以展开该部分。必须同时设置 expand_button 和 collapse_button 字段。仅设置一个字段集不会生效。如果未设置此字段，则使用默认按钮。
`collapse_button`	`Button` 可选。定义一个可自定义的按钮来收起相应部分。必须同时设置 expand_button 和 collapse_button 字段。仅设置一个字段集不会生效。如果未设置此字段，则使用默认按钮。

horizontal_alignment

HorizontalAlignment

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

expand_button

Button

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

collapse_button

Button

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

列

Columns widget 最多可在卡片或对话框中显示 2 列。您可以向每个列添加 widget；widget 会按指定的顺序显示。如需查看 Google Chat 应用中的示例，请参阅在列中显示卡片和对话框。

每列的高度由较高的列决定。例如，如果第一列比第二列高，则两列的高度都与第一列相同。由于每个列可以包含不同数量的 widget，因此您无法定义行或在列之间对齐 widget。

列会并排显示。您可以使用 HorizontalSizeStyle 字段自定义每列的宽度。如果用户的屏幕宽度过窄，第二列会换行到第一列下方：

在网页上，如果屏幕宽度小于或等于 480 像素，则第二列会换行。
在 iOS 设备上，如果屏幕宽度小于或等于 300 pt，则第二列会换行。
在 Android 设备上，如果屏幕宽度小于或等于 320 dp，则第二列会换行。

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

适用于 Google Chat 应用和 Google Workspace 插件。支持列的插件界面包括：

用户从电子邮件草稿中打开插件时显示的对话框。
用户在 Google 日历活动的添加附件菜单中打开插件时显示的对话框。

字段

字段
`column_items[]`	`Column` 列数组。您可以在卡片或对话框中添加最多 2 列。

column_items[]

Column

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

列

列。

Google Workspace 插件和 Chat 应用

字段
`horizontal_size_style`	`HorizontalSizeStyle` 指定列如何填充卡片的宽度。
`horizontal_alignment`	`HorizontalAlignment` 指定 widget 是与列的左侧、右侧还是中心对齐。
`vertical_alignment`	`VerticalAlignment` 指定 widget 是与列的顶部、底部还是中心对齐。
`widgets[]`	`Widgets` 列中包含的 widget 数组。微件会按其指定顺序显示。

HorizontalSizeStyle

指定列如何填充卡片的宽度。每列的宽度取决于 HorizontalSizeStyle 和列内 widget 的宽度。

Google Workspace 插件和 Chat 应用

枚举
`HORIZONTAL_SIZE_STYLE_UNSPECIFIED`	请勿使用。未指定。
`FILL_AVAILABLE_SPACE`	默认值。列会填充可用空间，最多可占卡片宽度的 70%。如果两个列都设置为 `FILL_AVAILABLE_SPACE`，则每个列会填充 50% 的空间。
`FILL_MINIMUM_SPACE`	列尽可能少地占用空间，且不超过卡片宽度的 30%。

VerticalAlignment

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

Google Workspace 插件和 Chat 应用

枚举
`VERTICAL_ALIGNMENT_UNSPECIFIED`	请勿使用。未指定。
`CENTER`	默认值。将 widget 与列的中心对齐。
`TOP`	将 widget 与列的顶部对齐。
`BOTTOM`	将 widget 与列的底部对齐。

微件

您可以包含在列中的受支持的 widget。

Google Workspace 插件和 Chat 应用

字段
联合字段 `data`。 `data` 只能是下列其中一项：
`text_paragraph`	`TextParagraph` `TextParagraph`微件。
`image`	`Image` `Image`微件。
`decorated_text`	`DecoratedText` `DecoratedText`微件。
`button_list`	`ButtonList` `ButtonList`微件。
`text_input`	`TextInput` `TextInput`微件。
`selection_input`	`SelectionInput` `SelectionInput`微件。
`date_time_picker`	`DateTimePicker` `DateTimePicker`微件。
`chip_list`	`ChipList` `ChipList`微件。

DateTimePicker

允许用户输入日期、时间或日期和时间。支持表单提交验证。当 Action.all_widgets_are_required 设置为 true 或在 Action.required_widgets 中指定此 widget 时，除非选择了一个值，否则提交操作会被阻止。如需查看 Google Chat 应用中的示例，请参阅让用户选择日期和时间。

用户可以输入文字，也可以使用选择器选择日期和时间。如果用户输入了无效的日期或时间，选择器会显示一条错误消息，提示用户正确输入信息。

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

字段
`name`	`string` 在表单输入事件中标识 `DateTimePicker` 的名称。如需详细了解如何处理表单输入，请参阅接收表单数据。
`label`	`string` 提示用户输入日期、时间或日期和时间的文本。例如，如果用户正在安排预约，请使用 `Appointment date` 或 `Appointment date and time` 等标签。
`type`	`DateTimePickerType` 相应 widget 是否支持输入日期、时间或日期和时间。
`value_ms_epoch`	`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`）。
`timezone_offset_date`	`int32` 表示与世界协调时间 (UTC) 的时区偏移量（以分钟为单位）的数字。如果设置了此属性，则 `value_ms_epoch` 会以指定的时区显示。如果未设置，该值默认为用户的时区设置。
`on_change_action`	`Action` 当用户在 `DateTimePicker` 界面中点击保存或清除时触发。

DateTimePickerType

DateTimePicker widget 中日期和时间的格式。确定用户能否输入日期、时间或同时输入日期和时间。

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

枚举
`DATE_AND_TIME`	用户输入日期和时间。
`DATE_ONLY`	用户输入日期。
`TIME_ONLY`	用户输入时间。

DecoratedText

一种用于显示文本的 widget，可选择性地添加装饰，例如文本上方或下方的标签、文本前面的图标、选择 widget 或文本后面的按钮。如需查看 Google Chat 应用中的示例，请参阅显示带有装饰性文字的文本。

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

字段
`icon (deprecated)`	`Icon` 此项已弃用！已弃用，取而代之的是 `startIcon`。
`start_icon`	`Icon` 显示在文本前面的图标。
`start_icon_vertical_alignment`	`VerticalAlignment` 可选。开始图标的垂直对齐方式。如果未设置，图标将垂直居中。开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，可抢先体验某些功能。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。
`top_label`	`string` 显示在 `text` 上方的文字。始终会截断。
`top_label_text`	`TextParagraph` `TextParagraph` 等效于 `top_label`。始终会截断。允许比 `top_label` 更复杂的格式设置。开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，可抢先体验某些功能。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。
`text`	`string` 必需。主要文字。支持简单格式。如需详细了解如何设置文本格式，请参阅 Google Chat 应用中的文本格式和 Google Workspace 加载项中的文本格式。
`content_text`	`TextParagraph` `TextParagraph` 等效于 `text`。允许比 `text` 更复杂的格式设置。开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，可抢先体验某些功能。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。
`wrap_text`	`bool` 文字环绕设置。如果值为 `true`，则文本会换行并显示在多行中。否则，文本会被截断。仅适用于 `text`，不适用于 `topLabel` 和 `bottomLabel`。
`bottom_label`	`string` 显示在 `text` 下方的文字。始终换行。
`bottom_label_text`	`TextParagraph` `TextParagraph` 等效于 `bottom_label`。始终换行。允许比 `bottom_label` 更复杂的格式设置。开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，可抢先体验某些功能。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。
`on_click`	`OnClick` 当用户点击 `topLabel` 或 `bottomLabel` 时，系统会触发此操作。
联合字段 `control`。`decoratedText` widget 中显示在文字右侧的按钮、开关、复选框或图片。`control` 只能是下列其中一项：
`button`	`Button` 用户可以点击以触发操作的按钮。
`switch_control`	`SwitchControl` 一种开关 widget，用户可以点击它来更改其状态并触发操作。
`end_icon`	`Icon` 显示在文字后面的图标。支持内置和自定义图标。

开关控制

decoratedText widget 内的切换开关或复选框。

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

仅在 decoratedText widget 中受支持。

字段
`name`	`string` 开关 widget 在表单输入事件中的标识名称。如需详细了解如何处理表单输入，请参阅接收表单数据。
`value`	`string` 用户输入的值，作为表单输入事件的一部分返回。如需详细了解如何处理表单输入，请参阅接收表单数据。
`selected`	`bool` 当 `true` 时，开关处于选中状态。
`on_change_action`	`Action` 开关状态发生变化时要执行的操作，例如要运行的函数。
`control_type`	`ControlType` 开关在界面中的显示方式。适用于 Google Chat 应用和 Google Workspace 插件。

ControlType

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

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

枚举
`SWITCH`	一种切换开关。
`CHECKBOX`	已弃用，取而代之的是 `CHECK_BOX`。
`CHECK_BOX`	复选框。

隔离设施

此类型没有字段。

以水平线形式显示 widget 之间的分隔线。如需查看 Google Chat 应用中的示例，请参阅在 widget 之间添加水平分隔线。

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

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

"divider": {}

网格

显示包含一系列项的网格。商品只能包含文字或图片。对于自适应列，或者要添加除文字或图片之外的其他内容，请使用 Columns。如需查看 Google Chat 应用中的示例，请参阅显示包含一系列商品的网格。

网格支持任意数量的列和项。行数由商品数除以列数得出。一个包含 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"
    }
  }
}

字段
`title`	`string` 网格标题中显示的文字。
`items[]`	`GridItem` 要在网格中显示的项。
`border_style`	`BorderStyle` 要应用于每个网格项的边框样式。
`column_count`	`int32` 网格中要显示的列数。如果未指定此字段，系统会使用默认值，而该默认值会因网格的显示位置（对话框与随播广告）而异。
`on_click`	`OnClick` 每个网格项都会重复使用此回调，但会将相应项的标识符和在项列表中的索引添加到回调的参数中。

GridItem

表示网格布局中的项。商品可以包含文字、图片，也可以同时包含文字和图片。

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

字段
`id`	`string` 相应网格项的用户指定标识符。此标识符在父网格的 `onClick` 回调参数中返回。
`image`	`ImageComponent` 网格项中显示的图片。
`title`	`string` 网格项的标题。
`subtitle`	`string` 网格项的副标题。
`layout`	`GridItemLayout` 用于网格项的布局。

GridItemLayout

表示网格项可用的各种布局选项。

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

枚举
`GRID_ITEM_LAYOUT_UNSPECIFIED`	请勿使用。未指定。
`TEXT_BELOW`	标题和副标题显示在网格项的图片下方。
`TEXT_ABOVE`	标题和副标题显示在网格项的图片上方。

图标

卡片上的 widget 中显示的图标。如需查看 Google Chat 应用中的示例，请参阅添加图标。

支持内置和自定义图标。

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

字段
`alt_text`	`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`。
`image_type`	`ImageType` 应用于图片的剪裁样式。在某些情况下，应用 `CIRCLE` 裁剪会导致绘制的图片比内置图标大。
联合字段 `icons`。卡片上的 widget 中显示的图标。`icons` 只能是下列其中一项：
`known_icon`	`string` 显示 Google Workspace 提供的内置图标之一。例如，如需显示飞机图标，请指定 `AIRPLANE`。对于公交车，请指定 `BUS`。如需查看受支持的图标的完整列表，请参阅内置图标。
`icon_url`	`string` 显示托管在 HTTPS 网址中的自定义图标。例如： `"iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"` 支持的文件类型包括 `.png` 和 `.jpg`。
`material_icon`	`MaterialIcon` 显示一个 Google Material 图标。例如，如需显示复选框图标，请使用 `"material_icon": { "name": "check_box" }` 适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

图片

由网址指定的图片，可以具有 onClick 操作。有关示例，请参阅添加图片。

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

字段

字段
`image_url`	`string` 托管图片的 HTTPS 网址。例如： `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`
`on_click`	`OnClick` 当用户点击图片时，点击操作会触发此操作。
`alt_text`	`string` 此图片的替代文本，用于实现无障碍功能。

image_url

string

托管图片的 HTTPS 网址。

例如：

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

on_click

OnClick

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

alt_text

string

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

ImageComponent

表示图片。

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

字段
`image_uri`	`string` 图片网址。
`alt_text`	`string` 图片的无障碍功能标签。
`crop_style`	`ImageCropStyle` 要应用于图片的剪裁样式。
`border_style`	`BorderStyle` 要应用于图片的边框样式。

ImageCropStyle

表示应用于图片的剪裁样式。

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

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

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

字段

字段
`type`	`ImageCropType` 裁剪类型。
`aspect_ratio`	`double` 如果剪裁类型为 `RECTANGLE_CUSTOM`，则使用此宽高比。例如，以下展示了如何应用 16:9 的宽高比： `cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 }`

type

ImageCropType

裁剪类型。

aspect_ratio

double

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

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

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

ImageCropType

表示应用于图片的剪裁样式。

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

枚举
`IMAGE_CROP_TYPE_UNSPECIFIED`	请勿使用。未指定。
`SQUARE`	默认值。应用方形裁剪。
`CIRCLE`	应用圆形裁剪。
`RECTANGLE_CUSTOM`	应用具有自定义宽高比的矩形剪裁。使用 `aspectRatio` 设置自定义宽高比。
`RECTANGLE_4_3`	应用 4:3 宽高比的矩形剪裁。

MaterialIcon

Google Material 图标，包含 2, 500 多个选项。

例如，如需显示具有自定义权重和等级的复选框图标，请编写以下代码：

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

字段
`name`	`string` Google Material 图标中定义的图标名称，例如 `check_box`。所有无效名称都会被舍弃并替换为空字符串，从而导致图标无法呈现。
`fill`	`bool` 图标是否呈现为填充状态。默认值为 false。如需预览不同的图标设置，请前往 Google 字体图标，然后调整自定义下的设置。
`weight`	`int32` 图标的描边粗细。您可以从 {100, 200, 300, 400, 500, 600, 700} 中选择。如果不存在，则默认值为 400。如果指定了任何其他值，则使用默认值。如需预览不同的图标设置，请前往 Google 字体图标，然后调整自定义下的设置。
`grade`	`int32` 粗细和等级会影响符号的粗细。与调整粗细相比，调整等级更加精细，对符号大小的影响也较小。请从 {-25, 0, 200} 中选择一个值。如果未提供，则默认值为 0。如果指定了任何其他值，则使用默认值。如需预览不同的图标设置，请前往 Google 字体图标，然后调整自定义下的设置。

OnClick

表示当用户点击卡片上的互动元素（例如按钮）时，如何做出响应。

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

字段
联合字段 `data`。 `data` 只能是下列其中一项：
`action`	`Action` 如果指定，则通过此 `onClick` 触发操作。
`open_link`	`OpenLink` 如果指定，此 `onClick` 会触发打开链接操作。
`open_dynamic_link_action`	`Action` 当操作需要打开链接时，插件会触发此操作。这与上面的 `open_link` 不同，因为此链接需要与服务器通信才能获取。因此，在打开链接操作响应返回之前，需要为 Web 客户端完成一些准备工作。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。
`card`	`Card` 点击后，系统会将新卡片推送到卡片堆栈（如果已指定）。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。
`overflow_menu`	`OverflowMenu` 如果指定，此 `onClick` 会打开溢出菜单。

OpenLink

表示打开超链接的 onClick 事件。

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

字段

字段
`url`	`string` 要打开的网址。
`open_as`	`OpenAs` 如何打开链接。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。
`on_close`	`OnClose` 客户端在打开链接后是忘记该链接，还是会一直观察该链接，直到窗口关闭。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。

url

string

要打开的网址。

open_as

OpenAs

如何打开链接。

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

on_close

OnClose

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

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

OnClose

当由 OnClick 操作打开的链接关闭时，客户端执行的操作。

具体实现取决于客户端平台的功能。例如，网络浏览器可能会在具有 OnClose 处理程序的弹出式窗口中打开链接。

如果同时设置了 OnOpen 和 OnClose 处理程序，但客户端平台无法同时支持这两个值，则以 OnClose 为准。

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

枚举

NOTHING 默认值。卡片未重新加载；没有任何反应。

枚举
`NOTHING`	默认值。卡片未重新加载；没有任何反应。
`RELOAD`	在子窗口关闭后重新加载卡片。如果与 `OpenAs.OVERLAY` 结合使用，子窗口会充当模态对话框，并且父卡会被屏蔽，直到子窗口关闭。

RELOAD

在子窗口关闭后重新加载卡片。

如果与 OpenAs.OVERLAY 结合使用，子窗口会充当模态对话框，并且父卡会被屏蔽，直到子窗口关闭。

OpenAs

当 OnClick 操作打开链接时，客户端可以将其作为全尺寸窗口（如果这是客户端使用的框架）或叠加层（例如弹出式窗口）打开。具体实现取决于客户端平台的功能，如果客户端不支持所选值，则可能会忽略该值。所有客户端都支持 FULL_SIZE。

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

枚举
`FULL_SIZE`	链接会以全尺寸窗口打开（如果客户端使用的是该框架）。
`OVERLAY`	链接会以叠加层的形式（例如弹出式窗口）打开。

OverflowMenu

一种用于显示弹出式菜单的 widget，其中包含用户可调用的一个或多个操作。例如，在卡片中显示非主要操作。当操作无法放入可用空间时，您可以使用此 widget。如需使用，请在支持此 widget 的 widget 的 OnClick 操作中指定此 widget。例如，在 Button 中。

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

字段

字段
`items[]`	`OverflowMenuItem` 必需。菜单选项列表。

items[]

OverflowMenuItem

必需。菜单选项列表。

OverflowMenuItem

用户可在溢出菜单中调用的选项。

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

字段
`start_icon`	`Icon` 显示在文本前面的图标。
`text`	`string` 必需。向用户标识或描述商品的文本。
`on_click`	`OnClick` 必需。选择菜单选项时调用的操作。此 `OnClick` 不得包含 `OverflowMenu`，任何指定的 `OverflowMenu` 都会被舍弃，并且菜单项会被停用。
`disabled`	`bool` 菜单选项是否已停用。默认值为 false。

SelectionInput

用于创建一个或多个可供用户选择的界面项的 widget。仅支持对 dropdown 和 multiselect 菜单进行表单提交验证。当 Action.all_widgets_are_required 设置为 true 或在 Action.required_widgets 中指定此 widget 时，除非选择了一个值，否则提交操作会被阻止。例如，下拉菜单或复选框。您可以使用此 widget 收集可预测或可枚举的数据。如需查看 Google Chat 应用中的示例，请参阅添加可选择的界面元素。

聊天应用可以处理用户选择或输入的商品的值。如需详细了解如何处理表单输入，请参阅接收表单数据。

如需从用户处收集未定义或抽象的数据，请使用 TextInput widget。

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

字段
`name`	`string` 必需。用于在表单输入事件中标识选择输入的名称。如需详细了解如何处理表单输入，请参阅接收表单数据。
`label`	`string` 界面中显示在选择输入字段上方的文本。指定有助于用户输入应用所需信息的文字。例如，如果用户从下拉菜单中选择工单的紧急程度，则标签可能是“紧急程度”或“选择紧急程度”。
`type`	`SelectionType` `SelectionInput` widget 中向用户显示的商品类型。选择类型支持不同类型的互动。例如，用户可以选择一个或多个复选框，但只能从下拉菜单中选择一个值。
`items[]`	`SelectionItem` 一个可选择项的数组。例如，单选按钮或复选框的数组。最多支持 100 个项目。
`on_change_action`	`Action` 如果指定了该属性，则在选择发生更改时提交表单。如果未指定，您必须指定一个单独的按钮来提交表单。如需详细了解如何处理表单输入，请参阅接收表单数据。
`multi_select_max_selected_items`	`int32` 对于多选菜单，用户可以选择的最大项数。最小值为 1 件商品。如果未指定，则默认为 3 项。
`multi_select_min_query_length`	`int32` 对于多选菜单，用户输入多少个文本字符后，菜单会返回建议的选择项。如果未设置，多选菜单将使用以下默认值：如果菜单使用 `SelectionInput` 项的静态数组，则默认为 0 个字符，并立即从数组中填充项。如果菜单使用动态数据源 (`multi_select_data_source`)，则默认在查询数据源以返回建议项之前使用 3 个字符。
联合字段 `multi_select_data_source`。对于多选菜单，一种可动态填充选择项的数据源。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。`multi_select_data_source` 只能是下列其中一项：
`external_data_source`	`Action` 外部数据源，例如关系型数据库。
`platform_data_source`	`PlatformDataSource` Google Workspace 中的数据源。

PlatformDataSource

对于使用多选菜单的 SelectionInput widget，数据源来自 Google Workspace。用于填充多选菜单中的项。

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

字段

字段
联合字段 `data_source`。数据源。`data_source` 只能是下列其中一项：
`common_data_source`	`CommonDataSource` 由所有 Google Workspace 应用共享的数据源，例如 Google Workspace 组织中的用户。
`host_app_data_source`	`HostAppDataSourceMarkup` Google Workspace 宿主应用（例如 Google Chat 中的聊天室）特有的数据源。此字段支持 Google API 客户端库，但在 Cloud 客户端库中不可用。如需了解详情，请参阅安装客户端库。

联合字段 data_source。数据源。data_source 只能是下列其中一项：

common_data_source

CommonDataSource

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

host_app_data_source

HostAppDataSourceMarkup

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

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

CommonDataSource

由所有 Google Workspace 应用共享的数据源。

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

枚举
`UNKNOWN`	默认值。请勿使用。
`USER`	Google Workspace 用户。用户只能查看和选择其 Google Workspace 组织中的用户。

SelectionItem

用户可在选择输入源（例如复选框或开关）中选择的项。最多支持 100 个项目。

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

字段
`text`	`string` 向用户标识或描述商品的文本。
`value`	`string` 与相应商品相关联的值。客户端应将此值用作表单输入值。如需详细了解如何处理表单输入，请参阅接收表单数据。
`selected`	`bool` 相应项是否默认处于选中状态。如果选择输入仅接受一个值（例如对于单选按钮或下拉菜单），则仅为一个项设置此字段。
`bottom_text`	`string` 对于多选菜单，显示在相应项的 `text` 字段下方的文本说明或标签。
联合字段 `start_icon`。对于多选菜单，显示在相应项的 `text` 字段旁边的图标的网址。支持 PNG 和 JPEG 文件。必须是 `HTTPS` 网址。例如 `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`。`start_icon` 只能是下列其中一项：
`start_icon_uri`	`string`

SelectionType

用户可选择的商品的格式。不同的选项支持不同类型的互动。例如，用户可以选择多个复选框，但只能从下拉菜单中选择一项。

每个选择输入源都支持一种选择类型。例如，不支持混合使用复选框和开关。

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

枚举
`CHECK_BOX`	一组复选框。用户可以选择一个或多个复选框。
`RADIO_BUTTON`	一组单选按钮。用户可以选择一个单选按钮。
`SWITCH`	一组开关。用户可以开启一个或多个开关。
`DROPDOWN`	一个下拉菜单。用户可以从菜单中选择一项。
`MULTI_SELECT`	包含文本框的菜单。用户可以输入文字并选择一项或多项内容。对于 Google Workspace 插件，您必须使用 `SelectionItem` 对象的静态数组来填充项。对于 Google Chat 应用，您还可以使用动态数据源填充项，并在用户在菜单中输入内容时自动建议项。例如，用户可以开始输入 Google Chat 聊天室的名称，然后 widget 会自动建议该聊天室。如需动态填充多选菜单的项，请使用以下类型的数据源之一： Google Workspace 数据：使用 Google Workspace 中的数据填充项目，例如 Google Workspace 用户或 Google Chat 聊天室。外部数据：内容来自 Google Workspace 外部的外部数据源。如需查看如何为 Chat 应用实现多选菜单的示例，请参阅添加多选菜单。适用于 Google Chat 应用和 Google Workspace 插件。

建议

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

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

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

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

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

字段

items[]

SuggestionItem

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

SuggestionItem

用户可在文本输入字段中输入的一个建议值。

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

字段

联合字段 content。

content 只能是下列其中一项：

text

string

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

TextInput

用户可以在其中输入文本的字段。支持建议和更改时操作。支持表单提交验证。当 Action.all_widgets_are_required 设置为 true 或在 Action.required_widgets 中指定此 widget 时，除非输入值，否则提交操作会被阻止。如需查看 Google Chat 应用中的示例，请参阅添加可供用户输入文本的字段。

在表单输入事件期间，聊天应用会接收并处理所输入文本的值。如需详细了解如何处理表单输入，请参阅接收表单数据。

当您需要从用户那里收集未定义或抽象数据时，请使用文本输入。如需从用户处收集已定义或已枚举的数据，请使用 SelectionInput widget。

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

字段
`name`	`string` 在表单输入事件中用于标识文本输入的名称。如需详细了解如何处理表单输入，请参阅接收表单数据。
`label`	`string` 界面中显示在文本输入字段上方的文字。指定有助于用户输入应用所需信息的文字。例如，如果您要询问某人的姓名，但特别需要对方的姓氏，请使用 `surname` 而不是 `name`。如果未指定 `hintText`，则必须提供此值。否则，为可选。
`hint_text`	`string` 显示在文本输入字段下方的文字，旨在通过提示用户输入特定值来帮助用户。此文本始终可见。如果未指定 `label`，则必须提供此值。否则，为可选。
`value`	`string` 用户输入的值，作为表单输入事件的一部分返回。如需详细了解如何处理表单输入，请参阅接收表单数据。
`type`	`Type` 文本输入字段在界面中的显示方式。例如，字段是单行还是多行。
`on_change_action`	`Action` 当文本输入字段发生更改时应执行的操作。例如，用户向字段中添加内容或删除文本。可采取的操作包括运行自定义函数或在 Google Chat 中打开对话框。
`initial_suggestions`	`Suggestions` 用户可以输入的建议值。当用户点击文本输入字段时，系统会显示这些值。随着用户输入，建议值会动态过滤，以匹配用户输入的内容。例如，编程语言的文本输入字段可能会建议 Java、JavaScript、Python 和 C++。当用户开始输入 `Jav` 时，建议列表会过滤为仅显示 `Java` 和 `JavaScript`。建议值有助于引导用户输入您的应用可以理解的值。在提及 JavaScript 时，有些用户可能会输入 `javascript`，而另一些用户可能会输入 `java script`。建议 `JavaScript` 可以标准化用户与应用的互动方式。如果指定了 `TextInput.type`，则该值始终为 `SINGLE_LINE`，即使将其设置为 `MULTIPLE_LINE` 也是如此。适用于 Google Chat 应用和 Google Workspace 插件。
`auto_complete_action`	`Action` 可选。指定当文本输入字段向与之互动的用户提供建议时要采取的操作。如果未指定，建议由 `initialSuggestions` 设置，并由客户端处理。如果指定了此属性，应用会执行此处指定的操作，例如运行自定义函数。适用于 Google Workspace 加购项，但不适用于 Google Chat 应用。
`validation`	`Validation` 指定此文本字段所需的输入格式验证。适用于 Google Chat 应用和 Google Workspace 插件。
`placeholder_text`	`string` 当文本输入字段为空时，该字段中显示的文本。使用此文本提示用户输入值。例如 `Enter a number from 0 to 100`。适用于 Google Chat 应用，但不适用于 Google Workspace 加购项。

类型

文本输入字段在界面中的显示方式。例如，是单行输入字段还是多行输入字段。如果指定了 initialSuggestions，则 type 始终为 SINGLE_LINE，即使将其设置为 MULTIPLE_LINE 也是如此。

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

枚举
`SINGLE_LINE`	文本输入字段的高度固定为一行。
`MULTIPLE_LINE`	文本输入字段的高度固定为多行。

TextParagraph

支持格式设置的一段文字。如需查看 Google Chat 应用中的示例，请参阅添加一段格式化文本。如需详细了解如何设置文本格式，请参阅 Google Chat 应用中的文本格式和 Google Workspace 加载项中的文本格式。

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

字段

text

string

widget 中显示的文本。

max_lines

int32

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

默认值为 0，在这种情况下，系统会显示所有上下文。系统会忽略负值。

text_syntax

TextSyntax

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

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

TextSyntax

用于设置文本格式的语法。

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

枚举
`TEXT_SYNTAX_UNSPECIFIED`	如果未指定，则文本会呈现为 HTML。
`HTML`	文本以 HTML 形式呈现。这是默认值。
`MARKDOWN`	文本以 Markdown 格式呈现。

验证

表示验证所附加 widget 所需的数据。

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

字段

character_limit

int32

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

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

input_type

InputType

指定输入微件的类型。

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

InputType

输入 widget 的类型。

枚举
`INPUT_TYPE_UNSPECIFIED`	未指定类型。请勿使用。
`TEXT`	接受所有字符的常规文本。
`INTEGER`	一个整数值。
`FLOAT`	浮点值。
`EMAIL`	电子邮件地址。
`EMOJI_PICKER`	从系统提供的表情符号选择器中选择的表情符号。

字段
`horizontal_alignment`	`HorizontalAlignment` 指定 widget 是与列的左侧、右侧还是中心对齐。
联合字段 `data`。一个 widget 只能包含以下项之一。您可以使用多个 widget 字段来显示更多项目。`data` 只能是下列其中一项：
`text_paragraph`	`TextParagraph` 显示文本段落。支持简单的 HTML 格式文本。如需详细了解如何设置文本格式，请参阅 Google Chat 应用中的文本格式和 Google Workspace 加载项中的文本格式。例如，以下 JSON 会创建粗体文本： `"textParagraph": { "text": " <b>bold text</b>" }`
`image`	`Image` 显示图片。例如，以下 JSON 会创建带有替代文本的图片： `"image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" }`
`decorated_text`	`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" } }`
`button_list`	`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" } } } ] }`
`text_input`	`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" } ] } }`
`selection_input`	`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 } ] }`
`date_time_picker`	`DateTimePicker` 显示一个微件，让用户输入日期、时间或日期和时间。例如，以下 JSON 会创建一个用于安排预约的日期时间选择器： `"dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": 796435200000 }`
`divider`	`Divider` 在 widget 之间显示水平线分隔线。例如，以下 JSON 会创建一个分隔线： `"divider": { }`
`grid`	`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`	`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`	`Carousel` 轮播界面包含一组嵌套的 widget。例如，以下是包含两个文本段落的轮播界面的 JSON 表示法。 `{ "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] }`
`chip_list`	`ChipList` 一个 chip 列表。例如，以下 JSON 会创建两个功能块。第一个是文字 chip，第二个是用于打开链接的图标 chip： `"chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }`

HorizontalAlignment

枚举
`HORIZONTAL_ALIGNMENT_UNSPECIFIED`	请勿使用。未指定。
`START`	默认值。将 widget 与列的起始位置对齐。对于从左到右的布局，则与左侧对齐。对于从右到左的布局，则靠右对齐。
`CENTER`	将 widget 与列的中心对齐。
`END`	将 widget 对齐到列的末尾位置。对于从左向右的布局，将 widget 对齐到右侧。对于从右到左的布局，将 widget 对齐到左侧。

ImageType

枚举
`SQUARE`	默认值。为图片应用方形遮罩。例如，4x3 的图片会变为 3x3。
`CIRCLE`	为图片应用圆形蒙版。例如，4x3 的图片会变成直径为 3 的圆形。

VerticalAlignment

枚举
`VERTICAL_ALIGNMENT_UNSPECIFIED`	未指定类型。请勿使用。
`TOP`	与顶部位置对齐。
`MIDDLE`	与中间位置对齐。
`BOTTOM`	对齐到底部位置。

Package google.apps.card.v1 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

索引

操作

ActionParameter

互动

LoadIndicator

BorderStyle

BorderType

按钮

类型

ButtonList

卡片

CardAction

CardFixedFooter

CardHeader

DisplayStyle

DividerStyle

NestedWidget

部分

轮播界面

CarouselCard

条状标签

ChipList

布局

CollapseControl

列

列

HorizontalSizeStyle

VerticalAlignment

微件

DateTimePicker

DateTimePickerType

DecoratedText

开关控制

ControlType

隔离设施

网格

GridItem

GridItemLayout

图标

图片

ImageComponent

ImageCropStyle

ImageCropType

MaterialIcon

OnClick

OpenLink

OnClose

OpenAs

OverflowMenu

OverflowMenuItem

SelectionInput

PlatformDataSource

CommonDataSource

SelectionItem

SelectionType

建议

SuggestionItem

TextInput

类型

TextParagraph

TextSyntax

验证

InputType

微件

HorizontalAlignment

ImageType

VerticalAlignment

Package google.apps.card.v1