Package google.apps.card.v1

Index

Action (message)
Action.ActionParameter (message)
Action.Interaction (enum)
Action.LoadIndicator (enum)
BorderStyle (message)
BorderStyle.BorderType (enum)
Button (message)
Button.Type (enum)
ButtonList (message)
Card (message)
Card.CardAction (message)
Card.CardFixedFooter (message)
Card.CardHeader (message)
Card.DisplayStyle (enum)
Card.DividerStyle (enum)
Card.NestedWidget (message)
Card.Section (message)
Carousel (message)
Carousel.CarouselCard (message)
Chip (message)
ChipList (message)
ChipList.Layout (enum)
CollapseControl (message)
Columns (message)
Columns.Column (message)
Columns.Column.HorizontalSizeStyle (enum)
Columns.Column.VerticalAlignment (enum)
Columns.Column.Widgets (message)
DateTimePicker (message)
DateTimePicker.DateTimePickerType (enum)
DecoratedText (message)
DecoratedText.SwitchControl (message)
DecoratedText.SwitchControl.ControlType (enum)
Divider (message)
Grid (message)
Grid.GridItem (message)
Grid.GridItem.GridItemLayout (enum)
Icon (message)
Image (message)
ImageComponent (message)
ImageCropStyle (message)
ImageCropStyle.ImageCropType (enum)
MaterialIcon (message)
OnClick (message)
OpenLink (message)
OpenLink.OnClose (enum)
OpenLink.OpenAs (enum)
OverflowMenu (message)
OverflowMenu.OverflowMenuItem (message)
SelectionInput (message)
SelectionInput.PlatformDataSource (message)
SelectionInput.PlatformDataSource.CommonDataSource (enum)
SelectionInput.SelectionItem (message)
SelectionInput.SelectionType (enum)
Suggestions (message)
Suggestions.SuggestionItem (message)
TextInput (message)
TextInput.Type (enum)
TextParagraph (message)
TextParagraph.TextSyntax (enum)
Validation (message)
Validation.InputType (enum)
Widget (message)
Widget.HorizontalAlignment (enum)
Widget.ImageType (enum)
Widget.VerticalAlignment (enum)

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.

Available for Google Chat apps and Google Workspace add-ons.

Fields
`function`	`string` A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see Read form data.
`parameters[]`	`ActionParameter` List of action parameters.
`load_indicator`	`LoadIndicator` Specifies the loading indicator that the action displays while making the call to the action.
`persist_values`	`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. If specified for an add-on, the entire card is stripped and nothing is shown in the client. Available for Google Chat apps and unavailable for Google Workspace add-ons.
`required_widgets[]`	`string` Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. Available for Google Chat apps and Google Workspace add-ons.
`all_widgets_are_required`	`bool` Optional. If this is true, then all widgets are considered required by this action. Available for Google Chat apps and Google Workspace add-ons.

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.

Available for Google Chat apps and Google Workspace add-ons.

Fields

Fields
`key`	`string` The name of the parameter for the action script.
`value`	`string` The value of the parameter.

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. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

Available for Google Chat apps and unavailable for Google Workspace add-ons.

Enums

INTERACTION_UNSPECIFIED Default value. The action executes as normal.

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. If specified for an add-on, the entire card is stripped and nothing is shown in the client. Available for Google Chat apps and unavailable for Google Workspace add-ons.

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. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

Available for Google Chat apps and unavailable for Google Workspace add-ons.

LoadIndicator

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

Available for Google Chat apps and Google Workspace add-ons.

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.

Available for Google Chat apps and Google Workspace add-ons.

Fields

Fields
`type`	`BorderType` The border type.
`stroke_color`	`Color` The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: `"color": { "red": 1, "green": 0, "blue": 0, }` The `alpha` field is unavailable for stroke color. If specified, this field is ignored.
`corner_radius`	`int32` The corner radius for the border.

type

BorderType

The border type.

stroke_color

Color

The colors to use when the type is BORDER_TYPE_STROKE.

To set the stroke color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

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

The alpha field is unavailable for stroke color. If specified, this field is ignored.

corner_radius

int32

The corner radius for the border.

BorderType

Represents the border types applied to widgets.

Available for Google Chat apps and Google Workspace add-ons.

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

Button

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

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

Available for Google Chat apps and Google Workspace add-ons.

Fields
`text`	`string` The text displayed inside the button.
`icon`	`Icon` An icon displayed inside the button. If both `icon` and `text` are set, then the icon appears before the text.
`color`	`Color` Optional. The color of the button. If set, the button `type` is set to `FILLED` and the color of `text` and `icon` fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white. To set the button color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: `"color": { "red": 1, "green": 0, "blue": 0, }` The `alpha` field is unavailable for button color. If specified, this field is ignored.
`on_click`	`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.
`alt_text`	`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/workspace/chat".
`type`	`Type` Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored.

Type

Optional. The type of a button. If color field is set, the type is forced to FILLED.

Available for Google Chat apps and unavailable for Google Workspace add-ons.

Enums
`TYPE_UNSPECIFIED`	Don't use. Unspecified.
`OUTLINED`	Outlined buttons are medium-emphasis buttons. They usually contain actions that are important, but aren’t the primary action in a Chat app or an add-on.
`FILLED`	A filled button has a container with a solid color. It has the most visual impact and is recommended for the important and primary action in a Chat app or an add-on.
`FILLED_TONAL`	A filled tonal button is an alternative middle ground between filled and outlined buttons. They’re useful in contexts where a lower-priority button requires slightly more emphasis than an outline button would give.
`BORDERLESS`	A button does not have an invisible container in its default state. It is often used for the lowest priority actions, especially when presenting multiple options.

ButtonList

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

Available for Google Chat apps and Google Workspace add-ons.

Fields

Fields
`buttons[]`	`Button` An array of buttons.

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.

Design and preview cards with the Card Builder.

Open the Card Builder

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

For Google Chat apps, see Design the components of a card or dialog.
For Google Workspace add-ons, see Card-based interfaces.

Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons.

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/workspace/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": "[email protected]"
                 }
               },
               {
                 "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 Define a section of a card.
`section_divider_style`	`DividerStyle` The divider style between the header, sections and footer.
`card_actions[]`	`CardAction` The card's actions. Actions are added to the card's toolbar menu. Available for Google Workspace add-ons and unavailable for Google Chat apps. For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: `"card_actions": [ { "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. Available for Google Workspace add-ons and unavailable for Google Chat apps.
`fixed_footer`	`CardFixedFooter` The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in dialogs, but not card messages. Available for Google Chat apps and Google Workspace add-ons.
`display_style`	`DisplayStyle` In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. Available for Google Workspace add-ons and unavailable for Google Chat apps.
`peek_card_header`	`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. Available for Google Workspace add-ons and unavailable for Google 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.

Available for Google Workspace add-ons and unavailable for Google Chat apps.

Fields

Fields
`action_label`	`string` The label that displays as the action menu item.
`on_click`	`OnClick` The `onClick` action for this action item.

action_label

string

The label that displays as the action menu item.

on_click

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.

For Chat apps, you can use fixed footers in dialogs, but not card messages. For an example in Google Chat apps, see Add a persistent footer.

Available for Google Chat apps and Google Workspace add-ons.

Fields

Fields
`primary_button`	`Button` The primary button of the fixed footer. The button must be a text button with text and color set.
`secondary_button`	`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`.

primary_button

Button

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

secondary_button

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 Add a header.

Available for Google Chat apps and Google Workspace add-ons.

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`.
`image_type`	`ImageType` The shape used to crop the image. Available for Google Chat apps and Google Workspace add-ons.
`image_url`	`string` The HTTPS URL of the image in the card header.
`image_alt_text`	`string` The alternative text of this image that's used for accessibility.

DisplayStyle

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

Available for Google Workspace add-ons and unavailable for Google 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.

Available for Google Chat apps and Google Workspace add-ons.

Enums
`DIVIDER_STYLE_UNSPECIFIED`	Don't use. Unspecified.
`SOLID_DIVIDER`	Default option. Render a solid divider.
`NO_DIVIDER`	If set, no divider is rendered. This style completely removes the divider from the layout. The result is equivalent to not adding a divider at all.

NestedWidget

A list of widgets that can be displayed in a containing layout, such as a CarouselCard.

Available for Google Chat apps and unavailable for Google Workspace add-ons.

Fields
Union field `data`. `data` can be only one of the following:
`text_paragraph`	`TextParagraph` A text paragraph widget.
`button_list`	`ButtonList` A button list widget.
`image`	`Image` An image widget.

Section

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

Available for Google Chat apps and Google Workspace add-ons.

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`.
`uncollapsible_widgets_count`	`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`.
`collapse_control`	`CollapseControl` Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used.

Carousel

A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget.

For example, this is a JSON representation of a carousel that contains three text paragraph widgets.

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

Available for Google Chat apps and unavailable for Google Workspace add-ons.

Fields

Fields
`carousel_cards[]`	`CarouselCard` A list of cards included in the carousel.

carousel_cards[]

CarouselCard

A list of cards included in the carousel.

CarouselCard

A card that can be displayed as a carousel item.

Available for Google Chat apps and unavailable for Google Workspace add-ons.

Fields

Fields
`widgets[]`	`NestedWidget` A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.
`footer_widgets[]`	`NestedWidget` A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.

widgets[]

NestedWidget

A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.

footer_widgets[]

NestedWidget

A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.

Chip

A text, icon, or text and icon chip that users can click.

Available for Google Chat apps and Google Workspace add-ons.

Fields
`icon`	`Icon` The icon image. If both `icon` and `text` are set, then the icon appears before the text.
`label`	`string` The text displayed inside the chip.
`on_click`	`OnClick` Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.
`enabled (deprecated)`	`bool` This item is deprecated! Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.
`disabled`	`bool` Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.
`alt_text`	`string` The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".

ChipList

A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line.

Available for Google Chat apps and Google Workspace add-ons.

Fields

Fields
`layout`	`Layout` Specified chip list layout.
`chips[]`	`Chip` An array of chips.

layout

Layout

Specified chip list layout.

chips[]

Chip

An array of chips.

Layout

The chip list layout.

Enums
`LAYOUT_UNSPECIFIED`	Don't use. Unspecified.
`WRAPPED`	Default value. The chip list wraps to the next line if there isn't enough horizontal space.
`HORIZONTAL_SCROLLABLE`	The chips scroll horizontally if they don't fit in the available space.

CollapseControl

Represent an expand and collapse control.

Available for Google Chat apps and Google Workspace add-ons.

Fields

Fields
`horizontal_alignment`	`HorizontalAlignment` The horizontal alignment of the expand and collapse button.
`expand_button`	`Button` Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.
`collapse_button`	`Button` Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

horizontal_alignment

HorizontalAlignment

The horizontal alignment of the expand and collapse button.

expand_button

Button

Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

collapse_button

Button

Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

Columns

The Columns widget displays up to 2 columns in a card 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 Display cards and dialogs in 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 two columns, or to use rows, use the Grid widget.

Available for Google Chat apps and Google Workspace add-ons. The add-on UIs that support columns include:

The dialog displayed when users open the add-on from an email draft.
The dialog displayed when users open the add-on from the Add attachment menu in a Google Calendar event.

Fields

Fields
`column_items[]`	`Column` An array of columns. You can include up to 2 columns in a card or dialog.

column_items[]

Column

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

Column

A column.

Google Workspace add-ons and Chat apps

Fields
`horizontal_size_style`	`HorizontalSizeStyle` Specifies how a column fills the width of the card.
`horizontal_alignment`	`HorizontalAlignment` Specifies whether widgets align to the left, right, or center of a column.
`vertical_alignment`	`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.

Google Workspace add-ons and Chat apps

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.

Google Workspace add-ons and Chat apps

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.

Google Workspace add-ons and Chat apps

Fields
Union field `data`. `data` can be only one of the following:
`text_paragraph`	`TextParagraph` `TextParagraph` widget.
`image`	`Image` `Image` widget.
`decorated_text`	`DecoratedText` `DecoratedText` widget.
`button_list`	`ButtonList` `ButtonList` widget.
`text_input`	`TextInput` `TextInput` widget.
`selection_input`	`SelectionInput` `SelectionInput` widget.
`date_time_picker`	`DateTimePicker` `DateTimePicker` widget.
`chip_list`	`ChipList` `ChipList` widget.

DateTimePicker

Lets users input a date, a time, or both a date and a time. Supports form submission validation. When Action.all_widgets_are_required is set to true or this widget is specified in Action.required_widgets, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see Let a user pick a date and time.

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.

Available for Google Chat apps and Google Workspace add-ons.

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.
`value_ms_epoch`	`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`).
`timezone_offset_date`	`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.
`on_change_action`	`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.

Available for Google Chat apps and Google Workspace add-ons.

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 Display text with decorative text.

Available for Google Chat apps and Google Workspace add-ons.

Fields
`icon (deprecated)`	`Icon` This item is deprecated! Deprecated in favor of `startIcon`.
`start_icon`	`Icon` The icon displayed in front of the text.
`start_icon_vertical_alignment`	`VerticalAlignment` Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features. Available for Google Chat apps and unavailable for Google Workspace add-ons.
`top_label`	`string` The text that appears above `text`. Always truncates.
`top_label_text`	`TextParagraph` `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features. Available for Google Chat apps and unavailable for Google Workspace add-ons.
`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.
`content_text`	`TextParagraph` `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features. Available for Google Chat apps and unavailable for Google Workspace add-ons.
`wrap_text`	`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`.
`bottom_label`	`string` The text that appears below `text`. Always wraps.
`bottom_label_text`	`TextParagraph` `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features. Available for Google Chat apps and unavailable for Google Workspace add-ons.
`on_click`	`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.
`switch_control`	`SwitchControl` A switch widget that a user can click to change its state and trigger an action.
`end_icon`	`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.

Available for Google Chat apps and Google Workspace add-ons.

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.
`on_change_action`	`Action` The action to perform when the switch state is changed, such as what function to run.
`control_type`	`ControlType` How the switch appears in the user interface. Available for Google Chat apps and Google Workspace add-ons.

ControlType

How the switch appears in the user interface.

Available for Google Chat apps and Google Workspace add-ons.

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 Add a horizontal divider between widgets.

Available for Google Chat apps and Google Workspace add-ons.

For example, the following JSON creates a divider:

"divider": {}

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

Available for Google Chat apps and Google Workspace add-ons.

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.
`border_style`	`BorderStyle` The border style to apply to each grid item.
`column_count`	`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).
`on_click`	`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.

Available for Google Chat apps and Google Workspace add-ons.

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.

Available for Google Chat apps and Google Workspace add-ons.

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 Add an icon.

Supports built-in and custom icons.

Available for Google Chat apps and Google Workspace add-ons.

Fields
`alt_text`	`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/workspace/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.
`image_type`	`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:
`known_icon`	`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.
`icon_url`	`string` Display a custom icon hosted at an HTTPS URL. For example: `"iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"` Supported file types include `.png` and `.jpg`.
`material_icon`	`MaterialIcon` Display one of the Google Material Icons. For example, to display a checkbox icon, use `"material_icon": { "name": "check_box" }` Available for Google Chat apps and unavailable for Google Workspace add-ons.

Image

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

Available for Google Chat apps and Google Workspace add-ons.

Fields

Fields
`image_url`	`string` The HTTPS URL that hosts the image. For example: `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`
`on_click`	`OnClick` When a user clicks the image, the click triggers this action.
`alt_text`	`string` The alternative text of this image that's used for accessibility.

image_url

string

The HTTPS URL that hosts the image.

For example:

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

on_click

OnClick

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

alt_text

string

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

ImageComponent

Represents an image.

Available for Google Chat apps and Google Workspace add-ons.

Fields
`image_uri`	`string` The image URL.
`alt_text`	`string` The accessibility label for the image.
`crop_style`	`ImageCropStyle` The crop style to apply to the image.
`border_style`	`BorderStyle` The border style to apply to the image.

ImageCropStyle

Represents the crop style applied to an image.

Available for Google Chat apps and Google Workspace add-ons.

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

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

Fields

Fields
`type`	`ImageCropType` The crop type.
`aspect_ratio`	`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 }`

type

ImageCropType

The crop type.

aspect_ratio

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.

Package google.apps.card.v1 Stay organized with collections Save and categorize content based on your preferences.

Index

Action

ActionParameter

Interaction

LoadIndicator

BorderStyle

BorderType

Button

Type

ButtonList

Card

CardAction

CardFixedFooter

CardHeader

DisplayStyle

DividerStyle

NestedWidget

Section

Carousel

CarouselCard

Chip

ChipList

Layout

CollapseControl

Columns

Column

HorizontalSizeStyle

VerticalAlignment

Widgets

DateTimePicker

DateTimePickerType

DecoratedText

SwitchControl

ControlType

Divider

Grid

GridItem

GridItemLayout

Icon

Image

ImageComponent

ImageCropStyle

ImageCropType

Package google.apps.card.v1