Conversational Actions will be deprecated on June 13, 2023. For more information, see Conversational Actions sunset.
Stay organized with collections Save and categorize content based on your preferences.

Basic card

Use basic cards (also called entity cards) to display an image and text to users.

Here’s an example of what a basic card looks like when all required and optional fields are completed.


Requirements

This visual component currently supports customization.

Field name Required? Restrictions/Customizations
Foreground image Yes, required if there’s no description
  • Max 1 foreground image.
  • Width and height vary by screen. If the image's aspect ratio is different than the screen, the image is centered with bars along the top or sides.
  • Image source is a URL. If an image link is broken, then a placeholder image is used instead.
  • Customizable image shape (angled or rounded corners).
  • Motion GIFs are allowed.
  • Alt text is required for accessibility.
Card background No
  • Customizable image or color.
Title No
  • Customizable font family and color.
  • Max 1 line recommended.
  • The card height collapses if no title is specified.
Subtitle No
  • Plain text. Fixed font and size.
  • Max 1 line recommended.
  • The card height collapses if no subtitle is specified.
Description

(also called body or formatted text)

Yes, required if there's no image
  • PPlain text by default. Fixed font and size.
  • Bolding, italics, and new lines available via a limited subset of markdown.
  • Max 10 lines with an image. This is about 500 characters, depending on the screen. Additional characters will be cut off.
  • Max 15 lines without an image. This is about 750 characters, depending on the screen. Additional characters will be cut off.
Action link No
  • 1 link can be specified at the end of a text-card.
  • Links can lead directly to web pages or generate other visual components to advance the dialog. They can also be deep links to apps.
  • Link title is required and cannot be misleading. This is checked during the approval process.

Guidance

Basic cards are used to describe entities (i.e. topics including people, places, or things)—they’re best used when a ‘definition-style’ response form factor is needed. Use them to summarize information or to provide additional, relevant information to the user.

Do.

Summarize things like event details using a basic card. This allows users to scan it quickly for the information they want.

Don't.

It’s less efficient to present information like event details in the prompts.

Do.

Use the spoken and display prompts to give the specific answer to the user’s directed question (11:30 AM in this example). Use the visuals for related details.

Don't.

Avoid redundancy between the spoken prompt, display prompt, and visuals.

Do.

Sometimes an image is the best way to convey information to the user.

Don't.

Though the description is nice, a picture would have been better.