Button

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

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

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

JSON 表示法
{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}
字段
text

string

按钮内显示的文本。

icon

object (Icon)

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

color

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

object (OnClick)

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

disabled

boolean

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

altText

string

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

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

type

enum (Type)

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

类型

可选。按钮的 type。如果设置了 color 字段,则 type 会强制设置为 FILLED。

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

枚举
TYPE_UNSPECIFIED 请勿使用。未指定。
OUTLINED 描边按钮是中度强调按钮。其中通常包含重要但并非 Chat 应用或插件中的主要操作。
FILLED 填充按钮有一个纯色容器。它具有最强的视觉冲击力,建议用于 Chat 应用或插件中的重要和主要操作。
FILLED_TONAL 填充色调按钮是填充按钮和轮廓按钮之间的折中选择。在优先级较低的按钮需要比轮廓按钮稍多一些强调的情况下,它们非常有用。
BORDERLESS 按钮在默认状态下没有不可见的容器。它通常用于优先级最低的操作,尤其是在提供多个选项时。