Class CardWithId

AI-generated Key Takeaways

• CardWithId is a builder for creating cards with unique identifiers, specifically for use in Google Chat apps.

• It allows developers to set a card's content using setCard() and assign a unique ID using setCardId().

• This functionality is crucial when sending multiple cards within a single message, enabling individual card identification and management.

• This feature is not available for Google Workspace Add-ons.

CardWithId

A builder for CardWithId objects. This class is a unique identifier for a card in a message when sending multiple cards.

Only available for Google Chat apps. Not available for Google Workspace add-ons.

const cardSection = CardService.newCardSection();
cardSection.addWidget(
    CardService.newTextParagraph().setText('This is a text paragraph widget.'),
);

const card = CardService.newCardBuilder()
                 .setHeader(CardService.newCardHeader().setTitle('Card title'))
                 .addSection(cardSection)
                 .build();

const cardWithId =
    CardService.newCardWithId().setCardId('card_id').setCard(card);

Methods

Method	Return type	Brief description
setCard(card)	CardWithId	Sets the card of the cardWithId.
setCardId(id)	CardWithId	Sets the unique card ID of the cardWithId.

Detailed documentation

setCard(card)

Sets the card of the cardWithId.

const cardHeader = CardService.newCardHeader()
                       .setTitle('Card Header Title')
                       .setSubtitle('Card Header Subtitle');

const card = CardService.newCardBuilder().setHeader(cardHeader).build();

const cardWithId = CardService.newCardWithId().setCard(card);

Parameters

Name	Type	Description
card	Card	The Card to use.

Return

CardWithId — This object, for chaining.

---

setCardId(id)

Sets the unique card ID of the cardWithId.

const cardWithId = CardService.newCardWithId();

// Sets the card ID of the cardWithId.
cardWithId.setCardId('card_id');

Parameters

Name	Type	Description
id	String	The text to use.

Return

CardWithId — This object, for chaining.