Image

The Image widget displays a .png or .jpg image hosted on an HTTPS URL. The displayed image's width fills the entire width of the displayed card, and its height adjusts to maintain the image's aspect ratio.

The Image widget supports onclick actions that occur when users click the image. Example onclick actions include:

Open a hyperlink with OpenLink, such as a hyperlink to the Google Chat developer documentation, https://developers.google.com/chat.
Run an action that runs a custom function, like calling an API.

The following is a card consisting of an Image widget. It displays the Google Chat developer documentation landing page image. When users click the image, the Google Chat developer documentation opens in a new tab.

JSON representation and fields

JSON representation
{ "imageUrl": string, "onClick": { object (`OnClick`) }, "altText": string }

Fields

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

imageUrl

string

The HTTPS URL that hosts the image.

For example:

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

onClick

object (OnClick)

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

altText

string

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

OnClick

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

JSON representation

JSON representation
{ // 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`. }

{

  // 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.
}

Fields
Union field `data`. `data` can be only one of the following:
`action`	`object (Action)` If specified, an action is triggered by this `onClick`.
`openLink`	`object (OpenLink)` If specified, this `onClick` triggers an open link action.
`openDynamicLinkAction`	`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. Supported by Google Workspace Add-ons, but not Google Chat apps.
`card`	`object (Card)` A new card is pushed to the card stack after clicking if specified. Supported by Google Workspace Add-ons, but not Google Chat apps.

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.

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

Fields
`function`	`string` A custom function to invoke when the containing element is clicked or othrwise activated. For example usage, see Create interactive cards.
`parameters[]`	`object (ActionParameter)` List of action parameters.
`loadIndicator`	`enum (LoadIndicator)` Specifies the loading indicator that the action displays while making the call to the action.
`persistValues`	`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`.
`interaction`	`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.

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.

JSON representation
{ "key": string, "value": string }

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.

LoadIndicator

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

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

Interaction

Optional. Required when opening a dialog.

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

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

By specifying an interaction, the app can respond in special interactive ways. For example, by setting interaction to OPEN_DIALOG, the app can open a dialog.

When specified, a loading indicator isn't shown.

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

Enums

INTERACTION_UNSPECIFIED Default value. The action executes as normal.

Enums
`INTERACTION_UNSPECIFIED`	Default value. The `action` executes as normal.
`OPEN_DIALOG`	Opens a dialog, a windowed, card-based interface that Chat apps use to interact with users. Only supported by Chat apps in response to button-clicks on card messages. Not supported by Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

OPEN_DIALOG

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

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

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

OpenLink

Represents an onClick event that opens a hyperlink.

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

Fields

Fields
`url`	`string` The URL to open.
`openAs`	`enum (OpenAs)` How to open a link. Not supported by Chat apps.
`onClose`	`enum (OnClose)` Whether the client forgets about a link after opening it, or observes it until the window closes. Not supported by Chat apps.

url

string

The URL to open.

openAs

enum (OpenAs)

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

onClose

enum (OnClose)

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

Limits and considerations

Only .png and .jpg images are supported.
The host URL must be HTTPS.
To ensure performant cards, maximum recommended image size is 2 MB.

Troubleshoot

When a Google Chat app or card returns an error, the Chat interface surfaces a message saying "Something went wrong." or "Unable to process your request." Sometimes the Chat UI doesn't display any error message, but the Chat app or card produces an unexpected result; for example, a card message might not appear.

Although an error message might not display in the Chat UI, descriptive error messages and log data are available to help you fix errors when error logging for Chat apps is turned on. For help viewing, debugging, and fixing errors, see Troubleshoot and fix Google Chat errors.