Class CardService

Page Summary

CardService allows you to create generic cards for use in various Google extensibility products like Google Workspace add-ons.
You can return single or multiple cards using the CardService.
Cards can be built with headers, text, images, and interactive elements like menu items.
CardService provides numerous methods for creating different card components such as buttons, sections, and input fields.

CardService

CardService provides the ability to create generic cards used across different Googleextensibility products, such asGoogle Workspace add-ons.

Below is a sample for an add-ons card.

functioncreateCard(){returnCardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('CardTitle')).build();}

Or you can return multiple Cards like so:

functioncreateCards(){return[CardService.newCardBuilder().build(),CardService.newCardBuilder().build(),CardService.newCardBuilder().build(),];}

The following shows how you could define a card with a header, text, an image and a menu item:

functioncreateWidgetDemoCard(){returnCardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Widget demonstration').setSubtitle('Check out these widgets').setImageStyle(CardService.ImageStyle.SQUARE).setImageUrl('https://www.example.com/images/headerImage.png'),).addSection(CardService.newCardSection().setHeader('Simple widgets')// optional.addWidget(CardService.newTextParagraph().setText('These widgets are display-only. '+'A text paragraph can have multiple lines and '+'formatting.',),).addWidget(CardService.newImage().setImageUrl('https://www.example.com/images/mapsImage.png',),),).addCardAction(CardService.newCardAction().setText('Gmail').setOpenLink(CardService.newOpenLink().setUrl('https://mail.google.com/mail'),),).build();}

Sample for a Chat Apps card.

constcardHeader=CardService.newCardHeader().setTitle('Sasha').setSubtitle('Software Engineer').setImageUrl('https://developers.google.com/chat/images/quickstart-app-avatar.png',).setImageStyle(CardService.ImageStyle.CIRCLE).setImageAltText('Avatar for Sasha');constcardSection=CardService.newCardSection().setHeader('Contact Info').setCollapsible(true).setNumUncollapsibleWidgets(1).addWidget(CardService.newDecoratedText().setStartIcon(CardService.newIconImage().setIcon(CardService.Icon.EMAIL)).setText('sasha@example.com'),).addWidget(CardService.newDecoratedText().setStartIcon(CardService.newIconImage().setIcon(CardService.Icon.PERSON)).setText('<font color="#80e27e">Online</font>'),).addWidget(CardService.newDecoratedText().setStartIcon(CardService.newIconImage().setIcon(CardService.Icon.PHONE)).setText('+1 (555) 555-1234'),).addWidget(CardService.newButtonSet().addButton(CardService.newTextButton().setText('Share').setOpenLink(CardService.newOpenLink().setUrl('https://example.com/share'),),).addButton(CardService.newTextButton().setText('Edit').setOnClickAction(CardService.newAction().setFunctionName('goToView').setParameters({viewType:'EDIT'}),),),);constcard=CardService.newCardBuilder().setHeader(cardHeader).addSection(cardSection).build();

Properties

Property	Type	Description
`BorderType`	`BorderType`	The`BorderType` enumeration.
`ChipListLayout`	`ChipListLayout`	The`ChipListLayout` enumeration.
`CommonDataSource`	`CommonDataSource`	The`CommonDataSource` enumeration.
`ComposedEmailType`	`ComposedEmailType`	The`ComposedEmailType` enumeration.
`ContentType`	`ContentType`	The`ContentType` enumeration.
`DriveItemType`	`DriveItemType`	The`DriveItemType` enumeration.
`ExpressionDataActionType`	`ExpressionDataActionType`	The`ExpressionDataActionType` enumeration.
`ExpressionDataConditionType`	`ExpressionDataConditionType`	The`ExpressionDataConditionType` enumeration.
`GridItemLayout`	`GridItemLayout`	The`GridItemLayout` enumeration.
`HorizontalAlignment`	`HorizontalAlignment`	The`HorizontalAlignment` enumeration.
`Icon`	`Icon`	The`Icon` enumeration.
`ImageButtonStyle`	`ImageButtonStyle`	The`ImageButtonStyle` enumeration.
`ImageCropType`	`ImageCropType`	The`ImageCropType` enumeration.
`ImageStyle`	`ImageStyle`	The`ImageStyle` enumeration.
`InputType`	`InputType`	The`InputType` enumeration.
`LoadIndicator`	`LoadIndicator`	The`LoadIndicator` enumeration.
`OnClose`	`OnClose`	The`OnClose` enumeration.
`OpenAs`	`OpenAs`	The`OpenAs` enumeration.
`SelectionInputType`	`SelectionInputType`	The`SelectionInputType` enumeration.
`TextButtonStyle`	`TextButtonStyle`	The`TextButtonStyle` enumeration.
`TextInputMode`	`TextInputMode`	The`TextInputMode` enumeration.
`UpdateDraftBodyType`	`UpdateDraftBodyType`	The`UpdateDraftBodyType` enumeration.
`VariableButtonSize`	`VariableButtonSize`	The`VariableButtonSize` enumeration.
`Visibility`	`Visibility`	The`Visibility` enumeration.
`WorkflowDataSourceType`	`WorkflowDataSourceType`	The`WorkflowDataSourceType` enumeration.

Methods

Method	Return type	Brief description
`newAction()`	`Action`	Creates a new`Action`.
`newActionResponseBuilder()`	`ActionResponseBuilder`	Creates a new`ActionResponseBuilder`.
`newActionStatus()`	`ActionStatus`	Creates a new`ActionStatus`.
`newAttachment()`	`Attachment`	Creates a new`Attachment`.
`newAuthorizationAction()`	`AuthorizationAction`	Creates a new`AuthorizationAction`.
`newAuthorizationException()`	`AuthorizationException`	Creates a new`AuthorizationException`.
`newBorderStyle()`	`BorderStyle`	Creates a new`BorderStyle`.
`newButtonSet()`	`ButtonSet`	Creates a new`ButtonSet`.
`newCalendarEventActionResponseBuilder()`	`CalendarEventActionResponseBuilder`	Creates a new`CalendarEventActionResponseBuilder`.
`newCardAction()`	`CardAction`	Creates a new`CardAction`.
`newCardBuilder()`	`CardBuilder`	Creates a new Card builder.
`newCardHeader()`	`CardHeader`	Creates a new`CardHeader`.
`newCardSection()`	`CardSection`	Creates a new`CardSection`.
`newCardWithId()`	`CardWithId`	Creates a new`CardWithId`.
`newCarousel()`	`Carousel`	Creates a`Carousel`.
`newCarouselCard()`	`CarouselCard`	Creates a new`CarouselCard`.
`newChatActionResponse()`	`ChatActionResponse`	Creates a new`ChatActionResponse`.
`newChatResponseBuilder()`	`ChatResponseBuilder`	Creates a new`ChatResponseBuilder`.
`newChip()`	`Chip`	Creates a new`Chip`.
`newChipList()`	`ChipList`	Creates a new`ChipList`.
`newCollapseControl()`	`CollapseControl`	Creates a new`CollapseControl`.
`newColumn()`	`Column`	Creates a new`Column`.
`newColumns()`	`Columns`	Creates a new set of`Columns`.
`newCommonWidgetAction()`	`CommonWidgetAction`	Creates a new`CommonWidgetAction`.
`newComposeActionResponseBuilder()`	`ComposeActionResponseBuilder`	Creates a new`ComposeActionResponseBuilder`.
`newCondition()`	`Condition`	Creates a new`Condition` used for client-side validation.
`newDataSourceConfig()`	`DataSourceConfig`	Creates a new, empty`DataSourceConfig`.
`newDatePicker()`	`DatePicker`	Creates a new`DatePicker`.
`newDateTimePicker()`	`DateTimePicker`	Creates a new`DateTimePicker`.
`newDecoratedText()`	`DecoratedText`	Creates a new`DecoratedText`.
`newDialog()`	`Dialog`	Creates a new`Dialog`.
`newDialogAction()`	`DialogAction`	Creates a new`DialogAction`.
`newDivider()`	`Divider`	Creates a new`Divider`.
`newDriveDataSourceSpec()`	`DriveDataSourceSpec`	Creates a new`DriveDataSourceSpec`.
`newDriveItemsSelectedActionResponseBuilder()`	`DriveItemsSelectedActionResponseBuilder`	Creates a new`DriveItemsSelectedActionResponseBuilder`.
`newEditorFileScopeActionResponseBuilder()`	`EditorFileScopeActionResponseBuilder`	Creates a new`EditorFileScopeActionResponseBuilder`.
`newEventAction()`	`EventAction`	Creates a new`EventAction` used for client-side validation.
`newExpressionData()`	`ExpressionData`	Creates a new`ExpressionData` used for client-side validation.
`newExpressionDataAction()`	`ExpressionDataAction`	Creates a new`ExpressionDataAction` used for client-side validation.
`newExpressionDataCondition()`	`ExpressionDataCondition`	Creates a new`ExpressionDataCondition` used for client-side validation.
`newFixedFooter()`	`FixedFooter`	Creates a new`FixedFooter`.
`newGrid()`	`Grid`	Creates a new`Grid`.
`newGridItem()`	`GridItem`	Creates a new`GridItem`.
`newHostAppDataSource()`	`HostAppDataSource`	Creates a new`HostAppDataSource`.
`newIconImage()`	`IconImage`	Creates a new`IconImage`.
`newImage()`	`Image`	Creates a new`Image`.
`newImageButton()`	`ImageButton`	Creates a new`ImageButton`.
`newImageComponent()`	`ImageComponent`	Creates a new`ImageComponent`.
`newImageCropStyle()`	`ImageCropStyle`	Creates a new`ImageCropStyle`.
`newKeyValue()`	`KeyValue`	Creates a new`KeyValue`.
`newLinkPreview()`	`LinkPreview`	Creates a new`LinkPreview`.
`newMaterialIcon()`	`MaterialIcon`	Creates a new`MaterialIcon`.
`newNavigation()`	`Navigation`	Creates a new`Navigation`.
`newNotification()`	`Notification`	Creates a new`Notification`.
`newOpenLink()`	`OpenLink`	Creates a new`OpenLink`.
`newOverflowMenu()`	`OverflowMenu`	Creates a new`OverflowMenu`.
`newOverflowMenuItem()`	`OverflowMenuItem`	Creates a new`OverflowMenuItem`.
`newPlatformDataSource()`	`PlatformDataSource`	Creates a new`PlatformDataSource`.
`newSelectionInput()`	`SelectionInput`	Creates a new`SelectionInput`.
`newSuggestions()`	`Suggestions`	Creates a new`Suggestions`.
`newSuggestionsResponseBuilder()`	`SuggestionsResponseBuilder`	Creates a new`SuggestionsResponseBuilder`.
`newSwitch()`	`Switch`	Creates a new`Switch`.
`newTextButton()`	`TextButton`	Creates a new`TextButton`.
`newTextInput()`	`TextInput`	Creates a new`TextInput`.
`newTextParagraph()`	`TextParagraph`	Creates a new`TextParagraph`.
`newTimePicker()`	`TimePicker`	Creates a new`TimePicker`.
`newTrigger()`	`Trigger`	Creates and returns a new`Trigger` used for client-side validation.
`newUniversalActionResponseBuilder()`	`UniversalActionResponseBuilder`	Creates a new`UniversalActionResponseBuilder`.
`newUpdateDraftActionResponseBuilder()`	`UpdateDraftActionResponseBuilder`	Creates a new`UpdateDraftActionResponseBuilder`.
`newUpdateDraftBccRecipientsAction()`	`UpdateDraftBccRecipientsAction`	Creates a new`UpdateDraftBccRecipientsAction`;
`newUpdateDraftBodyAction()`	`UpdateDraftBodyAction`	Creates a new`UpdateDraftBodyAction`.
`newUpdateDraftCcRecipientsAction()`	`UpdateDraftCcRecipientsAction`	Creates a new`UpdateDraftCcRecipientsAction`.
`newUpdateDraftSubjectAction()`	`UpdateDraftSubjectAction`	Creates a new`UpdateDraftSubjectAction`.
`newUpdateDraftToRecipientsAction()`	`UpdateDraftToRecipientsAction`	Creates a new`UpdateDraftToRecipientsAction`.
`newUpdateVisibilityAction()`	`UpdateVisibilityAction`	Creates a new`UpdateVisibilityAction`.
`newValidation()`	`Validation`	Creates a new`Validation`.
`newWorkflowDataSource()`	`WorkflowDataSource`	Creates a new`WorkflowDataSource`.

Detailed documentation

`newAction()`

Creates a newAction.

Return

Action — An empty Action.

`newActionResponseBuilder()`

Creates a newActionResponseBuilder.

Return

ActionResponseBuilder — An empty ActionResponse builder.

`newActionStatus()`

Creates a newActionStatus.

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

constactionStatus=CardService.newActionStatus().setStatusCode(CardService.Status.OK).setUserFacingMessage('Success');

Return

ActionStatus — An empty ActionStatus.

`newAttachment()`

Creates a newAttachment.

Return

Attachment — An empty attachment.

`newAuthorizationAction()`

Creates a newAuthorizationAction.

Return

AuthorizationAction — An empty AuthorizationAction.

`newAuthorizationException()`

Creates a newAuthorizationException.

Return

AuthorizationException — An empty AuthorizationException.

`newBorderStyle()`

Creates a newBorderStyle.

Return

BorderStyle — An empty BorderStyle.

`newButtonSet()`

Creates a newButtonSet.

Return

ButtonSet — An empty ButtonSet.

`newCalendarEventActionResponseBuilder()`

Creates a newCalendarEventActionResponseBuilder.

Return

CalendarEventActionResponseBuilder — An emptyCalendarEventActionResponseBuilder.

`newCardAction()`

Creates a newCardAction.

Return

CardAction — An empty CardAction.

`newCardBuilder()`

Creates a new Card builder.

Return

CardBuilder — An empty Card builder.

`newCardHeader()`

Creates a newCardHeader.

Return

CardHeader — An empty CardHeader.

`newCardSection()`

Creates a newCardSection.

Return

CardSection — An empty CardSection.

`newCardWithId()`

Creates a newCardWithId. This is used to send a card in a Google Chat message. card IDis 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.

constcardSection=CardService.newCardSection();cardSection.addWidget(CardService.newTextParagraph().setText('This is a text paragraph widget.'),);constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card title')).addSection(cardSection).build();constcardWithId=CardService.newCardWithId().setCardId('card_id').setCard(card);

Return

CardWithId — An emptyCardWithId.

`newCarousel()`

Creates aCarousel.

constcarousel=CardService.newCarousel().addCarouselCard(CardService.newCarouselCard().addWidget(CardService.newTextParagraph().setText('The first text paragraph in carousel'))).addCarouselCard(CardService.newCarouselCard().addWidget(CardService.newTextParagraph().setText('The second text paragraph in carousel'))).addCarouselCard(CardService.newCarouselCard().addWidget(CardService.newTextParagraph().setText('The third text paragraph in carousel')))

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

Return

Carousel — An empty Carousel.

`newCarouselCard()`

Creates a newCarouselCard.

constcarouselCard=CardService.newCarouselCard().addWidget(CardService.newTextParagraph().setText('Text paragraph in carousel'));

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

Return

CarouselCard — An empty Chip.

`newChatActionResponse()`

Creates a newChatActionResponse.

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

constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card title')).build();constdialog=CardService.newDialog().setBody(card);constdialogAction=CardService.newDialogAction().setDialog(dialog);constchatActionResponse=CardService.newChatActionResponse().setResponseType(CardService.ResponseType.DIALOG).setDialogAction(dialogAction);

Return

ChatActionResponse — An emptyChatActionResponse.

`newChatResponseBuilder()`

Creates a newChatResponseBuilder.

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

constcardSection=CardService.newCardSection();cardSection.addWidget(CardService.newTextParagraph().setText('This is a text paragraph widget.'),);constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card title')).addSection(cardSection).build();constcardWithId=CardService.newCardWithId().setCardId('card_id').setCard(card);constchatResponse=CardService.newChatResponseBuilder().addCardsV2(cardWithId).build();

Return

ChatResponseBuilder — An empty ChatResponseBuilder.

`newChip()`

Creates a newChip.

Available for Google Chat apps. In developer preview for Google Workspace add-ons.

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

constchip=CardService.newChip().setLabel('Open Link').setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'));

Return

Chip — An empty Chip.

`newChipList()`

Creates a newChipList.

Available for Google Chat apps. In developer preview for Google Workspace add-ons.

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

constchip=CardService.newChip();// Finish building the text chip...constchipList=CardService.newChipList().setLayout(CardService.ChipListLayout.WRAPPED).addChip(chip);

Return

ChipList — An empty ChipList.

`newCollapseControl()`

Creates a newCollapseControl.

Available for Google Chat apps. In developer preview for Google Workspace add-ons.

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

constcollapseControl=CardService.newCollapseControl().setHorizontalAlign(CardService.HorizontalAlignment.START).setExpandButton(CardService.newTextButton().setText('Expand')).setCollapseButton(CardService.newTextButton().setText('Collapse'));

Return

CollapseControl — An empty CollapseControl.

`newColumn()`

Creates a newColumn.

Available for Google Chat apps and Google Workspace add-ons.

constcolumnWidget=CardService.newTextParagraph();constcolumn=CardService.newColumn().setHorizontalSizeStyle(CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE).setHorizontalAlignment(CardService.HorizontalAlignment.CENTER).setVerticalAlignment(CardService.VerticalAlignment.CENTER).addWidget(columnWidget);

Return

Column — An empty Column.

`newColumns()`

Creates a new set ofColumns.

Available for Google Chat apps and Google Workspace add-ons.

constfirstColumn=CardService.newColumn().setHorizontalSizeStyle(CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE).setHorizontalAlignment(CardService.HorizontalAlignment.CENTER).setVerticalAlignment(CardService.VerticalAlignment.CENTER);constsecondColumn=CardService.newColumn().setHorizontalSizeStyle(CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE).setHorizontalAlignment(CardService.HorizontalAlignment.CENTER).setVerticalAlignment(CardService.VerticalAlignment.CENTER);constcolumns=CardService.newColumns().addColumn(firstColumn).addColumn(secondColumn).setWrapStyle(CardService.WrapStyle.WRAP);

Return

Columns — An empty set of Columns.

Return

ComposeActionResponseBuilder — An empty ComposeActionResponse builder.

`newCondition()`

Creates a newCondition used for client-side validation.

Return

Condition — An emptyCondition.

`newDataSourceConfig()`

Creates a new, emptyDataSourceConfig.

Return

DataSourceConfig — An emptyDataSourceConfig.

`newDatePicker()`

Creates a newDatePicker.

Return

DatePicker — An empty DatePicker.

`newDateTimePicker()`

Creates a newDateTimePicker.

Return

DateTimePicker — An empty DateTimePicker.

`newDecoratedText()`

Creates a newDecoratedText.

Return

DecoratedText — An empty DecoratedText.

`newDialog()`

Creates a newDialog.

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

constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card title')).build();// Sets the card of the dialog.constdialog=CardService.newDialog().setBody(card);

Return

Dialog — An emptyDialog.

`newDialogAction()`

Creates a newDialogAction.

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

constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card title')).build();constdialog=CardService.newDialog().setBody(card);constdialogAction=CardService.newDialogAction().setDialog(dialog);

Return

DialogAction — An emptyDialogAction.

`newDivider()`

Creates a newDivider. The following sample builds a simple card with 2 paragraphsseparated by a divider.

functionbuildCard(){constcardSection1TextParagraph1=CardService.newTextParagraph().setText('Hello world!');constcardSection1Divider1=CardService.newDivider();constcardSection1TextParagraph2=CardService.newTextParagraph().setText('Hello world!');constcardSection1=CardService.newCardSection().addWidget(cardSection1TextParagraph1).addWidget(cardSection1Divider1).addWidget(cardSection1TextParagraph2);constcard=CardService.newCardBuilder().addSection(cardSection1).build();returncard;}

Return

Divider — A divider.

`newDriveDataSourceSpec()`

Creates a newDriveDataSourceSpec.

Return

DriveDataSourceSpec — An emptyDriveDataSourceSpec.

`newDriveItemsSelectedActionResponseBuilder()`

Creates a newDriveItemsSelectedActionResponseBuilder.

Return

DriveItemsSelectedActionResponseBuilder — An emptyDriveItemsSelectedActionResponseBuilder.

`newEditorFileScopeActionResponseBuilder()`

Creates a newEditorFileScopeActionResponseBuilder.

Return

EditorFileScopeActionResponseBuilder — An emptyEditorFileScopeActionResponseBuilder.

`newEventAction()`

Creates a newEventAction used for client-side validation.

Return

EventAction — An emptyEventAction.

`newExpressionData()`

Creates a newExpressionData used for client-side validation.

Return

ExpressionData — An emptyExpressionData.

`newExpressionDataAction()`

Creates a newExpressionDataAction used for client-side validation.

Return

ExpressionDataAction — An emptyExpressionDataAction.

`newExpressionDataCondition()`

Creates a newExpressionDataCondition used for client-side validation.

Return

ExpressionDataCondition — An emptyExpressionDataCondition.

`newFixedFooter()`

Creates a newFixedFooter.

Return

FixedFooter — An empty FixedFooter.

`newGrid()`

Creates a newGrid.

Return

Grid — An empty Grid.

`newGridItem()`

Creates a newGridItem.

Return

GridItem — An empty GridItem.

`newHostAppDataSource()`

Creates a newHostAppDataSource.

Return

HostAppDataSource — AHostAppDataSource.

`newIconImage()`

Creates a newIconImage.

Return

IconImage — An empty icon image.

`newImage()`

Creates a newImage.

Return

Image — An empty Image.

`newImageButton()`

Creates a newImageButton.

Return

ImageButton — An empty ImageButton.

`newImageComponent()`

Creates a newImageComponent.

Return

ImageComponent — An empty ImageComponent.

`newImageCropStyle()`

Creates a newImageCropStyle.

Return

ImageCropStyle — An empty ImageCropStyle.

`newKeyValue()`

Creates a newKeyValue.

Return

KeyValue — An empty KeyValue.

`newLinkPreview()`

Creates a newLinkPreview.

constdecoratedText=CardService.newDecoratedText().setTopLabel('Hello').setText('Hi!');constcardSection=CardService.newCardSection().addWidget(decoratedText);constcard=CardService.newCardBuilder().addSection(cardSection).build();constlinkPreview=CardService.newLinkPreview().setPreviewCard(card).setTitle('Smart chip title');

Return

LinkPreview — An empty LinkPreview.

`newMaterialIcon()`

Creates a newMaterialIcon.

Available for Google Chat apps and Google Workspace add-ons.

constmaterialIcon=CardService.newMaterialIcon().setName('check_box').setFill(true);constcardSection=CardService.newCardSection();cardSection.addWidget(CardService.newDecoratedText().setStartIcon(CardService.newIconImage().setMaterialIcon(materialIcon)).setText('sasha@example.com'),);constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card Title')).addSection(cardSection).build();

Return

MaterialIcon — An empty MaterialIcon.

`newNavigation()`

Creates a newNavigation.

Return

Navigation — An empty Navigation.

`newNotification()`

Creates a newNotification.

Return

Notification — An empty Notification.

`newOpenLink()`

Creates a newOpenLink.

Return

OpenLink — An empty OpenLink.

`newOverflowMenu()`

Creates a newOverflowMenu.

Available for Google Chat apps. In developer preview for Google Workspace add-ons.

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

constoverflowMenuItem=CardService.newOverflowMenuItem();// Finish building the overflow menu item...constoverflowMenu=CardService.newOverflowMenu().addMenuItem(overflowMenuItem);

Return

OverflowMenu — An empty OverflowMenu.

`newOverflowMenuItem()`

Creates a newOverflowMenuItem.

Available for Google Chat apps. In developer preview for Google Workspace add-ons.

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

constoverflowMenuItem=CardService.newOverflowMenuItem().setStartIcon(CardService.newIconImage().setIconUrl('https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',),).setText('Open Link').setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'));

Return

OverflowMenuItem — An empty OverflowMenuItem.

`newPlatformDataSource()`

Creates a newPlatformDataSource.

Return

PlatformDataSource — An emptyPlatformDataSource.

`newSelectionInput()`

Creates a newSelectionInput.

Return

SelectionInput — An empty SelectionInput.

`newSuggestions()`

Creates a newSuggestions.

Return

Suggestions — An empty Suggestions.

`newSuggestionsResponseBuilder()`

Creates a newSuggestionsResponseBuilder.

Return

SuggestionsResponseBuilder — An empty SuggestionsResponse builder.

`newSwitch()`

Creates a newSwitch.

Return

Switch — An empty Switch.

`newTextButton()`

Creates a newTextButton.

Return

TextButton — An empty TextButton.

`newTextInput()`

Creates a newTextInput.

Return

TextInput — An empty TextInput.

`newTextParagraph()`

Creates a newTextParagraph.

Return

TextParagraph — An empty TextParagraph.

`newTimePicker()`

Creates a newTimePicker.

Return

TimePicker — An empty TimePicker.

`newTrigger()`

Creates and returns a newTrigger used for client-side validation.

Return

Trigger — An emptyTrigger.

`newUniversalActionResponseBuilder()`

Creates a newUniversalActionResponseBuilder.

Return

UniversalActionResponseBuilder — An empty UniversalActionResponse builder.

`newUpdateDraftActionResponseBuilder()`

Creates a newUpdateDraftActionResponseBuilder.

Return

UpdateDraftActionResponseBuilder — An empty UpdateDraftActionResponseBuilder.

`newUpdateDraftBccRecipientsAction()`

Creates a newUpdateDraftBccRecipientsAction;

Return

UpdateDraftBccRecipientsAction — An empty UpdateDraftBccRecipientsAction.

`newUpdateDraftBodyAction()`

Creates a newUpdateDraftBodyAction.

Return

UpdateDraftBodyAction — An empty UpdateDraftBodyAction.

`newUpdateDraftCcRecipientsAction()`

Creates a newUpdateDraftCcRecipientsAction.

Return

UpdateDraftCcRecipientsAction — An Empty UpdateDraftCcRecipientsAction.

`newUpdateDraftSubjectAction()`

Creates a newUpdateDraftSubjectAction.

Return

UpdateDraftSubjectAction — An empty UpdateDraftSubjectAction.

`newUpdateDraftToRecipientsAction()`

Creates a newUpdateDraftToRecipientsAction.

Return

UpdateDraftToRecipientsAction — An empty UpdateDraftToRecipientsAction.

`newUpdateVisibilityAction()`

Creates a newUpdateVisibilityAction.

Return

UpdateVisibilityAction — An emptyUpdateVisibilityAction.

`newValidation()`

Creates a newValidation.

Available for Google Chat apps and Google Workspace add-ons.

constvalidation=CardService.newValidation().setCharacterLimit(5).setInputType(CardService.InputType.EMAIL);

Developer Preview: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features.

Return

Validation — An empty validation.

`newWorkflowDataSource()`

Creates a newWorkflowDataSource.

Return

WorkflowDataSource — An emptyWorkflowDataSource.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-03 UTC.

Movatterモバイル変換

Class CardService Stay organized with collections Save and categorize content based on your preferences.

Page Summary

Properties

Methods

Detailed documentation

newAction()

Return

newActionResponseBuilder()

Return

newActionStatus()

Return

newAttachment()

Return

newAuthorizationAction()

Return

newAuthorizationException()

Return

newBorderStyle()

Return

newButtonSet()

Return

newCalendarEventActionResponseBuilder()

Return

newCardAction()

Return

newCardBuilder()

Return

newCardHeader()

Return

newCardSection()

Return

newCardWithId()

Return

newCarousel()

Return

newCarouselCard()

Return

newChatActionResponse()

Return

newChatResponseBuilder()

Return

newChip()

Return

newChipList()

Return

newCollapseControl()

Return

newColumn()

Return

newColumns()

Return

newCommonWidgetAction()

Return

newComposeActionResponseBuilder()

Return

newCondition()

Return

newDataSourceConfig()

Return

newDatePicker()

Return

newDateTimePicker()

Return

newDecoratedText()

Return

newDialog()

Return

newDialogAction()

Return

newDivider()

Return

newDriveDataSourceSpec()

Return

newDriveItemsSelectedActionResponseBuilder()

Return

newEditorFileScopeActionResponseBuilder()

Return

newEventAction()

Return

Class CardService

`newAction()`

`newActionResponseBuilder()`

`newActionStatus()`

`newAttachment()`

`newAuthorizationAction()`

`newAuthorizationException()`

`newBorderStyle()`

`newButtonSet()`

`newCalendarEventActionResponseBuilder()`

`newCardAction()`

`newCardBuilder()`

`newCardHeader()`

`newCardSection()`

`newCardWithId()`

`newCarousel()`

`newCarouselCard()`

`newChatActionResponse()`

`newChatResponseBuilder()`

`newChip()`

`newChipList()`

`newCollapseControl()`

`newColumn()`

`newColumns()`

`newCommonWidgetAction()`

`newComposeActionResponseBuilder()`

`newCondition()`

`newDataSourceConfig()`

`newDatePicker()`

`newDateTimePicker()`

`newDecoratedText()`

`newDialog()`

`newDialogAction()`

`newDivider()`

`newDriveDataSourceSpec()`

`newDriveItemsSelectedActionResponseBuilder()`

`newEditorFileScopeActionResponseBuilder()`

`newEventAction()`

`newExpressionData()`

`newExpressionDataAction()`

`newExpressionDataCondition()`

`newFixedFooter()`

`newGrid()`

`newGridItem()`

`newHostAppDataSource()`

`newIconImage()`

`newImage()`

`newImageButton()`

`newImageComponent()`

`newImageCropStyle()`

`newKeyValue()`

`newLinkPreview()`

`newMaterialIcon()`

`newNavigation()`

`newNotification()`

`newOpenLink()`

`newOverflowMenu()`

`newOverflowMenuItem()`

`newPlatformDataSource()`

`newSelectionInput()`

`newSuggestions()`

`newSuggestionsResponseBuilder()`

`newSwitch()`

`newTextButton()`

`newTextInput()`

`newTextParagraph()`

`newTimePicker()`

`newTrigger()`

`newUniversalActionResponseBuilder()`

`newUpdateDraftActionResponseBuilder()`

`newUpdateDraftBccRecipientsAction()`

`newUpdateDraftBodyAction()`

`newUpdateDraftCcRecipientsAction()`