Struct google_api_proto::google::apps::card::v1::Card

pub struct Card {
    pub header: Option<CardHeader>,
    pub sections: Vec<Section>,
    pub section_divider_style: i32,
    pub card_actions: Vec<CardAction>,
    pub name: String,
    pub fixed_footer: Option<Box<CardFixedFooter>>,
    pub display_style: i32,
    pub peek_card_header: Option<CardHeader>,
}

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.

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.

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

Fields

header: Option<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: Vec<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: i32

The divider style between sections.

card_actions: Vec<CardAction>

The card’s actions. Actions are added to the card’s toolbar menu.

Google Workspace Add-ons:

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.

Google Workspace Add-ons:

fixed_footer: Option<Box<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.

Google Workspace Add-ons and Chat apps:

display_style: i32

In Google Workspace Add-ons, sets the display properties of the peekCardHeader.

Google Workspace Add-ons:

peek_card_header: Option<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.

Google Workspace Add-ons:

Implementations

impl Card

pub fn display_style(&self) -> DisplayStyle

Returns the enum value of display_style, or the default if the field is set to an invalid enum value.

pub fn set_display_style(&mut self, value: DisplayStyle)

Sets display_style to the provided enum value.

pub fn section_divider_style(&self) -> DividerStyle

Returns the enum value of section_divider_style, or the default if the field is set to an invalid enum value.

pub fn set_section_divider_style(&mut self, value: DividerStyle)

Sets section_divider_style to the provided enum value.

Trait Implementations

impl Clone for Card

fn clone(&self) -> Card

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Card

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Card

fn default() -> Self

Returns the “default value” for a type.

impl Message for Card

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Card

fn eq(&self, other: &Card) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Card