Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1 below:

Package google.apps.card.v1 | Google Workspace add-ons

• 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)
• DataActions (message)
• DateTimePicker (message)
• DateTimePicker.DateTimePickerType (enum)
• DecoratedText (message)
• DecoratedText.SwitchControl (message)
• DecoratedText.SwitchControl.ControlType (enum)
• Divider (message)
• EndNavigation (message)
• EndNavigation.Action (enum)
• GetAutocompletionResponse (message)
• Grid (message)
• Grid.GridItem (message)
• Grid.GridItem.GridItemLayout (enum)
• Icon (message)
• Image (message)
• ImageComponent (message)
• ImageCropStyle (message)
• ImageCropStyle.ImageCropType (enum)
• Link (message)
• LinkPreview (message)
• MaterialIcon (message)
• ModifyCard (message)
• ModifyCard.UpdateWidget (message)
• ModifyCard.UpdateWidget.SelectionInputWidgetSuggestions (message)
• Navigation (message)
• Notification (message)
• OnClick (message)
• OpenLink (message)
• OpenLink.OnClose (enum)
• OpenLink.OpenAs (enum)
• OverflowMenu (message)
• OverflowMenu.OverflowMenuItem (message)
• RenderActions (message)
• RenderActions.Action (message)
• SelectionInput (message)
• SelectionInput.PlatformDataSource (message)
• SelectionInput.PlatformDataSource.CommonDataSource (enum)
• SelectionInput.SelectionItem (message)
• SelectionInput.SelectionType (enum)
• SubmitFormResponse (message)
• 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)

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.

string

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

For example usage, see Read form data.

ActionParameter

List of action parameters.

LoadIndicator

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

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

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.

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.

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.

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.

string

The name of the parameter for the action script.

string

The value of the parameter.

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.

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.

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.

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.

BorderType

The border type.

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.

int32

The corner radius for the border.

Represents the border types applied to widgets.

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

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.

string

The text displayed inside the button.

Icon

An icon displayed inside the button. If both icon and text are set, then the icon appears before the text.

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.

OnClick

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

bool

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

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

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.

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.

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.

Button

An array of buttons.

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.

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

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

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.

DividerStyle

The divider style between the header, sections and footer.

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:

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

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.

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.

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.

string

The label that displays as the action menu item.

OnClick

The onClick action for this action item.

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

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

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

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

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.

Widget

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

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.

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.

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.

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.

CarouselCard

A list of cards included in the carousel.

NestedWidget

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

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

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

Icon

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

string

The text displayed inside the chip.

OnClick

Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.

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.

bool

Whether the chip is in an inactive state and ignores user actions. Defaults to false.

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

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.

Layout

Specified chip list layout.

Chip

An array of chips.

The chip list layout.

Represent an expand and collapse control.

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

HorizontalAlignment

The horizontal alignment of the expand and collapse button.

Button

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

Button

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

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.

Column

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

A column.

Google Workspace add-ons and Chat apps

HorizontalSizeStyle

Specifies how a column fills the width of the card.

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

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

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

Google Workspace add-ons and Chat apps

The supported widgets that you can include in a column.

Google Workspace add-ons and Chat apps

An add-on action that updates Google Workspace data.

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.

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.

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.

DateTimePickerType

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

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

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.

Action

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

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.

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.

Icon

This item is deprecated!

Deprecated in favor of startIcon.

Icon

The icon displayed in front of the text.

VerticalAlignment

Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered.

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

string

The text that appears above text. Always truncates.

TextParagraph

TextParagraph equivalent of top_label. Always truncates. Allows for more complex formatting than top_label.

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

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.

TextParagraph

TextParagraph equivalent of text. Allows for more complex formatting than text.

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

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.

string

The text that appears below text. Always wraps.

TextParagraph

TextParagraph equivalent of bottom_label. Always wraps. Allows for more complex formatting than bottom_label.

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

OnClick

This action is triggered when users click topLabel or bottomLabel.

Button

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

SwitchControl

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

Icon

An icon displayed after the text.

Supports built-in and custom icons.

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.

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.

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.

bool

When true, the switch is selected.

Action

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

ControlType

How the switch appears in the user interface.

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

How the switch appears in the user interface.

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

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": {}

For add-ons in Google Chat, closes a dialog.

For add-ons in Google Chat, actions for closing a dialog.

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

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

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

Suggestions

string

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

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

string

The text that displays in the grid header.

GridItem

The items to display in the grid.

BorderStyle

The border style to apply to each grid item.

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

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.

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.

string

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

ImageComponent

The image that displays in the grid item.

string

The grid item's title.

string

The grid item's subtitle.

GridItemLayout

The layout to use for the grid item.

Represents the various layout options available for a grid item.

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

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.

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.

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.

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.

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.

MaterialIcon

Display one of the Google Material Icons.

For example, to display a checkbox icon, use

"materialIcon": {
  "name": "check_box"
}

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

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.

string

The HTTPS URL that hosts the image.

For example:

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

OnClick

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

string

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

Represents an image.

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

string

The image URL.

string

The accessibility label for the image.

ImageCropStyle

The crop style to apply to the image.

BorderStyle

The border style to apply to the image.

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
}

ImageCropType

The crop type.

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
}

Represents the crop style applied to an image.

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

The link object for the third-party resource that's returned to the add-on. For more information, see Create third-party resources from the @ menu.

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

string

URL of the link to return to the add-on.

string

Title of the link to return to the add-on.

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

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

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:

Card

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

string

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

string

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

A Google Material Icon, which includes over 2500+ options.

For example, to display a checkbox icon with customized weight and grade, write the following:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

string

The icon name defined in the Google Material Icon, for example, check_box. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.

bool

Whether the icon renders as filled. Default value is false.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize.

int32

The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize.

int32

Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize.

For add-ons in Google Chat, updates a card based on a user interaction. The array must only contain a single object.

For add-ons in Google Chat, updates a widget in a card or dialog. It is used for providing auto-complete suggestions when user types in an input box. See Suggest multiselect items for more details.

For a selectionInput widget that uses a multiselect menu, returns selection items from an external dynamic data source.

Updates or navigates between cards in a card stack.

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

For example:

1) Return a new card (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
  }

Union field navigate_action.

navigate_action can be only one of the following:

bool

Pops all cards off except the root card.

bool

Pops one card off.

string

Pops all cards above the specified card with given card name.

Card

Pushes a card onto the card stack.

For dialogs in Google Chat, opens or updates a dialog.

Card

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

For dialogs in Google Chat, opens or updates a dialog.

EndNavigation

For add-ons in Google Chat, closes a dialog.

An action that displays a notification in the host Google Workspace application when a user interacts with a card.

For add-ons in Google Chat, displays a notification when users submit and close a dialog.

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

string

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

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

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

Union field data.

data can be only one of the following:

Action

If specified, an action is triggered by this onClick.

OpenLink

If specified, this onClick triggers an open link action.

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.

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

Card

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

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

Represents an onClick event that opens a hyperlink.

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

string

The URL to open.

OpenAs

How to open a link.

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

OnClose

Whether the client forgets about a link after opening it, or observes it until the window closes.

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

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.

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

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.

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.

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

A set of render instructions that tells a host application how to render a card or perform an action in response to a user interaction.

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

Action

The action that add-ons can use to update the UI.

Add-ons in Google Chat.

HostAppActionMarkup

Actions handled by individual host apps.

string

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

The actions that add-ons can use in cards or the host application.

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

A widget that creates one or more UI items that users can select. Supports form submission validation for dropdown and multiselect menus only. 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 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 Add selectable UI elements.

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.

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

string

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

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

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

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.

SelectionItem

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

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.

int32

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

int32

For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items.

If unset, the multiselect menu uses the following default values:

• If the menu uses a static array of SelectionInput items, defaults to 0 characters and immediately populates items from the array.
• If the menu uses a dynamic data source (multi_select_data_source), defaults to 3 characters before querying the data source to return suggested items.

string

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

Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.

Union field multi_select_data_source. For a multiselect menu, a data source that dynamically populates selection items.

Available for Google Chat apps and unavailable for Google Workspace add-ons. multi_select_data_source can be only one of the following:

Action

An external data source, such as a relational database.

PlatformDataSource

A data source from Google Workspace.

For a SelectionInput widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu.

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

CommonDataSource

A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.

HostAppDataSourceMarkup

A data source that's unique to a Google Workspace host application, such spaces in Google Chat.

This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see Install the client libraries.

A data source shared by all Google Workspace applications.

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

An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items.

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

string

The text that identifies or describes the item to users.

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.

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.

string

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

string

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.

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

A menu with a text box. Users can type and select one or more items. For Google Workspace add-ons, you must populate items using a static array of SelectionItem objects.

For Google Chat apps, you can also populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a multiselect menu, use one of the following types of data sources:

• Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces.
• External data: Items are populated from an external data source outside of Google Workspace.

For examples of how to implement multiselect menus for Chat apps, see Add a multiselect menu.

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

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.

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

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.

bool

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

string

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

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.

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

SuggestionItem

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

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

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

Union field content.

content can be only one of the following:

string

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

A field in which users can enter text. Supports suggestions and on-change actions. 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 entered. For an example in Google Chat apps, see Add a field in which a user can enter text.

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.

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

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.

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.

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.

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

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

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.

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.

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

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.

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

Validation

Specify the input format validation necessary for this text field.

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

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.

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

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.

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

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

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

string

The text that's shown in the widget.

int32

The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a show more button. If the text is equal or shorter than the specified maximum number of lines, a show more button isn't displayed.

The default value is 0, in which case all context is displayed. Negative values are ignored.

TextSyntax

The syntax of the text. If not set, the text is rendered as HTML.

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

Syntax to use for formatting text.

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

Represents the necessary data for validating the widget it's attached to.

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

int32

Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets.

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

InputType

Specify the type of the input widgets.

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

The type of the input 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.

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

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

The shape used to crop the image.

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

Represents vertical alignment attribute.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4