Grid

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

The text that displays in the grid header.

object (GridItem)

The items to display in the grid.

object (BorderStyle)

The border style to apply to each grid item.

integer

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

object (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.

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

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

object (ImageComponent)

The image that displays in the grid item.

string

The grid item's title.

string

The grid item's subtitle.

enum (GridItemLayout)

The layout to use for the grid item.

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

The border type.

object (Color)

The colors to use when the type is BORDER_TYPE_STROKE.

integer

The corner radius for the border.

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

The amount of red in the color as a value in the interval [0, 1].

number

The amount of green in the color as a value in the interval [0, 1].

number

The amount of blue in the color as a value in the interval [0, 1].

number

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

{

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

object (Action)

If specified, an action is triggered by this onClick.

object (OpenLink)

If specified, this onClick triggers an open link action.

object (Action)

An add-on triggers this action when the action needs to open a link. This differs from the openLink 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.

object (Card)

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

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

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction)
}

string

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

For example usage, see Create interactive cards.

object (ActionParameter)

List of action parameters.

enum (LoadIndicator)

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

boolean

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

enum (Interaction)

Optional. Required when opening a dialog.

What to do in response to an interaction with a user, such as a user clicking a button in a card message.

If unspecified, the app responds by executing an action —like opening a link or running a function—as normal.

By specifying an interaction, the app can respond in special interactive ways. For example, by setting interaction to OPEN_DIALOG, the app can open a dialog. When specified, a loading indicator isn't shown.

Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

The URL to open.

enum (OpenAs)

How to open a link. Not supported by Chat apps.

enum (OnClose)

Whether the client forgets about a link after opening it, or observes it until the window closes. Not supported by Chat apps.