Cards v1

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}

object (CardHeader)

The header of the card. A header usually contains a title and an image.

object (Section)

Sections are separated by a line divider.

object (CardAction)

The actions of this card.

string

Name of the card.

{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}

string

The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines.

string

The subtitle of the card header.

enum (ImageStyle)

The image's type (for example, square border or circular border).

string

The URL of the image in the card header.

{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}

string

The header of the section. Formatted text is supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

object (WidgetMarkup)

A section must contain at least one widget.

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

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}

object (Button)

A list of buttons. Buttons is also oneof data and only one of these fields should be set.

object (TextParagraph)

Display a text paragraph in this widget.

object (Image)

Display an image in this widget.

object (KeyValue)

Display a key value item in this widget.

{
  "text": string
}

string

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

string

The URL of the image.

object (OnClick)

The onclick action.

number

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

{

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

object (FormAction)

A form action is triggered by this onclick action if specified.

object (OpenLink)

This onclick action triggers an open link action if specified.

{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}

string

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

object (ActionParameter)

List of action parameters.

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

string

The name of the parameter for the action script.

string

The value of the parameter.

{
  "url": string
}

string

The URL to open.

{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

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

string

The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

string

The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

boolean

If the content should be multiline.

string

The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

object (OnClick)

The onclick action. Only the top label, bottom label, and content region are clickable.

enum (Icon)

An enum value that's replaced by the Chat API with the corresponding icon image.

string

The icon specified by a URL.

object (Button)

A button that can be clicked to trigger an action.

{

  // Union field type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}

object (TextButton)

A button with text and onclick action.

object (ImageButton)

A button with image and onclick action.

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

string

The text of the button.

object (OnClick)

The onclick action of the button.

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

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

object (OnClick)

The onclick action.

string

The name of this imageButton that's used for accessibility. Default value is provided if this name isn't specified.

enum (Icon)

The icon specified by an enum that indices to an icon provided by Chat API.

string

The icon specified by a URL.

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

string

The label used to be displayed in the action menu item.

object (OnClick)

The onclick action for this action item.