Package google.apps.card.v1

Stay organized with collections Save and categorize content based on your preferences.

Index

Action

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.

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. When using LoadIndicator.NONE for actions, persist_values = trueis 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 persist_values 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.

interaction

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.

ActionParameter

List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, 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 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.

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

Represents the complete border style applied to items in a widget.

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 No value specified.
NO_BORDER Default value. No border.
STROKE Outline.

Button

A text, icon, or text + icon button that users can click.

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 in place of the text.

Support for both an icon and text is coming soon.

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 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
}
onClick

OnClick

The action to perform when the button is clicked, 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 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".

Has no effect when an icon is set; use icon.alt_text instead.

ButtonList

A list of buttons layed out horizontally.

Fields
buttons[]

Button

An array of buttons.

Card

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.

In Google Chat, cards appear in several places:

  • As stand-alone messages.
  • Accompanying a text message, just beneath the text message.
  • As a dialog.

The following example JSON creates a "contact card" that features:

  • A header with the contact's name, job title, avatar picture.
  • A section with the contact information, including formatted text.
  • Buttons that users can click to share the contact or see more or less info.

Example contact card

{
  "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.

cardActions[]

CardAction

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

Because Chat app cards have no toolbar, cardActions[] is not 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.

Chat apps support fixedFooter in dialogs, but not in 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.

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

Chat apps support fixedFooter in dialogs, but not in 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. primaryButton must be set if secondaryButton is set.

CardHeader

Represents a 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 which is used for accessibility.

DisplayStyle

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

Not supported by Chat apps.

Enums
DISPLAY_STYLE_UNSPECIFIED Do not use.
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.

Section

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

Fields
header

string

Text that appears at the top of a section. Supports simple HTML formatted text.

widgets[]

Widget

All the widgets in the section. Must contain at least 1 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.

DateTimePicker

Lets users specify a date, a time, or both a date and a time.

Accepts text input from users, but features an interactive date and time selector that helps users enter correctly-formatted dates and times. If users enter a date or time incorrectly, the widget shows an error that prompts users to enter the correct format.

Not supported by Chat apps. Support by Chat apps coming soon.

Fields
name

string

The name by which the datetime picker 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 enter a date, time, or datetime.

Specify text that helps the user enter the information your app needs. For example, if users are setting an appointment, then a label like "Appointment date" or "Appointment date and time" might work well.

type

DateTimePickerType

What kind of date and time input the datetime picker supports.

valueMsEpoch

int64

The value displayed as the default value before user input or previous user input, represented in milliseconds (Epoch time).

For DATE_AND_TIME type, the full epoch value is used.

For DATE_ONLY type, only date of the epoch time is used.

For TIME_ONLY type, only time of the epoch time is used. For example, to represent 3:00 AM, set epoch time to 3 * 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 not set, it uses the user's time zone setting on the client side.

onChangeAction

Action

Triggered when the user clicks Save or Clear from the datetime picker interface.

DateTimePickerType

What kind of date and time input the datetime picker supports.

Enums
DATE_AND_TIME The user can select a date and time.
DATE_ONLY The user can only select a date.
TIME_ONLY The user can only select 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.

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.

Supports simple formatting. See Text formatting for formatting details.

text

string

Required. The primary text.

Supports simple formatting. See Text formatting for formatting details.

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

Supports simple formatting. See Text formatting for formatting details.

onClick

OnClick

When users click on topLabel or bottomLabel, this action triggers.

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 can be clicked to trigger an action.

switchControl

SwitchControl

A switch widget can be clicked to change its state and trigger an action. Currently supported in dialogs. Support for card messages is coming soon.

endIcon

Icon

An icon displayed after the text.

Supports standard and custom icons.

SwitchControl

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

Only supported on the decoratedText widget.

Currently supported in dialogs. Support for card messages is coming soon.

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

Displays a divider between widgets, a horizontal line.

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.

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.

Currently supported in dialogs. Support for card messages is coming soon.

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

"grid": {
  "title": "A fine collection of items",
  "numColumns": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4.0
  },
  "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 a single item in the grid layout.

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 No layout specified.
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.

Supports standard and custom icons.

Fields
altText

string

Optional. A description of the icon used for accessibility. If unspecified, a default value is provided. As a best practice, you should set a helpful description. For example, if an icon displays a user's account portrait, you could describe it as "A user's account portrait."

If the icon displays in a Button, this alt text takes precedence and overwrites the button's alt text, so you should write alt text for the button: 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".

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

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.

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 on the image, the click triggers this action.

altText

string

The alternative text of this image, 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 by 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 by 9 aspect ratio:

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

ImageCropType

Represents the crop style applied to an image.

Enums
IMAGE_CROP_TYPE_UNSPECIFIED No value specified. Do not use.
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.

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.

card

Card

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

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

OnClose

What the client does when a link opened by an OnClick action gets 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 Chat apps.

Enums
NOTHING Default value. The card does not 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 opens a link, then the client can either open it as a full size window (if that is 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 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.

SelectionInput

A widget that creates a UI item with options for users to select. For example, a dropdown menu or check list.

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 data from users that matches options you set, use a selection input. To collect abstract data from users, use the text input widget instead.

Only supported in dialogs. Support for card messages coming soon.

Fields
name

string

The name by which the selection 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 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 way that an option appears to users. Different options support different types of interactions. For example, users can enable multiple check boxes, but can only select one value from a dropdown menu.

Each selection input supports one type of selection. Mixing check boxes and switches, for example, is not supported.

items[]

SelectionItem

An array of the selected items. For example, all the selected check boxes.

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.

SelectionItem

A selectable item in a selection input, such as a check box or a switch.

Fields
text

string

The text displayed 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

When true, more than one item is selected. If more than one item is selected for radio buttons and dropdown menus, the first selected item is received and the ones after are ignored.

SelectionType

The way that an option appears to users. Different options support different types of interactions. For example, users can enable multiple check boxes, but can only select one value from a dropdown menu.

Each selection input supports one type of selection. Mixing check boxes and switches, for example, is not supported.

Currently supported in dialogs. Support for card messages is coming soon.

Enums
CHECK_BOX

A set of checkboxes. Users can select multiple check boxes per selection input.

Currently supported in dialogs. Support for card messages is coming soon.

RADIO_BUTTON

A set of radio buttons. Users can select one radio button per selection input.

Currently supported in dialogs. Support for card messages is coming soon.

SWITCH

A set of switches. Users can turn on multiple switches at once per selection input.

Currently supported in dialogs. Support for card messages is coming soon.

DROPDOWN

A dropdown menu. Users can select one dropdown menu item per selection input.

Currently supported in dialogs. Support for card messages is coming soon.

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 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 is 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
text

string

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

TextInput

A field in which users can enter text. Supports suggestions and on-change actions.

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 abstract data from users, use a text input. To collect defined data from users, use the selection input widget instead.

Only supported in dialogs. Support for card messages coming soon.

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 inside the text input field meant to assist users by prompting them to enter a certain value. This text is not visible after users begin typing.

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.

Examples of changes include 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 is 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 Chat apps. Support by Chat apps coming soon.

Type

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

If initialSuggestions is specified, type is always SINGLE_LINE, even if it is 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. See Text formatting for details.

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
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 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!",
  "switchWidget": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "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": [
    "button": {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
        "alpha": 1
       }
      "disabled": true
    },
    "button": {
      "icon": {
        "knownIcon": "INVITE"
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    },
  ]
}
textInput

TextInput

Displays a text box that users can type into.

Currently supported in dialogs. Support for card messages is coming soon.

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 check boxes, radio buttons, switches, or dropdown menus.

Currently supported in dialogs. Support for card messages is coming soon.

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

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "SelectionType.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 selection/input widget for date, time, or date and time.

Not supported by Chat apps. Support by Chat apps is coming soon.

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

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DateTimePickerType.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.

Currently supported in dialogs. Support for card messages is coming soon.

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

"grid": {
  "title": "A fine collection of items",
  "numColumns": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4.0
  },
  "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"
    }
  }
}

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.