ButtonList

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

object ( Button )

An array of buttons.

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

string

The text displayed inside the button.

object ( Icon )

The icon image. If both icon and text are set, then the icon appears before the text.

object ( Color )

If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background will likely result in white text.

If unset, the image background is white and the font color is blue.

For red, green and blue, the value of each field is a float number that can be expressed in either of two ways: as a number between 0 and 255 divided by 255 (153/255) or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale.

Optionally set alpha, which sets a level of transparency using this equation:

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

For alpha, a value of 1 corresponds with a solid color, and a value of 0 corresponds with a completely transparent color.

For example, the following color represents a half transparent red:

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

object ( OnClick )

Required. The action to perform when the button is clicked, such as opening a hyperlink or running a custom function.

boolean

If true , the button is displayed in an inactive state and doesn't respond to user actions.

string

The alternative text used for accessibility.

Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat" .

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

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

string

Optional. A description of the icon used for accessibility. If unspecified, the default value "Button" is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, A user's account portrait , or Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat .

If the icon is set in a Button , the altText appears as helper text when the user hovers over the button. However, if the button also sets text , the icon's altText is ignored.

enum ( ImageType )

The crop style applied to the image. In some cases, applying a CIRCLE crop causes the image to be drawn larger than a standard icon.

string

Display one of the standard icons provided by Google Workspace.

For example, to display an airplane icon, specify AIRPLANE . For a bus, specify BUS .

For a full list of supported icons, see standard icons .

string

Display a custom icon hosted at an HTTPS URL.

For example:

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

Supported file types include .png and .jpg .

{

  // 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 )

If specified, an action is triggered by this onClick .

object ( OpenLink )

If specified, this onClick triggers an open link action.

object ( Action )

An add-on triggers this action when the action needs to open a link. This differs from the openLink above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back.

object ( Card )

A new card is pushed to the card stack after clicking if specified.

Supported by Google Workspace Add-ons, but not Chat apps.

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

string

A custom function to invoke when the containing element is clicked or othrwise activated.

For example usage, see Create interactive cards .

object ( ActionParameter )

List of action parameters.

enum ( LoadIndicator )

Specifies the loading indicator that the action displays while making the call to the action.

boolean

Indicates whether form values persist after the action. The default value is false .

If true , form values remain after the action is triggered. When using LoadIndicator.NONE for actions, persistValues = true is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response.

If false , the form values are cleared when the action is triggered. When persistValues is set to false , it is strongly recommended that the card use LoadIndicator.SPINNER for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed.

Not supported by Chat apps.

enum ( Interaction )

Optional. Required when opening a dialog .

What to do in response to an interaction with a user, such as a user clicking button on a card message.

If unspecified, the app responds by executing an action - like opening a link or running a function - as normal.

By specifying an interaction , the app can respond in special interactive ways. For example, by setting interaction to OPEN_DIALOG , the app can open a dialog .

When specified, a loading indicator is not shown.

Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

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

string

The name of the parameter for the action script.

string

The value of the parameter.

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

string

The URL to open.

enum ( OpenAs )

How to open a link. Not supported by Chat apps.

enum ( OnClose )

Whether the client forgets about a link after opening it, or observes it until the window closes. Not supported by Chat apps.