Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

卡片的标题。标头通常包含前置图片和标题。标题始终显示在卡片的顶部。

object (Section)

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

enum (DividerStyle)

部分之间的分隔线样式。

object (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 应用。

object (CardFixedFooter)

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

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

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

enum (DisplayStyle)

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

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

object (CardHeader)

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

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

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

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

string

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

enum (ImageType)

用于剪裁图片的形状。

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

string

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

string

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

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer
}

string

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

object (Widget)

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

boolean

指示此部分是否可收起。

可收起部分会隐藏部分或所有 widget，但用户可以通过点击 Show more 来展开该部分以显示隐藏的 widget。用户可以通过点击收起再次隐藏这些 widget。

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

integer

即使某个部分处于收起状态也仍然可见的不可折叠 widget 的数量。

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

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

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

object (TextParagraph)

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

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

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

object (Image)

显示图片。

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

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

object (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"
  }
}

object (ButtonList)

按钮列表。

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

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

object (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"
      }
    ]
  }
}

object (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
    }
  ]
}

object (DateTimePicker)

显示可让用户输入日期、时间或日期和时间的微件。

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

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

object (Divider)

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

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

"divider": {
}

object (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"
    }
  }
}

object (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"
          }
        }
      ]
    }
  ]
}

{
  "text": string
}

string

显示在 widget 中的文本。

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

托管映像的 HTTPS 网址。

例如：

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

object (OnClick)

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

string

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

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  }
  // End of list of possible types for union field data.
}

object (Action)

如果已指定，则此 onClick 会触发操作。

object (OpenLink)

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

object (Action)

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

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

object (Card)

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

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

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction)
}

string

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

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

object (ActionParameter)

操作参数列表。

enum (LoadIndicator)

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

boolean

指示表单值在操作完成后是否保留。默认值为 false。

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

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

enum (Interaction)

可选。打开对话框时必填。

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

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

通过指定 interaction，应用能以特殊的交互方式做出响应。例如，通过将 interaction 设置为 OPEN_DIALOG，应用可以打开对话框。指定后，系统不会显示加载指示器。如果为某个插件指定该属性，系统会删除整个卡片，且客户端中不会显示任何内容。

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

{
  "key": string,
  "value": string
}

string

操作脚本的参数名称。

string

参数的值。

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

要打开的网址。

enum (OpenAs)

如何打开链接。

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

enum (OnClose)

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

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

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

object (Icon)

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

object (Icon)

显示在文本前面的图标。

string

显示在 text 上方的文本。一律截断。

string

必需。主要文本。

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

boolean

自动换行设置。如果为 true，文本会换行并显示多行。否则，文本将被截断。

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

string

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

object (OnClick)

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

object (Button)

一个按钮，用户点击该按钮即可触发相应操作。

object (SwitchControl)

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

object (Icon)

显示在文本之后的图标。

支持内置和自定义图标。

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

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。

enum (ImageType)

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

string

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

例如，如需显示飞机图标，请指定 AIRPLANE。如果是总线，请指定 BUS。

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

string

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

例如：

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

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

object (MaterialIcon)

显示一个 Google Material 图标。

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

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

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

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

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

boolean

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

如需预览不同的图标设置，请前往 Google Font Icons，并调整自定义下的设置。

integer

图标的描边粗细。请从 {100, 200, 300, 400, 500, 600, 700} 中进行选择。如果没有，则默认值为 400。如果指定了任何其他值，系统将使用默认值。

如需预览不同的图标设置，请前往 Google Font Icons，并调整自定义下的设置。

integer

粗细和等级会影响符号的粗细。对成绩的调整比调整权重更精细，并且对符号的大小影响较小。从 {-25, 0, 200} 中选择。如果没有，则默认值为 0。如果指定了任何其他值，系统将使用默认值。

如需预览不同的图标设置，请前往 Google Font Icons，并调整自定义下的设置。

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string
}

string

按钮内显示的文字。

object (Icon)

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

object (Color)

如果已设置，该按钮将填充纯色背景颜色，并且字体颜色会发生变化以与背景颜色形成对比。例如，设置蓝色背景可能会生成白色文本。

如果未设置，图片背景将为白色，字体颜色为蓝色。

对于红色、绿色和蓝色，每个字段的值都是 float 数字，您可以通过以下两种方式之一表示：0 到 255 之间的数字除以 255 (153/255)，或介于 0 到 1 之间的值 (0.6)。0 表示缺少某种颜色，1 或 255/255 表示该颜色在 RGB 刻度上全部存在。

（可选）设置 alpha，以便使用以下等式设置透明度：

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

对于 alpha，值 1 对应于纯色，值 0 对应于完全透明的颜色。

例如，以下颜色表示半透明的红色：

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

object (OnClick)

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

boolean

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

string

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

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

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

颜色中的红色量，以 [0, 1] 之间的值表示。

number

颜色中的绿色量，以 [0, 1] 之间的值表示。

number

颜色中的蓝色量，以 [0, 1] 之间的值表示。

number

此颜色在像素中的应用比例。也就是说，最终的像素颜色由以下公式定义：

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

也就是说，值为 1.0 表示纯色，而值为 0.0 表示完全透明的颜色。它会使用封装容器消息，而非简单的浮动标量，以便区分默认值和未设置的值。如果省略此参数，则此颜色对象会呈现为纯色（就好像 alpha 值已被明确指定为 1.0 一样）。

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

在表单输入事件中标识切换 widget 的名称。

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

string

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

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

boolean

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

object (Action)

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

enum (ControlType)

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

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

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

按钮数组。

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "placeholderText": string
}

string

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

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

string

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

指定有助于用户输入应用所需信息的文本。例如，如果您要询问某人的姓名，但特别需要其姓氏，请写入 surname 而非 name。

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

string

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

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

string

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

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

enum (Type)

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

object (Action)

文本输入字段发生变化时的处理方式。例如，用户向字段添加内容或删除文本。

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

object (Suggestions)

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

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

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

指定后，TextInput.type 始终为 SINGLE_LINE，即使将其设置为 MULTIPLE_LINE 也是如此。

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

object (Action)

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

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

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

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

string

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

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

Action

Navigation

推送或更新显示的卡片。

Card

卡片堆叠会将一张卡片推送到卡片堆叠。

Card

卡片堆栈会使用新卡片更新顶部的卡片，并保留已填充的表单字段值。对于非等效字段，该值将被丢弃。

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

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

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

文本输入字段中建议输入的值。这与用户自己输入的内容相同。

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

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

integer

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

integer

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

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

object (Action)

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

object (PlatformDataSource)

来自 Google Workspace 的数据源。

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

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

string

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

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

boolean

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

string

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

string

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

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

Google Workspace 主机应用独有的数据源，例如 Google Chat 中的聊天室。

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

来自 Google Chat 的数据源。

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

用户所属的 Google Chat 聊天室。

{
  "defaultToCurrentSpace": boolean
}

boolean

如果设置为 true，则多选菜单会默认将当前的 Google Chat 聊天室选作一项。

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  }
}

string

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

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

string

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

enum (DateTimePickerType)

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

string (int64 format)

微件中显示的默认值（以毫秒为单位，从 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）。

integer

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

object (Action)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

网格标题中显示的文本。

object (GridItem)

要在网格中显示的项。

object (BorderStyle)

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

integer

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

object (OnClick)

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

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

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

object (ImageComponent)

网格项中显示的图片。

string

网格项的标题。

string

网格项的副标题。

enum (GridItemLayout)

用于网格项的布局。

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

图片网址。

string

图片的无障碍功能标签。

object (ImageCropStyle)

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

object (BorderStyle)

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

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

剪裁类型。

number

剪裁类型为 RECTANGLE_CUSTOM 时要使用的宽高比。

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

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

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

边框类型。

object (Color)

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

integer

边框的角半径。

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

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

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph widget。

object (Image)

Image widget。

object (DecoratedText)

DecoratedText widget。

object (ButtonList)

ButtonList widget。

object (TextInput)

TextInput widget。

object (SelectionInput)

SelectionInput widget。

object (DateTimePicker)

DateTimePicker widget。

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (OnClick)

此操作项的 onClick 操作。

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

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

object (Button)

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