Class CardService

    • 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 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.
    Common Data Source
    		Common Data Source The Common Data Source enumeration.
    Composed Email Type
    		Composed Email Type The Composed Email Type enumeration.
    Content Type
    		Content Type The Content Type enumeration.
    Drive Item Type
    		Drive Item Type The Drive Item Type enumeration.
    Expression Data Action Type
    		Expression Data Action Type The Expression Data Action Type enumeration.
    Expression Data Condition Type
    		Expression Data Condition Type The Expression Data Condition 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.
    Text Input Mode
    		Text Input Mode The Text Input Mode enumeration.
    Update Draft Body Type
    		Update Draft Body Type The Update Draft Body Type enumeration.
    Variable Button Size
    		Variable Button Size The Variable Button Size enumeration.
    Visibility
    		Visibility The Visibility enumeration.
    Workflow Data Source Type
    		Workflow Data Source Type The Workflow Data Source 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 Common Widget Action()
    		Common Widget Action Creates a new Common Widget Action .
    new Compose Action Response Builder()
    		Compose Action Response Builder Creates a new Compose Action Response Builder .
    new Condition()
    		Condition Creates a new Condition used for client-side validation.
    new Data Source Config()
    		Data Source Config Creates a new, empty Data Source Config .
    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 Data Source Spec()
    		Drive Data Source Spec Creates a new Drive Data Source Spec .
    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 Event Action()
    		Event Action Creates a new Event Action used for client-side validation.
    new Expression Data()
    		Expression Data Creates a new Expression Data used for client-side validation.
    new Expression Data Action()
    		Expression Data Action Creates a new Expression Data Action used for client-side validation.
    new Expression Data Condition()
    		Expression Data Condition Creates a new Expression Data Condition used for client-side validation.
    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 Host App Data Source()
    		Host App Data Source Creates a new Host App Data Source .
    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 Platform Data Source()
    		Platform Data Source Creates a new Platform Data Source .
    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 Trigger()
    		Trigger Creates and returns a new Trigger used for client-side validation.
    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 Update Visibility Action()
    		Update Visibility Action Creates a new Update Visibility Action .
    new Validation()
    		Validation Creates a new Validation .
    new Workflow Data Source()
    		Workflow Data Source Creates a new Workflow Data Source .

    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 .

    newCarousel()

    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.

    newCarouselCard()

    Creates a new CarouselCard .

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

    Return

    CarouselCard — An empty Chip.

    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 .

    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.

    newChipList()

    Creates a new ChipList .

    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

    ChipList — An empty ChipList.

    newCollapseControl()

    Creates a new CollapseControl .

    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

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

    Return

    Columns — An empty set of Columns.

    newCommonWidgetAction()

    Creates a new CommonWidgetAction .

    Return

    CommonWidgetAction — An empty CommonWidgetAction .

    newComposeActionResponseBuilder()

    Creates a new ComposeActionResponseBuilder .

    Return

    ComposeActionResponseBuilder — An empty ComposeActionResponse builder.

    newCondition()

    Creates a new Condition used for client-side validation.

    Return

    Condition — An empty Condition .

    newDataSourceConfig()

    Creates a new, empty DataSourceConfig .

    Return

    DataSourceConfig — An empty DataSourceConfig .

    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.

    newDriveDataSourceSpec()

    Creates a new DriveDataSourceSpec .

    Return

    DriveDataSourceSpec — An empty DriveDataSourceSpec .

    newDriveItemsSelectedActionResponseBuilder()

    newEditorFileScopeActionResponseBuilder()

    newEventAction()

    Creates a new EventAction used for client-side validation.

    Return

    EventAction — An empty EventAction .

    newExpressionData()

    Creates a new ExpressionData used for client-side validation.

    Return

    ExpressionData — An empty ExpressionData .

    newExpressionDataAction()

    Creates a new ExpressionDataAction used for client-side validation.

    Return

    ExpressionDataAction — An empty ExpressionDataAction .

    newExpressionDataCondition()

    Creates a new ExpressionDataCondition used for client-side validation.

    Return

    ExpressionDataCondition — An empty ExpressionDataCondition .

    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.

    newHostAppDataSource()

    Creates a new HostAppDataSource .

    Return

    HostAppDataSource — A HostAppDataSource .

    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 
 (); 
 return 
  
 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 .

    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

    OverflowMenu — An empty OverflowMenu.

    newOverflowMenuItem()

    Creates a new OverflowMenuItem .

    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

    OverflowMenuItem — An empty OverflowMenuItem.

    newPlatformDataSource()

    Creates a new PlatformDataSource .

    Return

    PlatformDataSource — An empty PlatformDataSource .

    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.

    newTrigger()

    Creates and returns a new Trigger used for client-side validation.

    Return

    Trigger — An empty Trigger .

    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.

    newUpdateVisibilityAction()

    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.

    newWorkflowDataSource()

    Creates a new WorkflowDataSource .

    Return

    WorkflowDataSource — An empty WorkflowDataSource .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: