卡片
卡片是可以包含文本和图片等界面 widget 的界面元素。
JSON 表示法 |
---|
{ "header": { object ( |
字段 | |
---|---|
header
|
卡片的标题。标头通常包含标题和图片。 |
sections[]
|
各个部分之间用换行符分隔。 |
cardActions[]
|
此卡片的操作。 |
name
|
卡的名称。 |
CardHeader
JSON 表示法 |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
字段 | |
---|---|
title
|
必须指定标题。标题具有固定的高度:如果同时指定了标题和副标题,则每行会占用一行。如果仅指定标题,则该标题会占用两行。 |
subtitle
|
卡片标题的副标题。 |
imageStyle
|
图片的类型(例如方形边框或圆形边框)。 |
imageUrl
|
卡片标题中图片的网址。 |
ImageStyle
枚举 | |
---|---|
IMAGE_STYLE_UNSPECIFIED
|
|
IMAGE
|
方形边框。 |
AVATAR
|
圆形边框。 |
章节
一个部分包含一系列按照指定顺序(垂直)呈现的 widget。在所有平台上,卡片的固定宽度都较窄,因此目前不需要布局属性(例如浮动)。
JSON 表示法 |
---|
{
"header": string,
"widgets": [
{
object (
|
字段 | |
---|---|
header
|
部分的标题。支持设置了格式的文字。如需详细了解如何设置文本格式,请参阅设置 Google Chat 应用中的文本格式和设置 Google Workspace 插件中的文本格式。 |
widgets[]
|
一个版块必须至少包含一个 widget。 |
WidgetMarkup
widget 是呈现文本和图片的界面元素。
JSON 表示法 |
---|
{ "buttons": [ { object ( |
字段 | |
---|---|
buttons[]
|
按钮列表。按钮也是 |
联合字段 data 。WidgetMarkup 只能包含以下项之一。您可以使用多个 WidgetMarkup 字段显示更多项。
data 只能是下列其中一项:
|
|
textParagraph
|
在此 widget 中显示一个文本段落。 |
image
|
在此 widget 中显示一张图片。 |
keyValue
|
在此 widget 中显示键值对项。 |
TextParagraph
一段文本。支持设置了格式的文字。如需详细了解如何设置文本格式,请参阅设置 Google Chat 应用中的文本格式和设置 Google Workspace 插件中的文本格式。
JSON 表示法 |
---|
{ "text": string } |
字段 | |
---|---|
text
|
|
图片
通过网址指定并且可以执行 onclick
操作的图片。
JSON 表示法 |
---|
{
"imageUrl": string,
"onClick": {
object (
|
字段 | |
---|---|
imageUrl
|
图片的网址。 |
onClick
|
|
aspectRatio
|
此图片的宽高比(宽度和高度)。通过此字段,您可以在等待图片加载期间为图片预留合适的高度。它不会替换图片的内置宽高比。如果未设置,服务器将通过预提取图片来填充它。 |
OnClick
onclick
操作(例如,打开链接)。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段
|
|
action
|
此 |
openLink
|
此 |
FormAction
表单操作描述了提交表单时的行为。例如,您可以调用 Apps 脚本来处理表单。
JSON 表示法 |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
字段 | |
---|---|
actionMethodName
|
方法名称用于标识表单的哪个部分触发了表单提交。此信息会作为卡片点击事件的一部分回显给 Chat 应用。您可以针对多个触发常见行为的元素使用相同的方法名称。 |
parameters[]
|
操作参数列表。 |
ActionParameter
调用操作方法时提供的字符串参数列表。例如,假设有三个延后按钮:立即延后、延后一天、下周延后。您可以使用 action method = snooze()
,在字符串参数列表中传递延后类型和延后时间。
JSON 表示法 |
---|
{ "key": string, "value": string } |
字段 | |
---|---|
key
|
操作脚本的参数名称。 |
value
|
参数的值。 |
OpenLink
一个用于打开新窗口的链接。
JSON 表示法 |
---|
{ "url": string } |
字段 | |
---|---|
url
|
要打开的网址。 |
KeyValue
界面元素包含一个键(标签)和一个值(内容)。此元素还可以包含一些操作,如 onclick
按钮。
JSON 表示法 |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
字段 | |
---|---|
topLabel
|
顶部标签的文本。支持设置了格式的文字。如需详细了解如何设置文本格式,请参阅设置 Google Chat 应用中的文本格式和设置 Google Workspace 插件中的文本格式。 |
content
|
内容的文本。支持格式化文本,且始终必需。如需详细了解如何设置文本格式,请参阅设置 Google Chat 应用中的文本格式和设置 Google Workspace 插件中的文本格式。 |
contentMultiline
|
内容是否为多行。 |
bottomLabel
|
底部标签的文本。支持设置了格式的文字。如需详细了解如何设置文本格式,请参阅设置 Google Chat 应用中的文本格式和设置 Google Workspace 插件中的文本格式。 |
onClick
|
|
联合字段 icons 。必须至少定义图标 top_label 和 bottom_label 中的一个。
icons 只能是下列其中一项:
|
|
icon
|
由 Chat API 替换成相应图标图片的枚举值。 |
iconUrl
|
由网址指定的图标。 |
联合字段 control 。一个控制 widget。您可以设置 button 或 switch_widget ,但不能同时设置两者。
control 只能是下列其中一项:
|
|
button
|
可点击以触发操作的按钮。 |
图标
支持的图标集。
枚举 | |
---|---|
ICON_UNSPECIFIED
|
|
AIRPLANE
|
|
BOOKMARK
|
|
BUS
|
|
CAR
|
|
CLOCK
|
|
CONFIRMATION_NUMBER_ICON
|
|
DOLLAR
|
|
DESCRIPTION
|
|
EMAIL
|
|
EVENT_PERFORMER
|
|
EVENT_SEAT
|
|
FLIGHT_ARRIVAL
|
|
FLIGHT_DEPARTURE
|
|
HOTEL
|
|
HOTEL_ROOM_TYPE
|
|
INVITE
|
|
MAP_PIN
|
|
MEMBERSHIP
|
|
MULTIPLE_PEOPLE
|
|
OFFER
|
|
PERSON
|
|
PHONE
|
|
RESTAURANT_ICON
|
|
SHOPPING_CART
|
|
STAR
|
|
STORE
|
|
TICKET
|
|
TRAIN
|
|
VIDEO_CAMERA
|
|
VIDEO_PLAY
|
按钮
按钮。可以是文字按钮或图片按钮。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段
|
|
textButton
|
包含文本和 |
imageButton
|
包含图片和 |
TextButton
包含文本和 onclick
操作的按钮。
JSON 表示法 |
---|
{
"text": string,
"onClick": {
object (
|
字段 | |
---|---|
text
|
按钮的文字。 |
onClick
|
按钮的 |
ImageButton
包含 onclick
操作的图片按钮。
JSON 表示法 |
---|
{ "onClick": { object ( |
字段 | |
---|---|
onClick
|
|
name
|
用于无障碍功能的此 |
联合字段 icons 。图标可以通过 Icon
enum 或网址指定。
icons 只能是下列其中一项:
|
|
icon
|
由 |
iconUrl
|
由网址指定的图标。 |
CardAction
卡片操作是指与卡片相关联的操作。对于账单卡片,典型操作包括删除账单、通过电子邮件发送账单或在浏览器中打开账单。
Google Chat 应用不支持。
JSON 表示法 |
---|
{
"actionLabel": string,
"onClick": {
object (
|
字段 | |
---|---|
actionLabel
|
用于在操作菜单项中显示的标签。 |
onClick
|
此操作项的 on-click 操作。 |