Package google.apps.card.v1

Index

Action

An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server.

Fields
function

string

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

For example usage, see Create interactive cards.
parameters[]

ActionParameter

List of action parameters.
loadIndicator

LoadIndicator

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

bool

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

If true, form values remain after the action is triggered. To let the user make changes while the action is being processed, set LoadIndicator to NONE. For card messages in Chat apps, you must also set the action's ResponseType to UPDATE_MESSAGE and use the same card_id from the card that contained the action.

If false, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set LoadIndicator to SPINNER.
interaction

Interaction

Optional. Required when opening a dialog.

What to do in response to an interaction with a user, such as a user clicking a button in 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 isn't 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.

ActionParameter

List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters.

To learn more, see CommonEventObject.

Fields
key

string

The name of the parameter for the action script.
value

string

The value of the parameter.

Interaction

Optional. Required when opening a dialog.

What to do in response to an interaction with a user, such as a user clicking a button in 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 isn't 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.

Enums
INTERACTION_UNSPECIFIED Default value. The action executes as normal.
OPEN_DIALOG

Opens a dialog, a windowed, card-based interface that Chat apps use to interact with users.

Only supported by Chat apps in response to button-clicks on card messages.

Not supported by Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

LoadIndicator

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

Enums
SPINNER Displays a spinner to indicate that content is loading.
NONE Nothing is displayed.

BorderStyle

The style options for the border of a card or widget, including the border type and color.

Fields
type

BorderType

The border type.
strokeColor

Color

The colors to use when the type is BORDER_TYPE_STROKE.
cornerRadius

int32

The corner radius for the border.

BorderType

Represents the border types applied to widgets.

Enums
BORDER_TYPE_UNSPECIFIED Don't use. Unspecified.
NO_BORDER Default value. No border.
STROKE Outline.

Button

A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see Button list.

To make an image a clickable button, specify an Image (not an ImageComponent) and set an onClick action.

Fields
text

string

The text displayed inside the button.
icon

Icon

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

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 likely results 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 you can express 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
}
onClick

OnClick

Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
disabled

bool

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

string

The alternative text that's 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".

ButtonList

A list of buttons layed out horizontally. For an example in Google Chat apps, see Button list.

Fields
buttons[]

Button

An array of buttons.

Card

A card interface displayed in a Google Chat message or Google Workspace Add-on.

Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step.

To learn how to build cards, see the following documentation:

Example: Card message for a Google Chat app

Example contact card

To create the sample card message in Google Chat, use the following JSON:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
          "title": "Sasha",
          "subtitle": "Software Engineer",
          "imageUrl":
          "https://developers.google.com/chat/images/quickstart-app-avatar.png",
          "imageType": "CIRCLE",
          "imageAltText": "Avatar for Sasha",
        },
        "sections": [
          {
            "header": "Contact Info",
            "collapsible": true,
            "uncollapsibleWidgetsCount": 1,
            "widgets": [
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "EMAIL",
                  },
                  "text": "sasha@example.com",
                }
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PERSON",
                  },
                  "text": "<font color=\"#80e27e\">Online</font>",
                },
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PHONE",
                  },
                  "text": "+1 (555) 555-1234",
                }
              },
              {
                "buttonList": {
                  "buttons": [
                    {
                      "text": "Share",
                      "onClick": {
                        "openLink": {
                          "url": "https://example.com/share",
                        }
                      }
                    },
                    {
                      "text": "Edit",
                      "onClick": {
                        "action": {
                          "function": "goToView",
                          "parameters": [
                            {
                              "key": "viewType",
                              "value": "EDIT",
                            }
                          ],
                        }
                      }
                    },
                  ],
                }
              },
            ],
          },
        ],
      },
    }
  ],
}
Fields
header

CardHeader

The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
sections[]

Section

Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see Card section.
sectionDividerStyle

DividerStyle

The divider style between sections.
cardActions[]

CardAction

The card's actions. Actions are added to the card's toolbar menu.

Because Chat app cards have no toolbar, cardActions[] isn't supported by Chat apps.

For example, the following JSON constructs a card action menu with Settings and Send Feedback options:

"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"
      }
    }
  }
]
name

string

Name of the card. Used as a card identifier in card navigation.

Because Chat apps don't support card navigation, they ignore this field.
fixedFooter

CardFixedFooter

The fixed footer shown at the bottom of this card.

Setting fixedFooter without specifying a primaryButton or a secondaryButton causes an error.

Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in dialogs, but not card messages.
displayStyle

DisplayStyle

In Google Workspace add-ons, sets the display properties of the peekCardHeader.

Not supported by Chat apps.
peekCardHeader

CardHeader

When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards.

Not supported by Chat apps.

CardAction

A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser.

Not supported by Chat apps.

Fields
actionLabel

string

The label that displays as the action menu item.
onClick

OnClick

The onClick action for this action item.

CardFixedFooter

A persistent (sticky) footer that that appears at the bottom of the card. For an example in Google Chat apps, see Card footer.

Setting fixedFooter without specifying a primaryButton or a secondaryButton causes an error.

Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in dialogs, but not card messages.

Fields
primaryButton

Button

The primary button of the fixed footer. The button must be a text button with text and color set.
secondaryButton

Button

The secondary button of the fixed footer. The button must be a text button with text and color set. If secondaryButton is set, you must also set primaryButton.

CardHeader

Represents a card header. For an example in Google Chat apps, see Card header.

Fields
title

string

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

string

The subtitle of the card header. If specified, appears on its own line below the title.
imageType

ImageType

The shape used to crop the image.
imageUrl

string

The HTTPS URL of the image in the card header.
imageAltText

string

The alternative text of this image that's used for accessibility.

DisplayStyle

In Google Workspace Add-ons, determines how a card is displayed.

Not supported by Chat apps.

Enums
DISPLAY_STYLE_UNSPECIFIED Don't use. Unspecified.
PEEK The header of the card appears at the bottom of the sidebar, partially covering the current top card of the stack. Clicking the header pops the card into the card stack. If the card has no header, a generated header is used instead.
REPLACE Default value. The card is shown by replacing the view of the top card in the card stack.

DividerStyle

The divider style of a card. Currently only used for dividers betweens card sections.

Enums
DIVIDER_STYLE_UNSPECIFIED Don't use. Unspecified.
SOLID_DIVIDER Default option. Render a solid divider between sections.
NO_DIVIDER If set, no divider is rendered between sections.

Section

A section contains a collection of widgets that are rendered vertically in the order that they're specified.

Fields
header

string

Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.
widgets[]

Widget

All the widgets in the section. Must contain at least one widget.
collapsible

bool

Indicates whether this section is collapsible.

Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking Show more. Users can hide the widgets again by clicking Show less.

To determine which widgets are hidden, specify uncollapsibleWidgetsCount.
uncollapsibleWidgetsCount

int32

The number of uncollapsible widgets which remain visible even when a section is collapsed.

For example, when a section contains five widgets and the uncollapsibleWidgetsCount is set to 2, the first two widgets are always shown and the last three are collapsed by default. The uncollapsibleWidgetsCount is taken into account only when collapsible is true.

Columns

The Columns widget displays up to 2 columns in a card message or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see Columns.

The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns.

Columns are displayed side-by-side. You can customize the width of each column using the HorizontalSizeStyle field. If the user's screen width is too narrow, the second column wraps below the first:

  • On web, the second column wraps if the screen width is less than or equal to 480 pixels.
  • On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt.
  • On Android devices, the second column wraps if the screen width is less than or equal to 320 dp.

To include more than 2 columns, or to use rows, use the Grid widget.

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

Fields
columnItems[]

Column

An array of columns. You can include up to 2 columns in a card or dialog.

Column

A column.

Fields
horizontalSizeStyle

HorizontalSizeStyle

Specifies how a column fills the width of the card.
horizontalAlignment

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.
verticalAlignment

VerticalAlignment

Specifies whether widgets align to the top, bottom, or center of a column.
widgets[]

Widgets

An array of widgets included in a column. Widgets appear in the order that they are specified.

HorizontalSizeStyle

Specifies how a column fills the width of the card. The width of each column depends on both the HorizontalSizeStyle and the width of the widgets within the column.

Enums
HORIZONTAL_SIZE_STYLE_UNSPECIFIED Don't use. Unspecified.
FILL_AVAILABLE_SPACE Default value. Column fills the available space, up to 70% of the card's width. If both columns are set to FILL_AVAILABLE_SPACE, each column fills 50% of the space.
FILL_MINIMUM_SPACE Column fills the least amount of space possible and no more than 30% of the card's width.

VerticalAlignment

Specifies whether widgets align to the top, bottom, or center of a column.

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED Don't use. Unspecified.
CENTER Default value. Aligns widgets to the center of a column.
TOP Aligns widgets to the top of a column.
BOTTOM Aligns widgets to the bottom of a column.

Widgets

The supported widgets that you can include in a column.

Fields

Union field data.

data can be only one of the following:
textParagraph

TextParagraph

TextParagraph widget.
image

Image

Image widget.
decoratedText

DecoratedText

DecoratedText widget.
buttonList

ButtonList

ButtonList widget.
textInput

TextInput

TextInput widget.
selectionInput

SelectionInput

SelectionInput widget.
dateTimePicker

DateTimePicker

DateTimePicker widget.

DateTimePicker

Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see Date time picker.

Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly.

Fields
name

string

The name by which the DateTimePicker is identified in a form input event.

For details about working with form inputs, see Receive form data.
label

string

The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as Appointment date or Appointment date and time.
type

DateTimePickerType

Whether the widget supports inputting a date, a time, or the date and time.
valueMsEpoch

int64

The default value displayed in the widget, in milliseconds since Unix epoch time.

Specify the value based on the type of picker (DateTimePickerType):

  • DATE_AND_TIME: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use 1672574400000.
  • DATE_ONLY: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use 1672531200000.
  • TIME_ONLY: a time in UTC. For example, to represent 12:00 PM, use 43200000 (or 12 * 60 * 60 * 1000).
timezoneOffsetDate

int32

The number representing the time zone offset from UTC, in minutes. If set, the value_ms_epoch is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
onChangeAction

Action

Triggered when the user clicks Save or Clear from the DateTimePicker interface.

DateTimePickerType

The format for the date and time in the DateTimePicker widget. Determines whether users can input a date, a time, or both a date and time.

Enums
DATE_AND_TIME Users input a date and time.
DATE_ONLY Users input a date.
TIME_ONLY Users input a time.

DecoratedText

A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see Decorated text.

Fields
icon
(deprecated)

Icon

Deprecated in favor of startIcon.
startIcon

Icon

The icon displayed in front of the text.
topLabel

string

The text that appears above text. Always truncates.
text

string

Required. The primary text.

Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.
wrapText

bool

The wrap text setting. If true, the text wraps and displays on multiple lines. Otherwise, the text is truncated.

Only applies to text, not topLabel and bottomLabel.
bottomLabel

string

The text that appears below text. Always wraps.
onClick

OnClick

This action is triggered when users click topLabel or bottomLabel.
Union field control. A button, switch, checkbox, or image that appears to the right-hand side of text in the decoratedText widget. control can be only one of the following:
button

Button

A button that a user can click to trigger an action.
switchControl

SwitchControl

A switch widget that a user can click to change its state and trigger an action.
endIcon

Icon

An icon displayed after the text.

Supports built-in and custom icons.

SwitchControl

Either a toggle-style switch or a checkbox inside a decoratedText widget.

Only supported in the decoratedText widget.

Fields
name

string

The name by which the switch widget is identified in a form input event.

For details about working with form inputs, see Receive form data.
value

string

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data.
selected

bool

When true, the switch is selected.
onChangeAction

Action

The action to perform when the switch state is changed, such as what function to run.
controlType

ControlType

How the switch appears in the user interface.

ControlType

How the switch appears in the user interface.

Enums
SWITCH A toggle-style switch.
CHECKBOX Deprecated in favor of CHECK_BOX.
CHECK_BOX A checkbox.

Divider

This type has no fields.

Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see Divider.

For example, the following JSON creates a divider:

"divider": {}

GetAutocompletionResponse

A response to getting autocomplete container, which includes elements necessary for showing auto complete items for text field. For example:

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
Fields
autoComplete

Suggestions
schema

string

This is a no-op schema field that might be present in the markup for syntax checking.

Grid

Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use Columns. For an example in Google Chat apps, see Grid.

A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.

For example, the following JSON creates a 2 column grid with a single item:

"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"
    }
  }
}
Fields
title

string

The text that displays in the grid header.
items[]

GridItem

The items to display in the grid.
borderStyle

BorderStyle

The border style to apply to each grid item.
columnCount

int32

The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
onClick

OnClick

This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.

GridItem

Represents an item in a grid layout. Items can contain text, an image, or both text and an image.

Fields
id

string

A user-specified identifier for this grid item. This identifier is returned in the parent grid's onClick callback parameters.
image

ImageComponent

The image that displays in the grid item.
title

string

The grid item's title.
subtitle

string

The grid item's subtitle.
layout

GridItemLayout

The layout to use for the grid item.

GridItemLayout

Represents the various layout options available for a grid item.

Enums
GRID_ITEM_LAYOUT_UNSPECIFIED Don't use. Unspecified.
TEXT_BELOW The title and subtitle are shown below the grid item's image.
TEXT_ABOVE The title and subtitle are shown above the grid item's image.

Icon

An icon displayed in a widget on a card. For an example in Google Chat apps, see Icon.

Supports built-in and custom icons.

Fields
altText

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.
imageType

ImageType

The crop style applied to the image. In some cases, applying a CIRCLE crop causes the image to be drawn larger than a built-in icon.
Union field icons. The icon displayed in the widget on the card. icons can be only one of the following:
knownIcon

string

Display one of the built-in 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 built-in icons.
iconUrl

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.

Image

An image that is specified by a URL and can have an onClick action. For an example, see Image.

Fields
imageUrl

string

The HTTPS URL that hosts the image.

For example:

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

OnClick

When a user clicks the image, the click triggers this action.
altText

string

The alternative text of this image that's used for accessibility.

ImageComponent

Represents an image.

Fields
imageUri

string

The image URL.
altText

string

The accessibility label for the image.
cropStyle

ImageCropStyle

The crop style to apply to the image.
borderStyle

BorderStyle

The border style to apply to the image.

ImageCropStyle

Represents the crop style applied to an image.

For example, here's how to apply a 16:9 aspect ratio:

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

ImageCropType

The crop type.
aspectRatio

double

The aspect ratio to use if the crop type is RECTANGLE_CUSTOM.

For example, here's how to apply a 16:9 aspect ratio:

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

ImageCropType

Represents the crop style applied to an image.

Enums
IMAGE_CROP_TYPE_UNSPECIFIED Don't use. Unspecified.
SQUARE Default value. Applies a square crop.
CIRCLE Applies a circular crop.
RECTANGLE_CUSTOM Applies a rectangular crop with a custom aspect ratio. Set the custom aspect ratio with aspectRatio.
RECTANGLE_4_3 Applies a rectangular crop with a 4:3 aspect ratio.

LinkPreview

Card action that previews a third-party link by displaying a card and smart chip. To learn more, see Preview links with smart chips.

For example, the following JSON returns a unique title for the link preview and its smart chip, and a preview card with a header and text description:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

The example returns the following link preview:

Example link preview

Fields
previewCard

Card

A card that displays information about a link from a third-party service.
title

string

The title that displays in the smart chip for the link preview. If unset, the smart chip displays the header of the preview_card.
linkPreviewTitle

string

The title that displays in the link preview. If unset, the link preview displays the header of the preview_card.

Card action that manipulates the card stack. For example:

1) Add a new card to the stack (navigate forward).

 navigations : {
    pushCard : CARD
  }

2) Update the card on top of the stack (in place update).

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Go back one step without updating.

  navigations : {
    popCard : true,
  }

4) Go back multiple steps and update that card.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Go back multiple steps to a defined CARD_NAME.

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Go back to the root and update that card.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Pop to the specified card and pop that one as well.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Replace the top card with a new card.

  navigations : {
    updateCard : CARD
  }
Fields

Union field navigate_action.

navigate_action can be only one of the following:
popToRoot

bool

Card stack pops all cards off except the root card.
pop

bool

Card stack pops one card off.
popToCard

string

Card stack pops all cards above the specified card with given card name.
pushCard

Card

Card stack pushes a card onto the card stack.
updateCard

Card

Card stack updates the top card with a new card and preserves filled form fields values. For a non-equivalent field, the value is dropped.

Notification

Card action that displays a notification in the host app.

Fields
text

string

Plain text to display for the notification, without HTML tags.

OnClick

Represents how to respond when users click an interactive element on a card, such as a button.

Fields

Union field data.

data can be only one of the following:
action

Action

If specified, an action is triggered by this onClick.
openDynamicLinkAction

Action

An add-on triggers this action when the action needs to open a link. This differs from the open_link 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. Supported by Google Workspace Add-ons, but not Google Chat apps.
card

Card

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

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

OnClose

What the client does when a link opened by an OnClick action is closed.

Implementation depends on client platform capabilities. For example, a web browser might open a link in a pop-up window with an OnClose handler.

If both OnOpen and OnClose handlers are set, and the client platform can't support both values, OnClose takes precedence.

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

Enums
NOTHING Default value. The card doesn't reload; nothing happens.
RELOAD

Reloads the card after the child window closes.

If used in conjunction with OpenAs.OVERLAY, the child window acts as a modal dialog and the parent card is blocked until the child window closes.

OpenAs

When an OnClick action opens a link, then the client can either open it as a full-size window (if that's the frame used by the client), or an overlay (such as a pop-up). The implementation depends on the client platform capabilities, and the value selected might be ignored if the client doesn't support it. FULL_SIZE is supported by all clients.

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

Enums
FULL_SIZE The link opens as a full-size window (if that's the frame used by the client).
OVERLAY The link opens as an overlay, such as a pop-up.

RenderActions

A set of render instructions that tells a card to perform an action and/or tells the add-on host app to perform an app-specific action.

Fields
action

Action
hostAppAction

HostAppActionMarkup

Actions handled by individual host apps.
schema

string

This is a no-op schema field that might be present in the markup for syntax checking.

Action

Fields
navigations[]

Navigation

Push, pop, or update displayed cards.
notification

Notification

Display a notification to the end-user.
linkPreview

LinkPreview

Display a link preview to the end user.

SelectionInput

A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see Selection input.

Chat apps can process the value of items that users select or input. For details about working with form inputs, see Receive form data.

To collect undefined or abstract data from users, use the TextInput widget.

Fields
name

string

The name that identifies the selection input in a form input event.

For details about working with form inputs, see Receive form data.
label

string

The text that appears above the selection input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
type

SelectionType

The type of items that are displayed to users in a SelectionInput widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
items[]

SelectionItem

An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
onChangeAction

Action

If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form.

For details about working with form inputs, see Receive form data.
multiSelectMaxSelectedItems

int32

For multi-select menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, set to 3 items.

multiSelectMinQueryLength

int32

For multi-select menus, the number of text characters that a user inputs before the Chat app queries autocomplete and displays suggested items on the card.

If unspecified, set to 0 characters for static data sources and 3 characters for external data sources.

Union field multi_select_data_source. Chat apps only. For a multi-select menu, the data source type. multi_select_data_source can be only one of the following:
externalDataSource

Action

An external data source, such as a relational data base.

platformDataSource

PlatformDataSource

A data source from a Google Workspace host application.

PlatformDataSource

Chat apps only. For a SelectionInput widget that uses a multi-select menu, the data from a Google Workspace host application. Used to populate the items in the multi-select menu.

Fields
Union field data_source. The data source. data_source can be only one of the following:
commonDataSource

CommonDataSource

For a SelectionInput widget that uses a multi-select menu, a data source shared by all Google Workspace host applications, such as users in a Google Workspace organization.

hostAppDataSource

HostAppDataSourceMarkup

A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages.

CommonDataSource

Chat apps only. A data source shared by all Google Workspace host applications.

Enums
UNKNOWN Default value. Don't use.
USER

A list of users provided by the Google Workspace host application. For example, to source users from Google Chat, use the resource name of the user.

Format: users/{user}

SelectionItem

An item that users can select in a selection input, such as a checkbox or switch.

Fields
text

string

The text that identifies or describes the item to users.
value

string

The value associated with this item. The client should use this as a form input value.

For details about working with form inputs, see Receive form data.
selected

bool

Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
startIconUri

string

For multi-select menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files. Must be an HTTPS URL. For example, https://developers.google.com/chat/images/quickstart-app-avatar.png.

bottomText

string

For multi-select menus, a text description or label that's displayed below the item's text field.

SelectionType

The format for the items that users can select. Different options support different types of interactions. For example, users can select multiple checkboxes, but can only select one item from a dropdown menu.

Each selection input supports one type of selection. Mixing checkboxes and switches, for example, isn't supported.

Enums
CHECK_BOX A set of checkboxes. Users can select one or more checkboxes.
RADIO_BUTTON A set of radio buttons. Users can select one radio button.
SWITCH A set of switches. Users can turn on one or more switches.
DROPDOWN A dropdown menu. Users can select one item from the menu.
MULTI_SELECT

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

A multi-select menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space.

To populate items for a multi-select menu, you can use one of the following types of data sources:

  • Static data: Items are specified as SelectionItem objects in the widget. Up to 100 items.
  • Google Workspace data: Items are populated using data from a Google Workspace application, such as Google Chat users or spaces.
  • External data: Items are populated from a dynamic external data source.

For examples of how to implement multi-select menus, see the SelectionInput widget page.

SubmitFormResponse

A response to a form submit other than getting an autocomplete container, which contains the actions the card should perform and/or the add-on host app should perform, and whether the card's state has changed. For example:

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
Fields
renderActions

RenderActions

A set of render instructions that tells the card to perform an action and/or tells the add-on host app to perform an app-specific action.
stateChanged

bool

Whether the state of the cards has changed and data in existing cards is stale.
schema

string

This is a no-op schema field that may be present in the markup for syntax checking.

Suggestions

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav, the list of suggestions filters to show Java and JavaScript.

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script. Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE.

Fields
items[]

SuggestionItem

A list of suggestions used for autocomplete recommendations in text input fields.

SuggestionItem

One suggested value that users can enter in a text input field.

Fields

Union field content.

content can be only one of the following:
text

string

The value of a suggested input to a text input field. This is equivalent to what users enter themselves.

TextInput

A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see Text input.

Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see Receive form data.

When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget.

Fields
name

string

The name by which the text input is identified in a form input event.

For details about working with form inputs, see Receive form data.
label

string

The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write surname instead of name.

Required if hintText is unspecified. Otherwise, optional.
hintText

string

Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible.

Required if label is unspecified. Otherwise, optional.
value

string

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data.
type

Type

How a text input field appears in the user interface. For example, whether the field is single or multi-line.
onChangeAction

Action

What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening a dialog in Google Chat.
initialSuggestions

Suggestions

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav, the list of suggestions filters to show just Java and JavaScript.

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script. Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE.
autoCompleteAction

Action

Optional. Specify what action to take when the text input field provides suggestions to users who interact with it.

If unspecified, the suggestions are set by initialSuggestions and are processed by the client.

If specified, the app takes the action specified here, such as running a custom function.

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

string

Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, Enter a number from 0 to 100.

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

Type

How a text input field appears in the user interface. For example, whether it's a single line input field, or a multi-line input.

If initialSuggestions is specified, type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE.

Enums
SINGLE_LINE The text input field has a fixed height of one line.
MULTIPLE_LINE The text input field has a fixed height of multiple lines.

TextParagraph

A paragraph of text that supports formatting. For an example in Google Chat apps, see Text paragraph. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Fields
text

string

The text that's shown in the widget.

Widget

Each card is made up of widgets.

A widget is a composite object that can represent one of text, images, buttons, and other object types.

Fields
horizontalAlignment

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.
Union field data. A widget can only have one of the following items. You can use multiple widget fields to display more items. data can be only one of the following:
textParagraph

TextParagraph

Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

For example, the following JSON creates a bolded text:

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

Image

Displays an image.

For example, the following JSON creates an image with alternative text:

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

DecoratedText

Displays a decorated text item.

For example, the following JSON creates a decorated text widget showing email address:

"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"
  }
}
buttonList

ButtonList

A list of buttons.

For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link:

"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"
        }
      }
    }
  ]
}
textInput

TextInput

Displays a text box that users can type into.

For example, the following JSON creates a text input for an email address:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

As another example, the following JSON creates a text input for a programming language with static suggestions:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

SelectionInput

Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus.

For example, the following JSON creates a dropdown menu that lets users choose a size:

"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
    }
  ]
}
dateTimePicker

DateTimePicker

Displays a widget that lets users input a date, time, or date and time.

For example, the following JSON creates a date time picker to schedule an appointment:

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

Divider

Displays a horizontal line divider between widgets.

For example, the following JSON creates a divider:

"divider": {
}
grid

Grid

Displays a grid with a collection of items.

A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.

For example, the following JSON creates a 2 column grid with a single item:

"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"
    }
  }
}
columns

Columns

Displays up to 2 columns.

To include more than 2 columns, or to use rows, use the Grid widget.

For example, the following JSON creates 2 columns that each contain text paragraphs:

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

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.

Enums
HORIZONTAL_ALIGNMENT_UNSPECIFIED Don't use. Unspecified.
START Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.
CENTER Aligns widgets to the center of the column.
END Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left.

ImageType

The shape used to crop the image.

Enums
SQUARE Default value. Applies a square mask to the image. For example, a 4x3 image becomes 3x3.
CIRCLE Applies a circular mask to the image. For example, a 4x3 image becomes a circle with a diameter of 3.