Google Chat V1 API - Class Google::Apps::Card::V1::Card (v0.1.1)

Version 0.1.1

• 0.7.0 (latest)
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.2

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Card::V1::Card.

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": &quot;[e-mail]" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "<font color=&quot;#80e27e&quot;>Online</font>" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "[phone]" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share"; } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] }

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#card_actions

def card_actions() -> ::Array<::Google::Apps::Card::V1::Card::CardAction>

Returns

• (::Array<::Google::Apps::Card::V1::Card::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" } } } ]

#card_actions=

def card_actions=(value) -> ::Array<::Google::Apps::Card::V1::Card::CardAction>

Parameter

• value (::Array<::Google::Apps::Card::V1::Card::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" } } } ]

Returns

• (::Array<::Google::Apps::Card::V1::Card::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" } } } ]

#display_style

def display_style() -> ::Google::Apps::Card::V1::Card::DisplayStyle

Returns

• (::Google::Apps::Card::V1::Card::DisplayStyle) — In Google Workspace Add-ons, sets the display properties of the peekCardHeader.

  Google Workspace Add-ons:

#display_style=

def display_style=(value) -> ::Google::Apps::Card::V1::Card::DisplayStyle

Parameter

• value (::Google::Apps::Card::V1::Card::DisplayStyle) — In Google Workspace Add-ons, sets the display properties of the peekCardHeader.

  Google Workspace Add-ons:

Returns

• (::Google::Apps::Card::V1::Card::DisplayStyle) — In Google Workspace Add-ons, sets the display properties of the peekCardHeader.

  Google Workspace Add-ons:

#fixed_footer

def fixed_footer() -> ::Google::Apps::Card::V1::Card::CardFixedFooter

Returns

• (::Google::Apps::Card::V1::Card::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:

#fixed_footer=

def fixed_footer=(value) -> ::Google::Apps::Card::V1::Card::CardFixedFooter

Parameter

• value (::Google::Apps::Card::V1::Card::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:

Returns

• (::Google::Apps::Card::V1::Card::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:

#header

def header() -> ::Google::Apps::Card::V1::Card::CardHeader

Returns

• (::Google::Apps::Card::V1::Card::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.

#header=

def header=(value) -> ::Google::Apps::Card::V1::Card::CardHeader

Parameter

• value (::Google::Apps::Card::V1::Card::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.

Returns

• (::Google::Apps::Card::V1::Card::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.

#name

def name() -> ::String

Returns

• (::String) — Name of the card. Used as a card identifier in card navigation.

  Google Workspace Add-ons:

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Name of the card. Used as a card identifier in card navigation.

  Google Workspace Add-ons:

Returns

• (::String) — Name of the card. Used as a card identifier in card navigation.

  Google Workspace Add-ons:

#peek_card_header

def peek_card_header() -> ::Google::Apps::Card::V1::Card::CardHeader

Returns

• (::Google::Apps::Card::V1::Card::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:

#peek_card_header=

def peek_card_header=(value) -> ::Google::Apps::Card::V1::Card::CardHeader

Parameter

• value (::Google::Apps::Card::V1::Card::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:

Returns

• (::Google::Apps::Card::V1::Card::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:

#section_divider_style

def section_divider_style() -> ::Google::Apps::Card::V1::Card::DividerStyle

Returns

• (::Google::Apps::Card::V1::Card::DividerStyle) — The divider style between sections.

#section_divider_style=

def section_divider_style=(value) -> ::Google::Apps::Card::V1::Card::DividerStyle

Parameter

• value (::Google::Apps::Card::V1::Card::DividerStyle) — The divider style between sections.

Returns

• (::Google::Apps::Card::V1::Card::DividerStyle) — The divider style between sections.

#sections

def sections() -> ::Array<::Google::Apps::Card::V1::Card::Section>

Returns

• (::Array<::Google::Apps::Card::V1::Card::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.

#sections=

def sections=(value) -> ::Array<::Google::Apps::Card::V1::Card::Section>

Parameter

• value (::Array<::Google::Apps::Card::V1::Card::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.

Returns

• (::Array<::Google::Apps::Card::V1::Card::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.