Class CardService

CardService

CardService bietet die Möglichkeit, generische Karten zu erstellen, die in verschiedenen Google-Erweiterbarkeitsprodukten wie Google Workspace-Add-ons verwendet werden.

Unten sehen Sie ein Beispiel für eine Add-on-Karte.

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

Alternativ können Sie auch mehrere Karten zurückgeben:

return [
  CardService.newCardBuilder().build(),
  CardService.newCardBuilder().build(),
  CardService.newCardBuilder().build()
]

Im Folgenden sehen Sie, wie Sie eine Karte mit einer Überschrift, Text, einem Bild und einem Menüpunkt definieren können:

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

Beispiel für eine Karte für Chat-Apps.

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

Attribute

PropertyTypBeschreibung
BorderTypeBorderTypeDie Aufzählung BorderType.
ComposedEmailTypeComposedEmailTypeDie Aufzählung ComposedEmailType.
ContentTypeContentTypeDie Aufzählung ContentType.
GridItemLayoutGridItemLayoutDie Aufzählung GridItemLayout.
HorizontalAlignmentHorizontalAlignmentDie Aufzählung HorizontalAlignment.
IconIconDie Aufzählung Icon.
ImageCropTypeImageCropTypeDie Aufzählung ImageCropType.
ImageStyleImageStyleDie Aufzählung ImageStyle.
LoadIndicatorLoadIndicatorDie Aufzählung LoadIndicator.
OnCloseOnCloseDie Aufzählung OnClose.
OpenAsOpenAsDie Aufzählung OpenAs.
SelectionInputTypeSelectionInputTypeDie Aufzählung SelectionInputType.
TextButtonStyleTextButtonStyleDie Aufzählung TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeDie Aufzählung UpdateDraftBodyType.

Methoden

MethodeRückgabetypKurzbeschreibung
newAction()ActionErstellt einen neuen Action
newActionResponseBuilder()ActionResponseBuilderErstellt einen neuen ActionResponseBuilder
newActionStatus()ActionStatusErstellt einen neuen ActionStatus
newAttachment()AttachmentErstellt einen neuen Attachment
newAuthorizationAction()AuthorizationActionErstellt einen neuen AuthorizationAction
newAuthorizationException()AuthorizationExceptionErstellt einen neuen AuthorizationException
newBorderStyle()BorderStyleErstellt einen neuen BorderStyle
newButtonSet()ButtonSetErstellt einen neuen ButtonSet
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderErstellt einen neuen CalendarEventActionResponseBuilder
newCardAction()CardActionErstellt einen neuen CardAction
newCardBuilder()CardBuilderErstellt einen neuen CardBuilder
newCardHeader()CardHeaderErstellt einen neuen CardHeader
newCardSection()CardSectionErstellt einen neuen CardSection
newCardWithId()CardWithIdErstellt einen neuen CardWithId
newChatActionResponse()ChatActionResponseErstellt einen neuen ChatActionResponse
newChatResponseBuilder()ChatResponseBuilderErstellt einen neuen ChatResponseBuilder
newComposeActionResponseBuilder()ComposeActionResponseBuilderErstellt einen neuen ComposeActionResponseBuilder
newDatePicker()DatePickerErstellt einen neuen DatePicker
newDateTimePicker()DateTimePickerErstellt einen neuen DateTimePicker
newDecoratedText()DecoratedTextErstellt einen neuen DecoratedText
newDialog()DialogErstellt einen neuen Dialog
newDialogAction()DialogActionErstellt einen neuen DialogAction
newDivider()DividerErstellt einen neuen Divider
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderErstellt einen neuen DriveItemsSelectedActionResponseBuilder
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderErstellt einen neuen EditorFileScopeActionResponseBuilder
newFixedFooter()FixedFooterErstellt einen neuen FixedFooter
newGrid()GridErstellt einen neuen Grid
newGridItem()GridItemErstellt einen neuen GridItem
newIconImage()IconImageErstellt einen neuen IconImage
newImage()ImageErstellt einen neuen Image
newImageButton()ImageButtonErstellt einen neuen ImageButton
newImageComponent()ImageComponentErstellt einen neuen ImageComponent
newImageCropStyle()ImageCropStyleErstellt einen neuen ImageCropStyle
newKeyValue()KeyValueErstellt einen neuen KeyValue
newNavigation()NavigationErstellt einen neuen Navigation
newNotification()NotificationErstellt einen neuen Notification
newOpenLink()OpenLinkErstellt einen neuen OpenLink
newSelectionInput()SelectionInputErstellt einen neuen SelectionInput
newSuggestions()SuggestionsErstellt einen neuen Suggestions
newSuggestionsResponseBuilder()SuggestionsResponseBuilderErstellt einen neuen SuggestionsResponseBuilder
newSwitch()SwitchErstellt einen neuen Switch
newTextButton()TextButtonErstellt einen neuen TextButton
newTextInput()TextInputErstellt einen neuen TextInput
newTextParagraph()TextParagraphErstellt einen neuen TextParagraph
newTimePicker()TimePickerErstellt einen neuen TimePicker
newUniversalActionResponseBuilder()UniversalActionResponseBuilderErstellt einen neuen UniversalActionResponseBuilder
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderErstellt einen neuen UpdateDraftActionResponseBuilder
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionErstellt einen neuen UpdateDraftBccRecipientsAction;
newUpdateDraftBodyAction()UpdateDraftBodyActionErstellt einen neuen UpdateDraftBodyAction
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionErstellt einen neuen UpdateDraftCcRecipientsAction
newUpdateDraftSubjectAction()UpdateDraftSubjectActionErstellt einen neuen UpdateDraftSubjectAction
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionErstellt einen neuen UpdateDraftToRecipientsAction

Detaillierte Dokumentation

newAction()

Erstellt einen neuen Action

Return

Action: Eine leere Aktion.


newActionResponseBuilder()

Erstellt einen neuen ActionResponseBuilder

Return

ActionResponseBuilder: Ein leerer ActionResponse-Builder.


newActionStatus()

Erstellt einen neuen ActionStatus

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für Google Workspace-Add-ons.

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

Return

ActionStatus: Ein leerer ActionStatus.


newAttachment()

Erstellt einen neuen Attachment

Return

Attachment: Ein leerer Anhang.


newAuthorizationAction()

Erstellt einen neuen AuthorizationAction

Return

AuthorizationAction: Eine leere AuthorizationAction.


newAuthorizationException()

Erstellt einen neuen AuthorizationException

Return

AuthorizationException: Eine leere AuthorizationException.


newBorderStyle()

Erstellt einen neuen BorderStyle

Return

BorderStyle: Ein leerer BorderStyle.


newButtonSet()

Erstellt einen neuen ButtonSet

Return

ButtonSet: Ein leeres ButtonSet.


newCalendarEventActionResponseBuilder()


newCardAction()

Erstellt einen neuen CardAction

Return

CardAction: Eine leere CardAction.


newCardBuilder()

Erstellt einen neuen CardBuilder

Return

CardBuilder: Ein leeres Tool zur Kartenerstellung.


newCardHeader()

Erstellt einen neuen CardHeader

Return

CardHeader: Ein leerer CardHeader.


newCardSection()

Erstellt einen neuen CardSection

Return

CardSection: Ein leerer CardSection.


newCardWithId()

Erstellt einen neuen CardWithId Damit wird eine Karte in einer Google Chat-Nachricht gesendet. Die Karten-ID ist eine eindeutige Kennung für eine Karte in einer Nachricht, wenn mehrere Karten gesendet werden.

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für 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: Ein leeres CardWithId-Objekt.


newChatActionResponse()

Erstellt einen neuen ChatActionResponse

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für 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: Ein leeres ChatActionResponse-Objekt.


newChatResponseBuilder()

Erstellt einen neuen ChatResponseBuilder

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für 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: Ein leerer ChatResponseBuilder.


newComposeActionResponseBuilder()

Erstellt einen neuen ComposeActionResponseBuilder

Return

ComposeActionResponseBuilder: Ein leerer ComposeActionResponse-Builder.


newDatePicker()

Erstellt einen neuen DatePicker

Return

DatePicker: Ein leerer DatePicker.


newDateTimePicker()

Erstellt einen neuen DateTimePicker

Return

DateTimePicker: Ein leerer DateTimePicker.


newDecoratedText()

Erstellt einen neuen DecoratedText

Return

DecoratedText: Ein leerer „DekorierteText“.


newDialog()

Erstellt einen neuen Dialog

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für 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: Ein leeres Dialog-Objekt.


newDialogAction()

Erstellt einen neuen DialogAction

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für 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: Ein leeres DialogAction-Objekt.


newDivider()

Erstellt einen neuen Divider Im folgenden Beispiel wird eine einfache Karte mit zwei Absätzen erstellt, die durch eine Trennlinie getrennt sind.

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: Eine Trennlinie.


newDriveItemsSelectedActionResponseBuilder()


newEditorFileScopeActionResponseBuilder()


newFixedFooter()

Erstellt einen neuen FixedFooter

Return

FixedFooter: Eine leere feste Fußzeile.


newGrid()

Erstellt einen neuen Grid

Return

Grid: Ein leeres Raster.


newGridItem()

Erstellt einen neuen GridItem

Return

GridItem: Ein leeres GridItem.


newIconImage()

Erstellt einen neuen IconImage

Return

IconImage: Ein leeres Symbolbild.


newImage()

Erstellt einen neuen Image

Return

Image: Ein leeres Bild.


newImageButton()

Erstellt einen neuen ImageButton

Return

ImageButton: Ein leeres ImageButton-Element.


newImageComponent()

Erstellt einen neuen ImageComponent

Return

ImageComponent: Eine leere ImageComponent.


newImageCropStyle()

Erstellt einen neuen ImageCropStyle

Return

ImageCropStyle: Ein leeres ImageZuschneidenStyle.


newKeyValue()

Erstellt einen neuen KeyValue

Return

KeyValue: Ein leerer Schlüsselwert.


newNavigation()

Erstellt einen neuen Navigation

Return

Navigation: Eine leere Navigation.


newNotification()

Erstellt einen neuen Notification

Return

Notification: Eine leere Benachrichtigung.


Erstellt einen neuen OpenLink

Return

OpenLink: Ein leerer OpenLink.


newSelectionInput()

Erstellt einen neuen SelectionInput

Return

SelectionInput: Ein leeres SelectionInput.


newSuggestions()

Erstellt einen neuen Suggestions

Return

Suggestions: leere Vorschläge.


newSuggestionsResponseBuilder()

Erstellt einen neuen SuggestionsResponseBuilder

Return

SuggestionsResponseBuilder: Ein leerer Vorschlagsantworten-Builder.


newSwitch()

Erstellt einen neuen Switch

Return

Switch: Ein leerer Switch.


newTextButton()

Erstellt einen neuen TextButton

Return

TextButton: Ein leeres TextButton-Element.


newTextInput()

Erstellt einen neuen TextInput

Return

TextInput: Ein leeres TextInput.


newTextParagraph()

Erstellt einen neuen TextParagraph

Return

TextParagraph: Ein leerer TextParagraph.


newTimePicker()

Erstellt einen neuen TimePicker

Return

TimePicker: Ein leerer TimePicker.


newUniversalActionResponseBuilder()

Erstellt einen neuen UniversalActionResponseBuilder

Return

UniversalActionResponseBuilder: Ein leerer UniversalActionResponse-Builder.


newUpdateDraftActionResponseBuilder()

Erstellt einen neuen UpdateDraftActionResponseBuilder

Return

UpdateDraftActionResponseBuilder: Ein leerer UpdateDraftActionResponseBuilder.


newUpdateDraftBccRecipientsAction()

Erstellt einen neuen UpdateDraftBccRecipientsAction;

Return

UpdateDraftBccRecipientsAction: Ein leeres UpdateDraftBccRecipientsAction.


newUpdateDraftBodyAction()

Erstellt einen neuen UpdateDraftBodyAction

Return

UpdateDraftBodyAction: Ein leeres UpdateDraftBodyAction.


newUpdateDraftCcRecipientsAction()

Erstellt einen neuen UpdateDraftCcRecipientsAction

Return

UpdateDraftCcRecipientsAction: Eine leere „UpdateDraftCcRecipientsAction“.


newUpdateDraftSubjectAction()

Erstellt einen neuen UpdateDraftSubjectAction

Return

UpdateDraftSubjectAction: Ein leeres UpdateDraftSubjectAction.


newUpdateDraftToRecipientsAction()

Erstellt einen neuen UpdateDraftToRecipientsAction

Return

UpdateDraftToRecipientsAction: Ein leeres UpdateDraftToRecipientsAction.