Class CardService

CardService

CardService provides the ability to create generic cards used across different Google extensibility products, such as Google Workspace Add-ons .

Below is a sample for an add-ons card.

function createCard() {
  return CardService.newCardBuilder()
      .setHeader(CardService.newCardHeader().setTitle('CardTitle'))
      .build();
}

Or you can return multiple Cards like so:

function createCards() {
  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:

 function 
  
 createWidgetDemoCard 
 () 
  
 { 
  
 return 
  
 CardService 
 . 
 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.

 const 
  
 cardHeader 
  
 = 
  
 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' 
 ); 
 const 
  
 cardSection 
  
 = 
  
 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' 
 }), 
  
 ), 
  
 ), 
  
 ); 
 const 
  
 card 
  
 = 
  
 CardService 
 . 
 newCardBuilder 
 () 
  
 . 
 setHeader 
 ( 
 cardHeader 
 ) 
  
 . 
 addSection 
 ( 
 cardSection 
 ) 
  
 . 
 build 
 ();

Properties

Property Type Description
BorderType
BorderType The BorderType enumeration.
ChipListLayout
ChipListLayout The ChipListLayout enumeration.
ComposedEmailType
ComposedEmailType The ComposedEmailType enumeration.
ContentType
ContentType The ContentType 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.
UpdateDraftBodyType
UpdateDraftBodyType The UpdateDraftBodyType 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 .
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 .
newComposeActionResponseBuilder()
ComposeActionResponseBuilder Creates a new ComposeActionResponseBuilder .
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 .
newDriveItemsSelectedActionResponseBuilder()
DriveItemsSelectedActionResponseBuilder Creates a new DriveItemsSelectedActionResponseBuilder .
newEditorFileScopeActionResponseBuilder()
EditorFileScopeActionResponseBuilder Creates a new EditorFileScopeActionResponseBuilder .
newFixedFooter()
FixedFooter Creates a new FixedFooter .
newGrid()
Grid Creates a new Grid .
newGridItem()
GridItem Creates a new GridItem .
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 .
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 .
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 .
newValidation()
Validation Creates a new Validation .

Detailed documentation

newAction()

Creates a new Action .

Return

Action — An empty Action.

newActionResponseBuilder()

Creates a new ActionResponseBuilder .

Return

ActionResponseBuilder — An empty ActionResponse builder.

newActionStatus()

Creates a new ActionStatus .

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

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

Return

ActionStatus — An empty ActionStatus.

newAttachment()

Creates a new Attachment .

Return

Attachment — An empty attachment.

newAuthorizationAction()

Creates a new AuthorizationAction .

Return

AuthorizationAction — An empty AuthorizationAction.

newAuthorizationException()

Creates a new AuthorizationException .

Return

AuthorizationException — An empty AuthorizationException.

newBorderStyle()

Creates a new BorderStyle .

Return

BorderStyle — An empty BorderStyle.

newButtonSet()

Creates a new ButtonSet .

Return

ButtonSet — An empty ButtonSet.

newCalendarEventActionResponseBuilder()

newCardAction()

Creates a new CardAction .

Return

CardAction — An empty CardAction.

newCardBuilder()

Creates a new Card builder.

Return

CardBuilder — An empty Card builder.

newCardHeader()

Creates a new CardHeader .

Return

CardHeader — An empty CardHeader.

newCardSection()

Creates a new CardSection .

Return

CardSection — An empty CardSection.

newCardWithId()

Creates a new CardWithId . This is used to send a card in a Google Chat message. card ID 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 
 );

Return

CardWithId — An empty CardWithId .

newChatActionResponse()

Creates a new ChatActionResponse .

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

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

Return

ChatActionResponse — An empty ChatActionResponse .

newChatResponseBuilder()

Creates a new ChatResponseBuilder .

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 
 ); 
 const 
  
 chatResponse 
  
 = 
  
 CardService 
 . 
 newChatResponseBuilder 
 () 
 . 
 addCardsV2 
 ( 
 cardWithId 
 ) 
 . 
 build 
 ();

Return

ChatResponseBuilder — An empty ChatResponseBuilder.

newChip()

Creates a new Chip .

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

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

Return

Chip — An empty Chip.

newChipList()

Creates a new ChipList .

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

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

Return

ChipList — An empty ChipList.

newCollapseControl()

Creates a new CollapseControl .

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

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

Return

CollapseControl — An empty CollapseControl.

newColumn()

Creates a new Column .

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

 const 
  
 columnWidget 
  
 = 
  
 CardService 
 . 
 newTextParagraph 
 (); 
 const 
  
 column 
  
 = 
  
 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 of Columns .

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

 const 
  
 firstColumn 
  
 = 
  
 CardService 
 . 
 newColumn 
 () 
  
 . 
 setHorizontalSizeStyle 
 ( 
  
 CardService 
 . 
 HorizontalSizeStyle 
 . 
 FILL_AVAILABLE_SPACE 
 ) 
  
 . 
 setHorizontalAlignment 
 ( 
 CardService 
 . 
 HorizontalAlignment 
 . 
 CENTER 
 ) 
  
 . 
 setVerticalAlignment 
 ( 
 CardService 
 . 
 VerticalAlignment 
 . 
 CENTER 
 ); 
 const 
  
 secondColumn 
  
 = 
  
 CardService 
 . 
 newColumn 
 () 
  
 . 
 setHorizontalSizeStyle 
 ( 
  
 CardService 
 . 
 HorizontalSizeStyle 
 . 
 FILL_AVAILABLE_SPACE 
 ) 
  
 . 
 setHorizontalAlignment 
 ( 
 CardService 
 . 
 HorizontalAlignment 
 . 
 CENTER 
 ) 
  
 . 
 setVerticalAlignment 
 ( 
 CardService 
 . 
 VerticalAlignment 
 . 
 CENTER 
 ); 
 const 
  
 columns 
  
 = 
  
 CardService 
 . 
 newColumns 
 () 
  
 . 
 addColumn 
 ( 
 column 
 ) 
  
 . 
 addColumn 
 ( 
 secondColumn 
 ) 
  
 . 
 setWrapStyle 
 ( 
 CardService 
 . 
 WrapStyle 
 . 
 WRAP 
 );

Return

Columns — An empty set of Columns.

newComposeActionResponseBuilder()

Creates a new ComposeActionResponseBuilder .

Return

ComposeActionResponseBuilder — An empty ComposeActionResponse builder.

newDatePicker()

Creates a new DatePicker .

Return

DatePicker — An empty DatePicker.

newDateTimePicker()

Creates a new DateTimePicker .

Return

DateTimePicker — An empty DateTimePicker.

newDecoratedText()

Creates a new DecoratedText .

Return

DecoratedText — An empty DecoratedText.

newDialog()

Creates a new Dialog .

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

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

Return

Dialog — An empty Dialog .

newDialogAction()

Creates a new DialogAction .

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

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

Return

DialogAction — An empty DialogAction .

newDivider()

Creates a new Divider . The following sample builds a simple card with 2 paragraphs separated by a divider.

 function 
  
 buildCard 
 () 
  
 { 
  
 const 
  
 cardSection1TextParagraph1 
  
 = 
  
 CardService 
 . 
 newTextParagraph 
 () 
 . 
 setText 
 ( 
 'Hello world!' 
 ); 
  
 const 
  
 cardSection1Divider1 
  
 = 
  
 CardService 
 . 
 newDivider 
 (); 
  
 const 
  
 cardSection1TextParagraph2 
  
 = 
  
 CardService 
 . 
 newTextParagraph 
 () 
 . 
 setText 
 ( 
 'Hello world!' 
 ); 
  
 const 
  
 cardSection1 
  
 = 
  
 CardService 
 . 
 newCardSection 
 () 
  
 . 
 addWidget 
 ( 
 cardSection1TextParagraph1 
 ) 
  
 . 
 addWidget 
 ( 
 cardSection1Divider1 
 ) 
  
 . 
 addWidget 
 ( 
 cardSection1TextParagraph2 
 ); 
  
 const 
  
 card 
  
 = 
  
 CardService 
 . 
 newCardBuilder 
 () 
 . 
 addSection 
 ( 
 cardSection1 
 ) 
 . 
 build 
 (); 
  
 return 
  
 card 
 ; 
 }

Return

Divider — A divider.

newDriveItemsSelectedActionResponseBuilder()

newEditorFileScopeActionResponseBuilder()

newFixedFooter()

Creates a new FixedFooter .

Return

FixedFooter — An empty FixedFooter.

newGrid()

Creates a new Grid .

Return

Grid — An empty Grid.

newGridItem()

Creates a new GridItem .

Return

GridItem — An empty GridItem.

newIconImage()

Creates a new IconImage .

Return

IconImage — An empty icon image.

newImage()

Creates a new Image .

Return

Image — An empty Image.

newImageButton()

Creates a new ImageButton .

Return

ImageButton — An empty ImageButton.

newImageComponent()

Creates a new ImageComponent .

Return

ImageComponent — An empty ImageComponent.

newImageCropStyle()

Creates a new ImageCropStyle .

Return

ImageCropStyle — An empty ImageCropStyle.

newKeyValue()

Creates a new KeyValue .

Return

KeyValue — An empty KeyValue.

newLinkPreview()

Creates a new LinkPreview .

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

Return

LinkPreview — An empty LinkPreview.

newMaterialIcon()

Creates a new MaterialIcon .

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

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

Return

MaterialIcon — An empty MaterialIcon.

newNavigation()

Creates a new Navigation .

Return

Navigation — An empty Navigation.

newNotification()

Creates a new Notification .

Return

Notification — An empty Notification.

Creates a new OpenLink .

Return

OpenLink — An empty OpenLink.

newOverflowMenu()

Creates a new OverflowMenu .

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

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

Return

OverflowMenu — An empty OverflowMenu.

newOverflowMenuItem()

Creates a new OverflowMenuItem .

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

 const 
  
 overflowMenuItem 
  
 = 
  
 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.

newSelectionInput()

Creates a new SelectionInput .

Return

SelectionInput — An empty SelectionInput.

newSuggestions()

Creates a new Suggestions .

Return

Suggestions — An empty Suggestions.

newSuggestionsResponseBuilder()

Creates a new SuggestionsResponseBuilder .

Return

SuggestionsResponseBuilder — An empty SuggestionsResponse builder.

newSwitch()

Creates a new Switch .

Return

Switch — An empty Switch.

newTextButton()

Creates a new TextButton .

Return

TextButton — An empty TextButton.

newTextInput()

Creates a new TextInput .

Return

TextInput — An empty TextInput.

newTextParagraph()

Creates a new TextParagraph .

Return

TextParagraph — An empty TextParagraph.

newTimePicker()

Creates a new TimePicker .

Return

TimePicker — An empty TimePicker.

newUniversalActionResponseBuilder()

Creates a new UniversalActionResponseBuilder .

Return

UniversalActionResponseBuilder — An empty UniversalActionResponse builder.

newUpdateDraftActionResponseBuilder()

Creates a new UpdateDraftActionResponseBuilder .

Return

UpdateDraftActionResponseBuilder — An empty UpdateDraftActionResponseBuilder.

newUpdateDraftBccRecipientsAction()

Creates a new UpdateDraftBccRecipientsAction ;

Return

UpdateDraftBccRecipientsAction — An empty UpdateDraftBccRecipientsAction.

newUpdateDraftBodyAction()

Creates a new UpdateDraftBodyAction .

Return

UpdateDraftBodyAction — An empty UpdateDraftBodyAction.

newUpdateDraftCcRecipientsAction()

Creates a new UpdateDraftCcRecipientsAction .

Return

UpdateDraftCcRecipientsAction — An Empty UpdateDraftCcRecipientsAction.

newUpdateDraftSubjectAction()

Creates a new UpdateDraftSubjectAction .

Return

UpdateDraftSubjectAction — An empty UpdateDraftSubjectAction.

newUpdateDraftToRecipientsAction()

Creates a new UpdateDraftToRecipientsAction .

Return

UpdateDraftToRecipientsAction — An empty UpdateDraftToRecipientsAction.

newValidation()

Creates a new Validation .

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

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

Return

Validation — An empty validation.