Class CardService

Card Service

Card Service 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
`Border Type`	`Border Type`	The `Border Type` enumeration.
`Chip List Layout`	`Chip List Layout`	The `Chip List Layout` enumeration.
`Composed Email Type`	`Composed Email Type`	The `Composed Email Type` enumeration.
`Content Type`	`Content Type`	The `Content Type` enumeration.
`Grid Item Layout`	`Grid Item Layout`	The `Grid Item Layout` enumeration.
`Horizontal Alignment`	`Horizontal Alignment`	The `Horizontal Alignment` enumeration.
`Icon`	`Icon`	The `Icon` enumeration.
`Image Button Style`	`Image Button Style`	The `Image Button Style` enumeration.
`Image Crop Type`	`Image Crop Type`	The `Image Crop Type` enumeration.
`Image Style`	`Image Style`	The `Image Style` enumeration.
`Input Type`	`Input Type`	The `Input Type` enumeration.
`Load Indicator`	`Load Indicator`	The `Load Indicator` enumeration.
`On Close`	`On Close`	The `On Close` enumeration.
`Open As`	`Open As`	The `Open As` enumeration.
`Selection Input Type`	`Selection Input Type`	The `Selection Input Type` enumeration.
`Text Button Style`	`Text Button Style`	The `Text Button Style` enumeration.
`Update Draft Body Type`	`Update Draft Body Type`	The `Update Draft Body Type` enumeration.

Methods

Method	Return type	Brief description
`new Action()`	`Action`	Creates a new `Action` .
`new Action Response Builder()`	`Action Response Builder`	Creates a new `Action Response Builder` .
`new Action Status()`	`Action Status`	Creates a new `Action Status` .
`new Attachment()`	`Attachment`	Creates a new `Attachment` .
`new Authorization Action()`	`Authorization Action`	Creates a new `Authorization Action` .
`new Authorization Exception()`	`Authorization Exception`	Creates a new `Authorization Exception` .
`new Border Style()`	`Border Style`	Creates a new `Border Style` .
`new Button Set()`	`Button Set`	Creates a new `Button Set` .
`new Calendar Event Action Response Builder()`	`Calendar Event Action Response Builder`	Creates a new `Calendar Event Action Response Builder` .
`new Card Action()`	`Card Action`	Creates a new `Card Action` .
`new Card Builder()`	`Card Builder`	Creates a new Card builder.
`new Card Header()`	`Card Header`	Creates a new `Card Header` .
`new Card Section()`	`Card Section`	Creates a new `Card Section` .
`new Card With Id()`	`Card With Id`	Creates a new `Card With Id` .
`new Carousel()`	`Carousel`	Creates a `Carousel` .
`new Carousel Card()`	`Carousel Card`	Creates a new `Carousel Card` .
`new Chat Action Response()`	`Chat Action Response`	Creates a new `Chat Action Response` .
`new Chat Response Builder()`	`Chat Response Builder`	Creates a new `Chat Response Builder` .
`new Chip()`	`Chip`	Creates a new `Chip` .
`new Chip List()`	`Chip List`	Creates a new `Chip List` .
`new Collapse Control()`	`Collapse Control`	Creates a new `Collapse Control` .
`new Column()`	`Column`	Creates a new `Column` .
`new Columns()`	`Columns`	Creates a new set of `Columns` .
`new Compose Action Response Builder()`	`Compose Action Response Builder`	Creates a new `Compose Action Response Builder` .
`new Date Picker()`	`Date Picker`	Creates a new `Date Picker` .
`new Date Time Picker()`	`Date Time Picker`	Creates a new `Date Time Picker` .
`new Decorated Text()`	`Decorated Text`	Creates a new `Decorated Text` .
`new Dialog()`	`Dialog`	Creates a new `Dialog` .
`new Dialog Action()`	`Dialog Action`	Creates a new `Dialog Action` .
`new Divider()`	`Divider`	Creates a new `Divider` .
`new Drive Items Selected Action Response Builder()`	`Drive Items Selected Action Response Builder`	Creates a new `Drive Items Selected Action Response Builder` .
`new Editor File Scope Action Response Builder()`	`Editor File Scope Action Response Builder`	Creates a new `Editor File Scope Action Response Builder` .
`new Fixed Footer()`	`Fixed Footer`	Creates a new `Fixed Footer` .
`new Grid()`	`Grid`	Creates a new `Grid` .
`new Grid Item()`	`Grid Item`	Creates a new `Grid Item` .
`new Icon Image()`	`Icon Image`	Creates a new `Icon Image` .
`new Image()`	`Image`	Creates a new `Image` .
`new Image Button()`	`Image Button`	Creates a new `Image Button` .
`new Image Component()`	`Image Component`	Creates a new `Image Component` .
`new Image Crop Style()`	`Image Crop Style`	Creates a new `Image Crop Style` .
`new Key Value()`	~~`Key Value`~~	Creates a new ~~`Key Value`~~ .
`new Link Preview()`	`Link Preview`	Creates a new `Link Preview` .
`new Material Icon()`	`Material Icon`	Creates a new `Material Icon` .
`new Navigation()`	`Navigation`	Creates a new `Navigation` .
`new Notification()`	`Notification`	Creates a new `Notification` .
`new Open Link()`	`Open Link`	Creates a new `Open Link` .
`new Overflow Menu()`	`Overflow Menu`	Creates a new `Overflow Menu` .
`new Overflow Menu Item()`	`Overflow Menu Item`	Creates a new `Overflow Menu Item` .
`new Selection Input()`	`Selection Input`	Creates a new `Selection Input` .
`new Suggestions()`	`Suggestions`	Creates a new `Suggestions` .
`new Suggestions Response Builder()`	`Suggestions Response Builder`	Creates a new `Suggestions Response Builder` .
`new Switch()`	`Switch`	Creates a new `Switch` .
`new Text Button()`	`Text Button`	Creates a new `Text Button` .
`new Text Input()`	`Text Input`	Creates a new `Text Input` .
`new Text Paragraph()`	`Text Paragraph`	Creates a new `Text Paragraph` .
`new Time Picker()`	`Time Picker`	Creates a new `Time Picker` .
`new Universal Action Response Builder()`	`Universal Action Response Builder`	Creates a new `Universal Action Response Builder` .
`new Update Draft Action Response Builder()`	`Update Draft Action Response Builder`	Creates a new `Update Draft Action Response Builder` .
`new Update Draft Bcc Recipients Action()`	`Update Draft Bcc Recipients Action`	Creates a new `Update Draft Bcc Recipients Action` ;
`new Update Draft Body Action()`	`Update Draft Body Action`	Creates a new `Update Draft Body Action` .
`new Update Draft Cc Recipients Action()`	`Update Draft Cc Recipients Action`	Creates a new `Update Draft Cc Recipients Action` .
`new Update Draft Subject Action()`	`Update Draft Subject Action`	Creates a new `Update Draft Subject Action` .
`new Update Draft To Recipients Action()`	`Update Draft To Recipients Action`	Creates a new `Update Draft To Recipients Action` .
`new Validation()`	`Validation`	Creates a new `Validation` .

Detailed documentation

`new Action()`

Creates a new Action .

Return

Action — An empty Action.

`new Action Response Builder()`

Creates a new Action Response Builder .

Return

Action Response Builder — An empty ActionResponse builder.

`new Action Status()`

Creates a new Action Status .

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

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

Return

Action Status — An empty ActionStatus.

`new Attachment()`

Creates a new Attachment .

Return

Attachment — An empty attachment.

`new Authorization Action()`

Creates a new Authorization Action .

Return

Authorization Action — An empty AuthorizationAction.

`new Authorization Exception()`

Creates a new Authorization Exception .

Return

Authorization Exception — An empty AuthorizationException.

`new Border Style()`

Creates a new Border Style .

Return

Border Style — An empty BorderStyle.

`new Button Set()`

Creates a new Button Set .

Return

Button Set — An empty ButtonSet.

`new Calendar Event Action Response Builder()`

Creates a new Calendar Event Action Response Builder .

Return

Calendar Event Action Response Builder — An empty Calendar Event Action Response Builder .

`new Card Action()`

Creates a new Card Action .

Return

Card Action — An empty CardAction.

`new Card Builder()`

Creates a new Card builder.

Return

Card Builder — An empty Card builder.

`new Card Header()`

Creates a new Card Header .

Return

Card Header — An empty CardHeader.

`new Card Section()`

Creates a new Card Section .

Return

Card Section — An empty CardSection.

`new Card With Id()`

Creates a new Card With Id . 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

Card With Id — An empty Card With Id .

`new Carousel()`

Creates a Carousel .

 const 
  
 carousel 
  
 = 
  
 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' 
 )))

Return

Carousel — An empty Carousel.

`new Carousel Card()`

Creates a new Carousel Card .

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

Return

Carousel Card — An empty Chip.

`new Chat Action Response()`

Creates a new Chat Action Response .

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

Chat Action Response — An empty Chat Action Response .

`new Chat Response Builder()`

Creates a new Chat Response Builder .

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

Chat Response Builder — An empty ChatResponseBuilder.

`new Chip()`

Creates a new Chip .

Available for Google Chat apps. In developer preview 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.

`new Chip List()`

Creates a new Chip List .

Available for Google Chat apps. In developer preview 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

Chip List — An empty ChipList.

`new Collapse Control()`

Creates a new Collapse Control .

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

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

Return

Collapse Control — An empty CollapseControl.

`new Column()`

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.

`new Columns()`

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 
 ( 
 firstColumn 
 ) 
  
 . 
 addColumn 
 ( 
 secondColumn 
 ) 
  
 . 
 setWrapStyle 
 ( 
 CardService 
 . 
 WrapStyle 
 . 
 WRAP 
 );

Return

Columns — An empty set of Columns.

`new Compose Action Response Builder()`

Creates a new Compose Action Response Builder .

Return

Compose Action Response Builder — An empty ComposeActionResponse builder.

`new Date Picker()`

Creates a new Date Picker .

Return

Date Picker — An empty DatePicker.

`new Date Time Picker()`

Creates a new Date Time Picker .

Return

Date Time Picker — An empty DateTimePicker.

`new Decorated Text()`

Creates a new Decorated Text .

Return

Decorated Text — An empty DecoratedText.

`new Dialog()`

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 .

`new Dialog Action()`

Creates a new Dialog Action .

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

Dialog Action — An empty Dialog Action .

`new Divider()`

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.

`new Fixed Footer()`

Creates a new Fixed Footer .

Return

Fixed Footer — An empty FixedFooter.

`new Grid()`

Creates a new Grid .

Return

Grid — An empty Grid.

`new Grid Item()`

Creates a new Grid Item .

Return

Grid Item — An empty GridItem.

`new Icon Image()`

Creates a new Icon Image .

Return

Icon Image — An empty icon image.

`new Image()`

Creates a new Image .

Return

Image — An empty Image.

`new Image Button()`

Creates a new Image Button .

Return

Image Button — An empty ImageButton.

`new Image Component()`

Creates a new Image Component .

Return

Image Component — An empty ImageComponent.

`new Image Crop Style()`

Creates a new Image Crop Style .

Return

Image Crop Style — An empty ImageCropStyle.

`new Key Value()`

Creates a new ~~Key Value~~ .

Return

~~Key Value~~ — An empty KeyValue.

`new Link Preview()`

Creates a new Link Preview .

 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

Link Preview — An empty LinkPreview.

`new Material Icon()`

Creates a new Material Icon .

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

Material Icon — An empty MaterialIcon.

`new Navigation()`

Creates a new Navigation .

Return

Navigation — An empty Navigation.

`new Notification()`

Creates a new Notification .

Return

Notification — An empty Notification.

`new Open Link()`

Creates a new Open Link .

Return

Open Link — An empty OpenLink.

`new Overflow Menu()`

Creates a new Overflow Menu .

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

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

Return

Overflow Menu — An empty OverflowMenu.

`new Overflow Menu Item()`

Creates a new Overflow Menu Item .

Available for Google Chat apps. In developer preview 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

Overflow Menu Item — An empty OverflowMenuItem.

`new Selection Input()`

Creates a new Selection Input .

Return

Selection Input — An empty SelectionInput.

`new Suggestions()`

Creates a new Suggestions .

Return

Suggestions — An empty Suggestions.

`new Suggestions Response Builder()`

Creates a new Suggestions Response Builder .

Return

Suggestions Response Builder — An empty SuggestionsResponse builder.

`new Switch()`

Creates a new Switch .

Return

Switch — An empty Switch.

`new Text Button()`

Creates a new Text Button .

Return

Text Button — An empty TextButton.

`new Text Input()`

Creates a new Text Input .

Return

Text Input — An empty TextInput.

`new Text Paragraph()`

Creates a new Text Paragraph .

Return

Text Paragraph — An empty TextParagraph.

`new Time Picker()`

Creates a new Time Picker .

Return

Time Picker — An empty TimePicker.

`new Universal Action Response Builder()`

Creates a new Universal Action Response Builder .

Return

Universal Action Response Builder — An empty UniversalActionResponse builder.

`new Update Draft Action Response Builder()`

Creates a new Update Draft Action Response Builder .

Return

Update Draft Action Response Builder — An empty UpdateDraftActionResponseBuilder.

`new Update Draft Bcc Recipients Action()`

Creates a new Update Draft Bcc Recipients Action ;

Return

Update Draft Bcc Recipients Action — An empty UpdateDraftBccRecipientsAction.

`new Update Draft Body Action()`

Creates a new Update Draft Body Action .

Return

Update Draft Body Action — An empty UpdateDraftBodyAction.

`new Update Draft Cc Recipients Action()`

Creates a new Update Draft Cc Recipients Action .

Return

Update Draft Cc Recipients Action — An Empty UpdateDraftCcRecipientsAction.

`new Update Draft Subject Action()`

Creates a new Update Draft Subject Action .

Return

Update Draft Subject Action — An empty UpdateDraftSubjectAction.

`new Update Draft To Recipients Action()`

Creates a new Update Draft To Recipients Action .

Return

Update Draft To Recipients Action — An empty UpdateDraftToRecipientsAction.

`new Validation()`

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.

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

Properties

Methods

Detailed documentation

new Action()

Return

new Action Response Builder()

Return

new Action Status()

Return

new Attachment()

Return

new Authorization Action()

Return

new Authorization Exception()

Return

new Border Style()

Return

new Button Set()

Return

new Calendar Event Action Response Builder()

Return

new Card Action()

Return

new Card Builder()

Return

new Card Header()

Return

new Card Section()

Return

new Card With Id()

Return

new Carousel()

Return

new Carousel Card()

Return

new Chat Action Response()

Return

new Chat Response Builder()

Return

new Chip()

Return

new Chip List()

Return

new Collapse Control()

Return

new Column()

Return

new Columns()

Return

new Compose Action Response Builder()

Return

new Date Picker()

Return

new Date Time Picker()

Return

new Decorated Text()

Return

new Dialog()

Return

new Dialog Action()

Return

new Divider()

Return

new Drive Items Selected Action Response Builder()

Return

new Editor File Scope Action Response Builder()

Return

new Fixed Footer()

Return

new Grid()

Return

new Grid Item()

Return

new Icon Image()

Return

new Image()

Return

new Image Button()

Return

Class CardService

`new Action()`

`new Action Response Builder()`

`new Action Status()`

`new Attachment()`

`new Authorization Action()`

`new Authorization Exception()`

`new Border Style()`

`new Button Set()`

`new Calendar Event Action Response Builder()`

`new Card Action()`

`new Card Builder()`

`new Card Header()`

`new Card Section()`

`new Card With Id()`

`new Carousel()`

`new Carousel Card()`

`new Chat Action Response()`

`new Chat Response Builder()`

`new Chip()`

`new Chip List()`

`new Collapse Control()`

`new Column()`

`new Columns()`

`new Compose Action Response Builder()`

`new Date Picker()`

`new Date Time Picker()`

`new Decorated Text()`

`new Dialog()`

`new Dialog Action()`

`new Divider()`

`new Drive Items Selected Action Response Builder()`

`new Editor File Scope Action Response Builder()`

`new Fixed Footer()`

`new Grid()`

`new Grid Item()`

`new Icon Image()`

`new Image()`

`new Image Button()`

`new Image Component()`

`new Image Crop Style()`

`new Key Value()`

`new Link Preview()`

`new Material Icon()`

`new Navigation()`

`new Notification()`

`new Open Link()`

`new Overflow Menu()`

`new Overflow Menu Item()`

`new Selection Input()`

`new Suggestions()`

`new Suggestions Response Builder()`

`new Switch()`

`new Text Button()`

`new Text Input()`

`new Text Paragraph()`

`new Time Picker()`

`new Universal Action Response Builder()`

`new Update Draft Action Response Builder()`

`new Update Draft Bcc Recipients Action()`

`new Update Draft Body Action()`

`new Update Draft Cc Recipients Action()`

`new Update Draft Subject Action()`

`new Update Draft To Recipients Action()`

`new Validation()`