Class CardService

CardService

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

Currently you can only use this service to construct Gmail add-ons.

return CardService.newCardBuilder()
         .setHeader(CardService.newCardHeader().setTitle("CardTitle"))
         .build();

Or you can return multiple Cards like so:

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();
}

Properties

Property	Type	Description
BorderType	BorderType	The BorderType 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.
ImageCropType	ImageCropType	The ImageCropType enumeration.
ImageStyle	ImageStyle	The ImageStyle 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.
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 CardBuilder.
newCardHeader()	CardHeader	Creates a new CardHeader.
newCardSection()	CardSection	Creates a new CardSection.
newComposeActionResponseBuilder()	ComposeActionResponseBuilder	Creates a new ComposeActionResponseBuilder.
newDatePicker()	DatePicker	Creates a new DatePicker.
newDateTimePicker()	DateTimePicker	Creates a new DateTimePicker.
newDecoratedText()	DecoratedText	Creates a new DecoratedText.
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.
newNavigation()	Navigation	Creates a new Navigation.
newNotification()	Notification	Creates a new Notification.
newOpenLink()	OpenLink	Creates a new OpenLink.
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.

Detailed documentation

newAction()

Creates a new Action.

Return

Action — An empty Action.

---

newActionResponseBuilder()

Creates a new ActionResponseBuilder.

Return

ActionResponseBuilder — An empty ActionResponse builder.

---

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()

Creates a new CalendarEventActionResponseBuilder.

Return

CalendarEventActionResponseBuilder — An empty CalendarEventActionResponseBuilder.

---

newCardAction()

Creates a new CardAction.

Return

CardAction — An empty CardAction.

---

newCardBuilder()

Creates a new CardBuilder.

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.

---

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.

---

newDivider()

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

function buildCard() {
    let cardSection1TextParagraph1 = CardService.newTextParagraph()
        .setText('Hello world!');

    let cardSection1Divider1 = CardService.newDivider();

    let cardSection1TextParagraph2 = CardService.newTextParagraph()
        .setText('Hello world!');

    let cardSection1 = CardService.newCardSection()
        .addWidget(cardSection1TextParagraph1)
        .addWidget(cardSection1Divider1)
        .addWidget(cardSection1TextParagraph2);

    let card = CardService.newCardBuilder()
        .addSection(cardSection1)
        .build();

   return card;
}

Return

Divider — A divider.

---

newDriveItemsSelectedActionResponseBuilder()

Creates a new DriveItemsSelectedActionResponseBuilder.

Return

DriveItemsSelectedActionResponseBuilder — An empty DriveItemsSelectedActionResponseBuilder.

---

newEditorFileScopeActionResponseBuilder()

Creates a new EditorFileScopeActionResponseBuilder.

Return

EditorFileScopeActionResponseBuilder — An empty EditorFileScopeActionResponseBuilder.

---

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.

---

newNavigation()

Creates a new Navigation.

Return

Navigation — An empty Navigation.

---

newNotification()

Creates a new Notification.

Return

Notification — An empty Notification.

---

newOpenLink()

Creates a new OpenLink.

Return

OpenLink — An empty OpenLink.

---

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.