Card Service

Kartendienst

Mit diesem Dienst können Scripts Karten- und Widget-Komponenten sowie Verhaltensweisen für eine Benutzeroberfläche konfigurieren und erstellen. Die mit diesem Dienst erstellten UI-Strukturen sind sowohl auf Computern als auch auf Mobilgeräten automatisch verfügbar. Sie müssen also keine separaten UIs für beide entwickeln.

Klassen

NameKurzbeschreibung
ActionEine Aktion, die Interaktivität innerhalb von UI-Elementen ermöglicht.
ActionResponseDas Antwortobjekt, das von einer Rückruffunktion (z.B. einem Formularantwort-Handler) zurückgegeben werden kann, um eine oder mehrere Aktionen auf dem Client auszuführen.
ActionResponseBuilderEin Builder für ActionResponse-Objekte.
ActionStatusEine Klasse, die den Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds darstellt.
AttachmentStellt einen Anhang dar, der von einem Add-on erstellt wurde.
AuthorizationActionEine Autorisierungsaktion, bei der der Nutzer nach dem Klicken auf die AuthorizationUrl weitergeleitet wird.
AuthorizationExceptionEin Fehler, der zurückgegeben werden kann, um eine Autorisierungskarte auszulösen, die dem Nutzer angezeigt wird.
BorderStyleEine Klasse, die einen vollständigen Rahmenstil darstellt, der auf Widgets angewendet werden kann.
BorderTypeEin Enum, das die Arten von Rahmen darstellt, die auf Widgets angewendet werden können.
ButtonEine Basisklasse für alle Schaltflächen.
ButtonSetEnthält eine Reihe von Button-Objekten, die in einer Zeile angezeigt werden.
CalendarEventActionResponseStellt eine Antwort dar, durch die Änderungen am Kalendertermin vorgenommen werden, den der Nutzer gerade bearbeitet, als Reaktion auf eine Aktion in der Benutzeroberfläche, z. B. ein Klicken auf eine Schaltfläche.
CalendarEventActionResponseBuilderEin Builder für CalendarEventActionResponse-Objekte.
CardEine Kontextkarte, die eine einzelne Ansicht in der Benutzeroberfläche darstellt.
CardActionEin anklickbarer Menüpunkt, der dem Menü im Kartenheader hinzugefügt wird.
CardBuilderEin Builder für Card-Objekte.
CardHeaderDer Header einer Card.
CardSectionEin Kartenbereich enthält Gruppen von Widgets und bietet eine visuelle Trennung zwischen ihnen.
CardServiceMit dem CardService können Sie generische Karten erstellen, die in verschiedenen Google-Erweiterungsprodukten verwendet werden, z. B. in Google Workspace-Add-ons.
CardWithIdEin Builder für CardWithId-Objekte.
CarouselEin Karussell, auch als Schieberegler bezeichnet, dreht sich und zeigt eine Liste von Widgets in einem Diashow-Format an. Mit den Schaltflächen können Sie zum vorherigen oder nächsten Widget wechseln.
CarouselCardEine Karte, die als Karussellelement angezeigt werden kann.
ChatActionResponseEine Klasse, die die Parameter darstellt, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.
ChatClientDataSourceFür ein SelectionInput-Widget mit einem Mehrfachauswahlmenü eine Datenquelle aus Google Chat.
ChatResponseDas Antwortobjekt für eine Kartennachricht in Google Chat.
ChatResponseBuilderEin Builder für ChatResponse-Objekte.
ChatSpaceDataSourceEine Datenquelle, die Google Chat-Gruppenbereiche als Auswahlelemente für ein Mehrfachauswahlmenü enthält.
ChipEin Chip mit einem Symbol und einem Textlabel.
ChipListEnthält eine Reihe von Chip-Objekten, die in einer Zeile angezeigt werden und bei Bedarf umgebrochen werden, um horizontal scrollbar zu sein.
ChipListLayoutEin Enum, das das Layout für ChipList angibt.
CollapseControlEin anpassbares Steuerelement zum Minimieren und Maximieren.
ColumnEine Spalte.
ColumnsDas Columns-Widget kann bis zu zwei Spalten auf einer Karte oder in einem Dialogfeld anzeigen.
CommonDataSourceEine Datenquelle, die von allen Google Workspace-Anwendungen gemeinsam genutzt wird.
ComposeActionResponseDas Antwortobjekt, das von einer Callback-Methode für die Aktion „Schreiben“ in einem Gmail-Add-on zurückgegeben werden kann.
ComposeActionResponseBuilderEin Builder für ComposeActionResponse-Objekte.
ComposedEmailTypeEin enum-Wert, der angibt, ob die verfasste E-Mail ein eigenständiger Entwurf oder ein Antwortentwurf ist.
ContentTypeEin enum-Wert, der den Inhaltstyp der von einem UpdateDraftActionResponse generierten Inhalte angibt.
DatePickerEin Eingabefeld, in das ein Datum eingegeben werden kann.
DateTimePickerEin Eingabefeld, in das Nutzer ein Datum und eine Uhrzeit eingeben können.
DecoratedTextEin Widget, das Text mit optionalen Verzierungen anzeigt.
DialogWeitere Informationen finden Sie in der Google Chat-Dokumentation unter Interaktive Dialoge öffnen.
DialogActionEin Builder für DialogAction-Objekte.
DisplayStyleEin Enum, das den Darstellungsstil der Karte definiert.
DividerEine horizontale Trennlinie.
DriveItemsSelectedActionResponseStellt eine Antwort dar, durch die Änderungen an Drive-Elementen vorgenommen werden, während diese ausgewählt sind, und die auf eine Aktion auf der Benutzeroberfläche reagiert, z. B. auf einen Tastendruck.
DriveItemsSelectedActionResponseBuilderEin Builder für DriveItemsSelectedActionResponse-Objekte.
EditorFileScopeActionResponseFührt Änderungen an einem Editor wie Google Docs, Google Sheets oder Google Präsentationen als Reaktion auf eine Aktion in der Benutzeroberfläche aus.
EditorFileScopeActionResponseBuilderEin Builder für EditorFileScopeActionResponse-Objekte.
FixedFooterDie feste Fußzeile, die unten in einer Card angezeigt wird.
GridEin organisiertes Raster, in dem eine Sammlung von Rasterelementen angezeigt wird.
GridItemDie Elemente, mit denen Nutzer in einem Raster-Widget interagieren.
GridItemLayoutEin Enum, das den Bild- und Textstil eines GridItem definiert.
HorizontalAlignmentEin Enum, das die horizontale Ausrichtung eines Widgets angibt.
HorizontalSizeStyleEin Enum, das festlegt, wie Widgets den Bereich einer Spalte ausfüllen.
HostAppDataSourceFür ein SelectionInput-Widget mit einem Mehrfachauswahlmenü eine Datenquelle aus einer Google Workspace-Anwendung.
IconVordefinierte Symbole, die in verschiedenen UI-Objekten verwendet werden können, z. B. in ImageButton- oder DecoratedText-Widgets.
IconImageEin vordefiniertes Symbol, ein Material Design-Symbol oder ein Symbol aus einer URL mit einem anpassbaren Zuschnittsstil.
ImageEin Widget, das ein einzelnes Bild zeigt.
ImageButtonEin ImageButton mit einem Bild
ImageButtonStyleEin Enum, das den Stil für ImageButton angibt.
ImageComponentEine Bildkomponente, die Rasterelementen hinzugefügt werden kann.
ImageCropStyleEine Klasse, die einen Zuschnittsstil darstellt, der auf Bildkomponenten angewendet werden kann.
ImageCropTypeEin Enum, das die Zuschneideformate darstellt, die auf Bildkomponenten angewendet werden.
ImageStyleEin Enum, das einen Bildausschnittstil definiert.
InputTypeEin Enum, das den Eingabetyp des Widgets definiert.
InteractionEin enum-Typ, der angibt, was bei einer Interaktion mit einem Nutzer geschehen soll, z. B. wenn ein Nutzer auf eine Schaltfläche in einer Kartennachricht klickt.
KeyValueDiese Klasse wurde eingestellt.
LinkPreviewKartenaktion, bei der in der Host-App eine Linkvorschaukarte und ein Smartchip angezeigt werden.
LoadIndicatorEin Enum-Typ, der angibt, welche Art von Lade- oder Fortschrittsanzeige während der Verarbeitung einer Action angezeigt werden soll.
MaterialIconEin Objekt, das alle Google Fonts-Symbole unterstützt.
NavigationEin Hilfsobjekt, das die Navigation zwischen Karten steuert.
NotificationEine Benachrichtigung, die dem Nutzer als Reaktion auf die Interaktion mit einem UI-Element angezeigt wird.
OnCloseEin Enum, das angibt, was passieren soll, wenn eine über eine OpenLink geöffnete URL geschlossen wird.
OpenAsEin Enum, das angibt, wie eine URL geöffnet werden soll.
OpenLinkStellt eine Aktion zum Öffnen eines Links mit einigen Optionen dar.
OverflowMenuEnthält eine Liste von OverflowMenuItem-Objekten, die in einem Pop-up-Menü angezeigt werden.
OverflowMenuItemEin OverflowMenuItem mit einem Symbol und einem Textlabel.
PlatformDataSourceFür ein SelectionInput-Widget mit einem Mehrfachauswahlmenü eine Datenquelle aus Google Workspace.
ResponseTypeEin Enum, das den Typ der Chat-App-Antwort darstellt.
SelectionInputEin Eingabefeld, in dem eine Auswahl aus einer Reihe vordefinierter Optionen getroffen werden kann.
SelectionInputTypeDas Format der Elemente, die Nutzer auswählen können.
StatusEin Enum-Wert, der den Statuscode darstellt.
SuggestionsVorschläge zur automatischen Vervollständigung, die ein TextInput-Widget ergänzen
SuggestionsResponseEin Antwortobjekt, das von einer Callback-Funktion für Vorschläge zurückgegeben werden kann.
SuggestionsResponseBuilderEin Builder für SuggestionsResponse-Objekte.
SwitchEin UI-Element, das aktiviert oder deaktiviert werden kann.
SwitchControlTypeTyp eines Switch-Widget-Steuerelements.
TextButtonEine TextButton mit einem Textlabel.
TextButtonStyleEin Enum, das den Stil für TextButton angibt.
TextInputEin Eingabefeld-Widget, das Texteingaben akzeptiert.
TextParagraphEin Widget, das Text anzeigt und einfache HTML-Formatierung unterstützt.
TimePickerEin Eingabefeld, in das Nutzer eine Uhrzeit eingeben können.
UniversalActionResponseDas Antwortobjekt, das von einer Methode zurückgegeben werden kann, die eine universelle Aktion erstellt.
UniversalActionResponseBuilderEin Builder für die UniversalActionResponse-Objekte.
UpdateDraftActionResponseStellt eine Aktion dar, durch die der E-Mail-Entwurf aktualisiert wird, den der Nutzer gerade bearbeitet.
UpdateDraftActionResponseBuilderEin Builder für UpdateDraftActionResponse-Objekte.
UpdateDraftBccRecipientsActionAktualisiert die Bcc-Empfänger eines E-Mail-Entwurfs.
UpdateDraftBodyActionAktualisiert den Text des E-Mail-Entwurfs.
UpdateDraftBodyTypeEin Enum-Wert, der den Typ eines UpdateDraftBodyAction angibt.
UpdateDraftCcRecipientsActionAktualisiert die Cc-Empfänger eines E-Mail-Entwurfs.
UpdateDraftSubjectActionAktualisiert die Betreffzeile eines E-Mail-Entwurfs.
UpdateDraftToRecipientsActionAktualisiert die Empfänger eines E-Mail-Entwurfs.
UpdatedWidgetDie Antwort des aktualisierten Widgets.
ValidationEin Objekt, das die Validierungsregel für das zugehörige Widget definiert.
VerticalAlignmentEin Enum, das die vertikale Ausrichtung von Widgets in einer Spalte festlegt.
WidgetBasisklasse für alle Widgets, die einem Card hinzugefügt werden können.
WrapStyleEin Enum, das den Umbruchstil für Inhalte in einer Spalte festlegt.

Action

Methoden

MethodeRückgabetypKurzbeschreibung
addRequiredWidget(requiredWidget)ActionFügen Sie die Namen der Widgets hinzu, die für diese Aktion für eine gültige Einreichung erforderlich sind.
setAllWidgetsAreRequired(allWidgetsAreRequired)ActionGibt an, ob für diese Aktion Eingaben von allen Widgets erforderlich sind.
setFunctionName(functionName)ActionLegt den Namen der aufzurufenden Callback-Funktion fest.
setInteraction(interaction)ActionHiermit wird die Interaktion mit einem Nutzer festgelegt. Dies ist nur erforderlich, wenn ein Dialogfeld geöffnet wird.
setLoadIndicator(loadIndicator)ActionHiermit wird die Ladeanzeige festgelegt, die während der Ausführung der Aktion angezeigt wird.
setParameters(parameters)ActionErmöglicht die Weitergabe benutzerdefinierter Parameter an die Callback-Funktion.
setPersistValues(persistValues)ActionGibt an, ob Formularwerte durch die Werte des Clients oder des Servers bestimmt werden, nachdem die Card des Formulars durch eine Aktionsantwort aktualisiert wurde.

ActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

ActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()ActionResponseDie aktuelle Aktionsantwort wird erstellt und validiert.
setNavigation(navigation)ActionResponseBuilderLegt die Antwort auf eine Navigation-Aktion fest.
setNotification(notification)ActionResponseBuilderHier legen Sie fest, wann die Benachrichtigung angezeigt werden soll.
setOpenLink(openLink)ActionResponseBuilderHier wird die URL festgelegt, zu der Sie weitergeleitet werden, wenn die Aktion aktiviert wird.
setStateChanged(stateChanged)ActionResponseBuilderSetzt ein Flag, um anzugeben, dass durch diese Aktion der vorhandene Datenstatus geändert wurde.

ActionStatus

Methoden

MethodeRückgabetypKurzbeschreibung
setStatusCode(statusCode)ActionStatusDer Status einer Anfrage zum Öffnen oder Senden eines Dialogfelds.
setUserFacingMessage(message)ActionStatusDie Nachricht, die Nutzern über den Status ihrer Anfrage gesendet werden soll.

Attachment

Methoden

MethodeRückgabetypKurzbeschreibung
setIconUrl(iconUrl)AttachmentHier wird die Symbol-URL für den Anhang festgelegt.
setMimeType(mimeType)AttachmentHiermit wird der MIME-Typ für den Anhang festgelegt.
setResourceUrl(resourceUrl)AttachmentLegt die Ressourcen-URL für den Anhang fest.
setTitle(title)AttachmentHiermit wird der Titel für den Anhang festgelegt.

AuthorizationAction

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationUrl(authorizationUrl)AuthorizationActionHiermit wird die Autorisierungs-URL festgelegt, zu der der Nutzer über den Autorisierungsaufforderung weitergeleitet wird.

AuthorizationException

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setAuthorizationUrl(authUrl)AuthorizationExceptionHiermit wird die Autorisierungs-URL festgelegt, zu der der Nutzer über den Autorisierungsaufforderung weitergeleitet wird.
setCustomUiCallback(callback)AuthorizationExceptionDer Name einer Funktion, die aufgerufen wird, um einen benutzerdefinierten Autorisierungsprompt zu generieren.
setResourceDisplayName(name)AuthorizationExceptionHiermit wird der Name festgelegt, der dem Nutzer bei der Autorisierungsanfrage angezeigt wird.
throwException()voidAuslöser für diese Ausnahme.

BorderStyle

Methoden

MethodeRückgabetypKurzbeschreibung
setCornerRadius(radius)BorderStyleHiermit wird der Eckradius des Rahmens festgelegt, z. B. 8.
setStrokeColor(color)BorderStyleHiermit legen Sie die Farbe des Rahmens fest.
setType(type)BorderStyleLegt den Rahmentyp fest.

BorderType

Attribute

AttributTypBeschreibung
NO_BORDEREnumKein Rahmenstil.
STROKEEnumRahmenstil für den Strich

Button

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)ButtonHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)ButtonLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setOnClickAction(action)ButtonHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ButtonHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ButtonHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setOverflowMenu(menu)ButtonHiermit wird ein Pop-up-Menü festgelegt, das geöffnet wird, wenn auf das Objekt geklickt wird.

ButtonSet

Methoden

MethodeRückgabetypKurzbeschreibung
addButton(button)ButtonSetFügen Sie eine Schaltfläche hinzu.

CalendarEventActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

CalendarEventActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addAttachments(attachments)CalendarEventActionResponseBuilderGibt an, dass die Anhänge dem Kalendertermin in der Antwort hinzugefügt werden sollen, wenn die zugehörige UI-Aktion ausgeführt wird.
addAttendees(emails)CalendarEventActionResponseBuilderGibt an, dass die angegebenen Teilnehmer dem Kalendertermin in der Antwort hinzugefügt werden sollen, wenn die zugehörige UI-Aktion ausgeführt wird.
build()CalendarEventActionResponseErstellt die aktuelle Antwort auf die Kalenderereignisaktion und validiert sie.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderGibt an, dass in der Antwort die angegebenen Konferenzdaten für den Kalendertermin festgelegt werden sollen, wenn die zugehörige UI-Aktion ausgeführt wird.

Card

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

CardAction

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)CardActionHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)CardActionLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setOnClickAction(action)CardActionHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)CardActionHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)CardActionHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setText(text)CardActionHiermit wird der Menütext für diese Aktion festgelegt.

CardBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addCardAction(cardAction)CardBuilderFügen Sie dieser Karte eine CardAction hinzu.
addSection(section)CardBuilderFügen Sie dieser Karte einen Abschnitt hinzu.
build()CardErstellt die aktuelle Karte und validiert sie.
setDisplayStyle(displayStyle)CardBuilderHiermit wird der Darstellungsstil für diese Karte festgelegt.
setFixedFooter(fixedFooter)CardBuilderLegt eine feste Fußzeile für diese Karte fest.
setHeader(cardHeader)CardBuilderHiermit wird der Header für diese Karte festgelegt.
setName(name)CardBuilderLegt den Namen für diese Karte fest.
setPeekCardHeader(peekCardHeader)CardBuilderLegt die Überschrift der Minikarte fest.

CardHeader

Methoden

MethodeRückgabetypKurzbeschreibung
setImageAltText(imageAltText)CardHeaderHiermit wird der alternative Text für das Kopfzeilenbild festgelegt.
setImageStyle(imageStyle)CardHeaderHiermit wird das Zuschneiden des Symbols in der Kartenüberschrift festgelegt.
setImageUrl(imageUrl)CardHeaderHiermit wird das Bild festgelegt, das im Header verwendet werden soll. Geben Sie dazu die URL oder den Datenstring an.
setSubtitle(subtitle)CardHeaderHiermit wird der Untertitel der Kartenüberschrift festgelegt.
setTitle(title)CardHeaderHiermit wird der Titel der Kartenüberschrift festgelegt.

CardSection

Methoden

MethodeRückgabetypKurzbeschreibung
addWidget(widget)CardSectionFügen Sie diesem Bereich das angegebene Widget hinzu.
setCollapseControl(collapseControl)CardSectionHier legen Sie die benutzerdefinierten Schaltflächen zum Maximieren und Minimieren des Bereichs fest.
setCollapsible(collapsible)CardSectionLegen Sie fest, ob der Bereich minimiert werden kann.
setHeader(header)CardSectionLegt die Überschrift des Abschnitts fest.
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSectionHier legen Sie fest, wie viele Widgets angezeigt werden, wenn dieser Bereich minimiert ist.

CardService

Attribute

AttributTypBeschreibung
BorderTypeBorderTypeDie Aufzählung BorderType.
ChipListLayoutChipListLayoutDie Aufzählung ChipListLayout.
ComposedEmailTypeComposedEmailTypeDie Aufzählung ComposedEmailType.
ContentTypeContentTypeDie Aufzählung ContentType.
GridItemLayoutGridItemLayoutDie Aufzählung GridItemLayout.
HorizontalAlignmentHorizontalAlignmentDie Aufzählung HorizontalAlignment.
IconIconDie Aufzählung Icon.
ImageButtonStyleImageButtonStyleDie Aufzählung ImageButtonStyle.
ImageCropTypeImageCropTypeDie Aufzählung ImageCropType.
ImageStyleImageStyleDie Aufzählung ImageStyle.
InputTypeInputTypeDie Aufzählung InputType.
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 Karten-Builder.
newCardHeader()CardHeaderErstellt einen neuen CardHeader
newCardSection()CardSectionErstellt einen neuen CardSection
newCardWithId()CardWithIdErstellt einen neuen CardWithId
newCarousel()CarouselErstellt einen Carousel.
newCarouselCard()CarouselCardErstellt einen neuen CarouselCard
newChatActionResponse()ChatActionResponseErstellt einen neuen ChatActionResponse
newChatResponseBuilder()ChatResponseBuilderErstellt einen neuen ChatResponseBuilder
newChip()ChipErstellt einen neuen Chip
newChipList()ChipListErstellt einen neuen ChipList
newCollapseControl()CollapseControlErstellt einen neuen CollapseControl
newColumn()ColumnErstellt einen neuen Column
newColumns()ColumnsErstellt einen neuen Satz von Columns.
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
newLinkPreview()LinkPreviewErstellt einen neuen LinkPreview
newMaterialIcon()MaterialIconErstellt einen neuen MaterialIcon
newNavigation()NavigationErstellt einen neuen Navigation
newNotification()NotificationErstellt einen neuen Notification
newOpenLink()OpenLinkErstellt einen neuen OpenLink
newOverflowMenu()OverflowMenuErstellt einen neuen OverflowMenu
newOverflowMenuItem()OverflowMenuItemErstellt einen neuen OverflowMenuItem
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 eine neue UpdateDraftBccRecipientsAction.
newUpdateDraftBodyAction()UpdateDraftBodyActionErstellt einen neuen UpdateDraftBodyAction
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionErstellt einen neuen UpdateDraftCcRecipientsAction
newUpdateDraftSubjectAction()UpdateDraftSubjectActionErstellt einen neuen UpdateDraftSubjectAction
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionErstellt einen neuen UpdateDraftToRecipientsAction
newValidation()ValidationErstellt einen neuen Validation

CardWithId

Methoden

MethodeRückgabetypKurzbeschreibung
setCard(card)CardWithIdLegt die Karte des cardWithId fest.
setCardId(id)CardWithIdDie eindeutige Karten-ID der cardWithId.

Methoden

MethodeRückgabetypKurzbeschreibung
addCarouselCard(card)CarouselFügen Sie eine Karussellkarte hinzu.

CarouselCard

Methoden

MethodeRückgabetypKurzbeschreibung
addFooterWidget(widget)CarouselCardFügt das angegebene Widget der Fußzeile dieser Karussellkarte hinzu.
addWidget(widget)CarouselCardFügen Sie dieser Karussellkarte das angegebene Widget hinzu.

ChatActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
setDialogAction(dialogAction)ChatActionResponseLegt die Dialogaktion auf ein Ereignis fest, das sich auf einen Dialog bezieht.
setResponseType(responseType)ChatActionResponseDer Typ der Antwort in der Google Chat App.
setUpdatedWidget(updatedWidget)ChatActionResponseHiermit wird das aktualisierte Widget festgelegt, das für die automatische Vervollständigung von Optionen für ein Widget verwendet wird.
setUrl(url)ChatActionResponseDie URL, über die sich Nutzer authentifizieren oder konfigurieren können.

ChatClientDataSource

Methoden

MethodeRückgabetypKurzbeschreibung
setSpaceDataSource(spaceDataSource)ChatClientDataSourceEine Datenquelle, die Google Chat-Gruppenbereiche als Auswahlelemente für ein Mehrfachauswahlmenü enthält.

ChatResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

ChatResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addCardsV2(cardWithId)ChatResponseBuilderLegt das Kartenfeld der Nachricht fest.
build()ChatResponseDie aktuelle Aktionsantwort wird erstellt und validiert.
setActionResponse(actionResponse)ChatResponseBuilderLegt das Feld „action_response“ der Nachricht fest.
setText(text)ChatResponseBuilderLegt den Text der Chatnachricht fest.

ChatSpaceDataSource

Methoden

MethodeRückgabetypKurzbeschreibung
setDefaultToCurrentSpace(defaultToCurrentSpace)ChatSpaceDataSourceWenn Sie true festlegen, wird im Menü für die Mehrfachauswahl standardmäßig der aktuelle Google Chat-Bereich ausgewählt.

Chip

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ChipLegt den alternativen Text des Chips für die Barrierefreiheit fest.
setAuthorizationAction(action)ChipHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)ChipLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setDisabled(disabled)ChipLegt fest, ob der Chip deaktiviert ist.
setIcon(icon)ChipHier legen Sie das Symbol fest, das als Chip verwendet werden soll.
setLabel(label)ChipHiermit wird der Titel des Chips festgelegt.
setOnClickAction(action)ChipHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ChipHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ChipHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.

ChipList

Methoden

MethodeRückgabetypKurzbeschreibung
addChip(chip)ChipListFügen Sie einen Chip hinzu.
setLayout(layout)ChipListHiermit wird das Layout der Chipliste festgelegt.

ChipListLayout

Attribute

AttributTypBeschreibung
WRAPPEDEnumWenn nicht genügend horizontaler Platz vorhanden ist, wird die Chipliste in die nächste Zeile umgebrochen.
HORIZONTAL_SCROLLABLEEnumDie Chips werden horizontal gescrollt, wenn sie nicht in den verfügbaren Bereich passen.

CollapseControl

Methoden

MethodeRückgabetypKurzbeschreibung
setCollapseButton(button)CollapseControlHier wird die Button festgelegt, die für die Schaltfläche „Weniger anzeigen“ angezeigt wird.
setExpandButton(button)CollapseControlHier wird das Button festgelegt, das für die Schaltfläche „Mehr anzeigen“ angezeigt wird.
setHorizontalAlign(horizontalAlignment)CollapseControlLegt die HorizontalAlignment der CollapseControl fest.

Column

Columns

Methoden

MethodeRückgabetypKurzbeschreibung
addColumn(column)ColumnsDem Spalten-Widget wird eine Column hinzugefügt.
setWrapStyle(wrapStyle)ColumnsLegt den Umbruchstil der Spalten fest und steuert, wie sich die Spalte je nach Bildschirmbreite ändert.

CommonDataSource

Attribute

AttributTypBeschreibung
UNKNOWNEnumStandardwert.
USEREnumGoogle Workspace-Nutzer

ComposeActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

ComposeActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()ComposeActionResponseErstellt die aktuelle Antwort der Aktion „Compose“ und validiert sie.
setGmailDraft(draft)ComposeActionResponseBuilderLegt den Entwurf GmailMessage fest, der mit GmailMessage.createDraftReply(body) oder ähnlichen Funktionen erstellt wurde.

ComposedEmailType

Attribute

AttributTypBeschreibung
REPLY_AS_DRAFTEnumEin Entwurf, der eine Antwort auf eine andere Nachricht ist.
STANDALONE_DRAFTEnumEin Entwurf, der eine eigenständige Nachricht ist.

ContentType

Attribute

AttributTypBeschreibung
TEXTEnumGibt an, dass die generierten Inhalte Nur-Text sind.
MUTABLE_HTMLEnumGibt an, dass der generierte Inhalt als HTML formatiert ist.
IMMUTABLE_HTMLEnumGibt an, dass die generierten Inhalte als HTML formatiert sind, aber nach der Generierung nicht mehr bearbeitet werden können.

DatePicker

Methoden

MethodeRückgabetypKurzbeschreibung
setFieldName(fieldName)DatePickerLegt den Feldnamen fest, der diese Auswahl im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
setOnChangeAction(action)DatePickerLegt eine Action fest, die das Script ausführt, wenn sich die Eingabe der Auswahl ändert.
setTitle(title)DatePickerHiermit wird der Titel festgelegt, der über dem Eingabefeld angezeigt wird.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerLegt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerLegt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.

DateTimePicker

Methoden

MethodeRückgabetypKurzbeschreibung
setFieldName(fieldName)DateTimePickerLegt den Feldnamen fest, der diese Auswahl im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
setOnChangeAction(action)DateTimePickerLegt eine Action fest, die das Script ausführt, wenn sich die Eingabe der Auswahl ändert.
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePickerHiermit wird festgelegt, um wie viele Minuten die Zeitzone von UTC abweichen soll.
setTitle(title)DateTimePickerHiermit wird der Titel festgelegt, der über dem Eingabefeld angezeigt wird.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerLegt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerLegt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.

DecoratedText

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)DecoratedTextHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setBottomLabel(text)DecoratedTextHier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt.
setButton(button)DecoratedTextHiermit wird das Button festgelegt, das rechts neben dem Text angezeigt wird.
setComposeAction(action, composedEmailType)DecoratedTextLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setEndIcon(endIcon)DecoratedTextHiermit wird das optionale IconImage festgelegt, das rechts neben den Inhalten angezeigt wird.
setOnClickAction(action)DecoratedTextHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)DecoratedTextHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)DecoratedTextHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setStartIcon(startIcon)DecoratedTextLegt das optionale IconImage fest, das vor dem Textinhalt angezeigt werden soll.
setSwitchControl(switchToSet)DecoratedTextHiermit wird das Switch festgelegt, das rechts neben dem Inhalt angezeigt wird.
setText(text)DecoratedTextHier legen Sie den Text fest, der als Wert verwendet werden soll.
setTopLabel(text)DecoratedTextHier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird über dem Textinhalt angezeigt.
setWrapText(wrapText)DecoratedTextHiermit wird festgelegt, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.

Dialog

Methoden

MethodeRückgabetypKurzbeschreibung
setBody(card)DialogLegt die Karte des Dialog fest.

DialogAction

Methoden

MethodeRückgabetypKurzbeschreibung
setActionStatus(actionStatus)DialogActionLegt den Aktionsstatus von DialogAction fest.
setDialog(dialog)DialogActionLegt das Dialogfeld für die DialogAction fest.

DisplayStyle

Attribute

AttributTypBeschreibung
PEEKEnumDer Kartenheader wird unten in den Add-on-Inhalten über vorhandenen Inhalten angezeigt.
REPLACEEnumZeigen Sie die Karte an, indem Sie vorhandene Inhalte ersetzen.

Divider

DriveItemsSelectedActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

DriveItemsSelectedActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()DriveItemsSelectedActionResponseErstellt die aktuelle Antwort der Drive-Aktion.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderGibt an, dass in der Antwort der Dateibereich für das kontextuell relevante Element in Drive angefordert wird.

EditorFileScopeActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

EditorFileScopeActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()EditorFileScopeActionResponseErstellt die aktuelle Antwort der Editor-Aktion.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderHier wird der drive.file-Bereich für das aktuell aktive Editor-Dokument angefordert.

FixedFooter

Methoden

MethodeRückgabetypKurzbeschreibung
setPrimaryButton(button)FixedFooterLegen Sie die primäre Schaltfläche in der fixierten Fußzeile fest.
setSecondaryButton(button)FixedFooterLegen Sie die sekundäre Schaltfläche in der fixen Fußzeile fest.

Grid

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(gridItem)GridDem Raster wird ein neues Rasterelement hinzugefügt.
setAuthorizationAction(action)GridHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setBorderStyle(borderStyle)GridLegt den Rahmenstil fest, der auf jedes Rasterelement angewendet wird.
setComposeAction(action, composedEmailType)GridLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setNumColumns(numColumns)GridDie Anzahl der Spalten, die im Raster angezeigt werden sollen.
setOnClickAction(action)GridHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)GridHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)GridHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setTitle(title)GridHiermit wird der Titeltext des Rasters festgelegt.

GridItem

Methoden

MethodeRückgabetypKurzbeschreibung
setIdentifier(id)GridItemLegt die Kennung für das Rasterelement fest.
setImage(image)GridItemHiermit wird das Bild für dieses Rasterelement festgelegt.
setLayout(layout)GridItemHiermit wird das Layout von Text und Bild für das Rasterelement festgelegt.
setSubtitle(subtitle)GridItemHiermit wird der Untertitel des Rasterelements festgelegt.
setTextAlignment(alignment)GridItemLegt die horizontale Ausrichtung des Rasterelements fest.
setTitle(title)GridItemHiermit wird der Titeltext des Rasterelements festgelegt.

GridItemLayout

Attribute

AttributTypBeschreibung
TEXT_BELOWEnumTitel und Untertitel werden unter dem Bild des Rasterelements angezeigt.
TEXT_ABOVEEnumTitel und Untertitel werden über dem Bild des Rasterelements angezeigt.

HorizontalAlignment

Attribute

AttributTypBeschreibung
STARTEnumRichten Sie das Widget am Anfang des Satzes aus.
CENTEREnumZentrieren Sie das Widget.
ENDEnumRichten Sie das Widget am Ende des Satzes aus.

HorizontalSizeStyle

Attribute

AttributTypBeschreibung
FILL_AVAILABLE_SPACEEnumDie Größe des Widget wird so angepasst, dass es den verfügbaren horizontalen Bereich eines Column ausfüllt.
FILL_MINIMUM_SPACEEnumDie Größe der Widget wird so angepasst, dass sie den geringsten horizontalen Raum in einer Column einnimmt.

HostAppDataSource

Methoden

MethodeRückgabetypKurzbeschreibung
setChatDataSource(chatClientDataSource)HostAppDataSourceLegt die Datenquelle aus Google Chat fest.

Icon

Attribute

AttributTypBeschreibung
NONEEnumKein Symbol.
AIRPLANEEnumSymbol für Flug eines Flugzeugs
BOOKMARKEnumLesezeichensymbol
BUSEnumBussymbol
CAREnumAutosymbol
CLOCKEnumUhrsymbol
CONFIRMATION_NUMBER_ICONEnumSymbol für die Bestätigungsnummer
DOLLAREnumDollarsymbol
DESCRIPTIONEnumSymbol „Beschreibung“
EMAILEnumE-Mail-Symbol
EVENT_PERFORMEREnumE-Mail-Symbol
EVENT_SEATEnumSymbol für Veranstaltungssitz
FLIGHT_ARRIVALEnumSymbol für Ankunft eines Flugs
FLIGHT_DEPARTUREEnumSymbol für den Flugabflug
HOTELEnumHotelsymbol
HOTEL_ROOM_TYPEEnumHotelsymbol
INVITEEnumSymbol „Einladen“
MAP_PINEnumSymbol für eine Markierung auf einer Karte
MEMBERSHIPEnumMitgliedschaftssymbol
MULTIPLE_PEOPLEEnumSymbol für mehrere Personen
OFFEREnumSymbol: Angebot
PERSONEnumPersonensymbol
PHONEEnumTelefonsymbol
RESTAURANT_ICONEnumRestaurantsymbol
SHOPPING_CARTEnumEinkaufswagensymbol
STAREnumSternsymbol
STOREEnumHändlersymbol
TICKETEnumTicketsymbol
TRAINEnumZugsymbol
VIDEO_CAMERAEnumVideokamerasymbol
VIDEO_PLAYEnumVideowiedergabesymbol

IconImage

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)IconImageLegt den alternativen Text der URL fest, der für die Barrierefreiheit verwendet wird.
setIcon(icon)IconImageDas vordefinierte Symbol wird festgelegt, wenn die URL nicht festgelegt ist.
setIconUrl(url)IconImageLegt die URL des Symbols fest, falls das Symbol nicht festgelegt ist.
setImageCropType(imageCropType)IconImageHiermit wird der Zuschnittsstil für das Bild festgelegt.
setMaterialIcon(icon)IconImageHiermit wird das Material Design-Symbol festgelegt.

Image

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageHier legen Sie den alternativen Text des Bilds für mehr Barrierefreiheit fest.
setAuthorizationAction(action)ImageHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)ImageLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setImageUrl(url)ImageHier wird das Bild festgelegt, das verwendet werden soll. Geben Sie dazu die URL oder den Datenstring an.
setOnClickAction(action)ImageHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ImageHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ImageHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.

ImageButton

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageButtonHiermit wird der alternative Text der Schaltfläche für die Barrierefreiheit festgelegt.
setAuthorizationAction(action)ImageButtonHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)ImageButtonLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setIcon(icon)ImageButtonHiermit wird eine vordefinierte Icon festgelegt, die auf der Schaltfläche angezeigt wird.
setIconUrl(url)ImageButtonHier wird die URL eines Bildes festgelegt, das als Symbol für diese Schaltfläche verwendet werden soll.
setImageButtonStyle(imageButtonStyle)ImageButtonHier legen Sie den Schaltflächenstil fest.
setMaterialIcon(icon)ImageButtonHiermit wird das Material Design-Symbol festgelegt.
setOnClickAction(action)ImageButtonHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ImageButtonHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ImageButtonHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setOverflowMenu(menu)ImageButtonHiermit wird ein Pop-up-Menü festgelegt, das geöffnet wird, wenn auf das Objekt geklickt wird.

ImageButtonStyle

Attribute

AttributTypBeschreibung
BORDERLESSEnumBildschaltfläche ohne Rahmen.
OUTLINEDEnumBildschaltfläche mit transparentem Hintergrund
FILLEDEnumBildschaltfläche mit farbigem Hintergrund
FILLED_TONALEnumBildschaltfläche als Mittelweg zwischen gefüllten und umrandeten Schaltflächen.

ImageComponent

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageComponentLegt den alternativen Text des Bildes fest.
setBorderStyle(borderStyle)ImageComponentHier legen Sie den Rahmenstil fest, der auf das Bild angewendet wird.
setCropStyle(imageCropStyle)ImageComponentHiermit wird der Zuschnittsstil für das Bild festgelegt.
setImageUrl(url)ImageComponentHier wird die URL des Bildes festgelegt.

ImageCropStyle

Methoden

MethodeRückgabetypKurzbeschreibung
setAspectRatio(ratio)ImageCropStyleLegen Sie das Seitenverhältnis fest, das verwendet werden soll, wenn der Zuschnittstyp RECTANGLE_CUSTOM ist.
setImageCropType(type)ImageCropStyleHiermit wird der Zuschnittstyp für das Bild festgelegt.

ImageCropType

Attribute

AttributTypBeschreibung
SQUAREEnumZuschnittsstil „Quadrat“
CIRCLEEnumZuschneidestil „Kreis“
RECTANGLE_CUSTOMEnumRechteckiger Zuschnitt mit benutzerdefiniertem Seitenverhältnis
RECTANGLE_4_3EnumRechteckiger Zuschnitt mit einem Seitenverhältnis von 4:3.

ImageStyle

Attribute

AttributTypBeschreibung
SQUAREEnumOhne Zuschneiden.
CIRCLEEnumZuschneiden auf eine kreisförmige Form

InputType

Attribute

AttributTypBeschreibung
TEXTEnumAkzeptieren Sie nur normalen Text.
INTEGEREnumAkzeptieren Sie nur Ganzzahlen.
FLOATEnumGleitkommazahlen sind zulässig.
EMAILEnumE-Mail-Adresse akzeptieren

Interaction

Attribute

AttributTypBeschreibung
INTERACTION_UNSPECIFIEDEnumStandardwert.
OPEN_DIALOGEnumÖffnet ein Dialogfeld, eine kartenbasierte Benutzeroberfläche, über die Chat-Apps mit Nutzern interagieren.

KeyValue

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)KeyValueHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)KeyValueLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setOnClickAction(action)KeyValueHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)KeyValueHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)KeyValueHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.

LinkPreview

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setLinkPreviewTitle(title)LinkPreviewHier legen Sie den Titel fest, der in der Linkvorschau über der Vorschaukarte angezeigt wird.
setPreviewCard(previewCard)LinkPreviewLegt die Karte fest, auf der Informationen zu einem Link von einem Drittanbieter oder einem anderen Dienst als Google angezeigt werden.
setTitle(title)LinkPreviewLegt den Titel fest, der im Smartchip für die Linkvorschau angezeigt wird.

LoadIndicator

Attribute

AttributTypBeschreibung
SPINNEREnumVerwenden Sie einen Ladebalken.
NONEEnumVerwenden Sie keinen Indikator.

MaterialIcon

Methoden

MethodeRückgabetypKurzbeschreibung
setFill(fill)MaterialIconGibt an, ob das Symbol als ausgefüllt dargestellt wird.
setGrade(grade)MaterialIconGewicht und Stärke wirken sich auf die Dicke eines Symbols aus.
setName(name)MaterialIconLegt den Namen des Symbols fest.
setWeight(weight)MaterialIconDie Strichstärke des Symbols.

Methoden

MethodeRückgabetypKurzbeschreibung
popCard()NavigationEine Karte wird aus dem Navigationsstapel herausgeschoben.
popToNamedCard(cardName)NavigationRuft die angegebene Karte über den Kartennamen auf.
popToRoot()NavigationDer Kartenstapel wird zur Stammkarte maximiert.
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
pushCard(card)NavigationDie angegebene Karte wird auf den Stapel gelegt.
updateCard(card)NavigationErsetzt die aktuelle Karte.

Notification

Methoden

MethodeRückgabetypKurzbeschreibung
setText(text)NotificationHier legen Sie fest, welcher Text in der Benachrichtigung angezeigt werden soll.

OnClose

Attribute

AttributTypBeschreibung
NOTHINGEnumBeim Schließen nichts tun.
RELOADEnumDas Add-on wird neu geladen, wenn das Fenster geschlossen wird.

OpenAs

Attribute

AttributTypBeschreibung
FULL_SIZEEnumIn einem vollständigen Fenster oder Tab öffnen.
OVERLAYEnumAls Overlay öffnen, z. B. als Pop-up-Fenster.

Methoden

MethodeRückgabetypKurzbeschreibung
setOnClose(onClose)OpenLinkHiermit wird das Verhalten der URL-Aktion festgelegt, wenn das URL-Fenster oder der URL-Tab geschlossen wird.
setOpenAs(openAs)OpenLinkHiermit wird das Verhalten der URL beim Öffnen festgelegt.
setUrl(url)OpenLinkLegt die zu öffnende URL fest.

OverflowMenu

Methoden

MethodeRückgabetypKurzbeschreibung
addMenuItem(menuItem)OverflowMenuHiermit wird ein Menüpunkt hinzugefügt.

OverflowMenuItem

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)OverflowMenuItemHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)OverflowMenuItemLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setDisabled(disabled)OverflowMenuItemGibt an, ob der Menüpunkt deaktiviert ist.
setOnClickAction(action)OverflowMenuItemHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)OverflowMenuItemHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)OverflowMenuItemHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setStartIcon(icon)OverflowMenuItemHiermit wird das Hauptsymbol des Menüpunkts festgelegt.
setText(text)OverflowMenuItemLegt den Titel des Menüpunkts fest.

PlatformDataSource

Methoden

MethodeRückgabetypKurzbeschreibung
setCommonDataSource(commonDataSource)PlatformDataSourceHier legen Sie die Datenquelle aus Google Workspace fest.
setHostAppDataSource(hostAppDataSource)PlatformDataSourceWird verwendet, um Bereiche im Mehrfachauswahlmenü auszufüllen.

ResponseType

Attribute

AttributTypBeschreibung
TYPE_UNSPECIFIEDEnumStandardtyp, der als NEW_MESSAGE behandelt wird.
NEW_MESSAGEEnumPosten Sie eine neue Nachricht im Thema.
UPDATE_MESSAGEEnumAktualisieren Sie die Nachricht in der Chat App.
UPDATE_USER_MESSAGE_CARDSEnumKarten in der Nachricht eines Nutzers aktualisieren
REQUEST_CONFIGEnumBitten Sie den Nutzer privat um eine zusätzliche Authentifizierung oder Konfiguration.
DIALOGEnumEin Dialogfeld wird angezeigt.
UPDATE_WIDGETEnumAbfrage zu Optionen für die automatische Vervollständigung von Widget-Text

SelectionInput

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(text, value, selected)SelectionInputHiermit wird ein neues Element hinzugefügt, das ausgewählt werden kann.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputFügen Sie ein neues Element hinzu, das in Menüs mit Mehrfachauswahl ausgewählt werden kann.
setExternalDataSource(action)SelectionInputLegt eine externe Datenquelle fest, z. B. eine relationale Datenbank.
setFieldName(fieldName)SelectionInputLegt den Schlüssel fest, der diese Auswahleingabe im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputLegt die maximale Anzahl von Elementen fest, die ein Nutzer auswählen kann.
setMultiSelectMinQueryLength(queryLength)SelectionInputLegt die Anzahl der Textzeichen fest, die ein Nutzer eingeben muss, bevor die App die automatische Vervollständigung abfragt und Vorschläge auf der Karte anzeigt.
setOnChangeAction(action)SelectionInputHiermit wird eine Action festgelegt, die ausgeführt wird, wenn sich die Auswahleingabe ändert.
setPlatformDataSource(platformDataSource)SelectionInputHiermit wird eine Datenquelle aus Google Workspace festgelegt.
setTitle(title)SelectionInputHier legen Sie den Titel fest, der vor dem Eingabefeld angezeigt werden soll.
setType(type)SelectionInputLegt den Typ dieser Eingabe fest.

SelectionInputType

Attribute

AttributTypBeschreibung
CHECK_BOXEnumEingabestil für Kästchen.
RADIO_BUTTONEnumEingabestil für Optionsfelder.
DROPDOWNEnumEingabestil für die Auswahl eines Drop-down-Menüs.
SWITCHEnumEine Reihe von Schaltern.
MULTI_SELECTEnumEin Mehrfachauswahlmenü für statische oder dynamische Daten.

Status

Attribute

AttributTypBeschreibung
OKEnumHTTP Mapping: 200 OK
CANCELLEDEnumHTTP Mapping: 499 Client Closed Request
UNKNOWNEnumUnbekannter Fehler.
INVALID_ARGUMENTEnumDer Client hat ein ungültiges Argument angegeben.
DEADLINE_EXCEEDEDEnumHTTP Mapping: 504 Gateway Timeout
NOT_FOUNDEnumHTTP Mapping: 404 Not Found
ALREADY_EXISTSEnumDie Entität, die ein Client erstellen wollte, existiert bereits.
PERMISSION_DENIEDEnumHTTP Mapping: 403 Forbidden
UNAUTHENTICATEDEnumHTTP Mapping: 401 Unauthorized
RESOURCE_EXHAUSTEDEnumHTTP Mapping: 429 Too Many Requests
FAILED_PRECONDITIONEnumDer Vorgang wurde abgelehnt, weil der Systemzustand nicht für die Ausführung des Vorgangs geeignet ist.
ABORTEDEnumDer Vorgang wurde abgebrochen, in der Regel aufgrund eines Parallelitätsproblems wie einer fehlgeschlagenen Sequencer-Überprüfung oder einer abgebrochenen Transaktion.
OUT_OF_RANGEEnumBeim Vorgang wurde versucht, den gültigen Bereich zu überschreiten.
UNIMPLEMENTEDEnumHTTP Mapping: 501 Not Implemented
INTERNALEnumInterne Fehler.
UNAVAILABLEEnumHTTP Mapping: 503 Service Unavailable
DATA_LOSSEnumDauerhafter Datenverlust oder Datenkorruption.

Suggestions

Methoden

MethodeRückgabetypKurzbeschreibung
addSuggestion(suggestion)SuggestionsFügen Sie einen Textvorschlag hinzu.
addSuggestions(suggestions)SuggestionsFügen Sie eine Liste mit Textvorschlägen hinzu.

SuggestionsResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

SuggestionsResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()SuggestionsResponseErstellt die aktuelle Antwort mit Vorschlägen und validiert sie.
setSuggestions(suggestions)SuggestionsResponseBuilderHier legen Sie fest, welche Vorschläge in Textfeldern für die automatische Vervollständigung verwendet werden.

Switch

Methoden

MethodeRückgabetypKurzbeschreibung
setControlType(controlType)SwitchHiermit wird der Steuerelementtyp des Schalters festgelegt.
setFieldName(fieldName)SwitchLegt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
setOnChangeAction(action)SwitchHier legen Sie fest, welche Aktion ausgeführt werden soll, wenn der Schalter betätigt wird.
setSelected(selected)SwitchLegen Sie fest, ob dieser Schalter zu Beginn ausgewählt oder deaktiviert sein soll.
setValue(value)SwitchLegt den Wert fest, der als Formulareingabe gesendet wird, wenn diese Option aktiviert ist.

SwitchControlType

Attribute

AttributTypBeschreibung
SWITCHEnumEin/Aus-Steuerung für ein Schalter-Widget.
CHECK_BOXEnumKästchen-Steuerelement für ein Schalter-Widget.

TextButton

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)TextButtonHiermit wird der alternative Text der Schaltfläche für die Barrierefreiheit festgelegt.
setAuthorizationAction(action)TextButtonHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setBackgroundColor(backgroundColor)TextButtonHier legen Sie die Hintergrundfarbe der Schaltfläche TextButtonStyle.FILLED fest.
setComposeAction(action, composedEmailType)TextButtonLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setDisabled(disabled)TextButtonLegt fest, ob die Schaltfläche deaktiviert ist.
setIcon(icon)TextButtonHiermit wird eine vordefinierte Icon festgelegt, die auf der Schaltfläche angezeigt wird.
setIconUrl(url)TextButtonHier wird die URL eines Bildes festgelegt, das als Symbol für diese Schaltfläche verwendet werden soll.
setMaterialIcon(icon)TextButtonHiermit wird das Material Design-Symbol festgelegt.
setOnClickAction(action)TextButtonHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)TextButtonHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)TextButtonHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setOverflowMenu(menu)TextButtonHiermit wird ein Pop-up-Menü festgelegt, das geöffnet wird, wenn auf das Objekt geklickt wird.
setText(text)TextButtonHier legen Sie den Text fest, der auf der Schaltfläche angezeigt wird.
setTextButtonStyle(textButtonStyle)TextButtonHier legen Sie den Schaltflächenstil fest.

TextButtonStyle

Attribute

AttributTypBeschreibung
OUTLINEDEnumSchaltfläche mit normalem Text und transparentem Hintergrund
TEXTEnumNICHT VERWENDEN.
FILLEDEnumTextschaltfläche mit farbigem Hintergrund.
FILLED_TONALEnumNormale Textschaltfläche, die eine Alternative zwischen gefüllten und umrandeten Schaltflächen darstellt.
BORDERLESSEnumSchaltfläche mit normalem Text ohne Rahmen.

TextInput

Methoden

MethodeRückgabetypKurzbeschreibung
setFieldName(fieldName)TextInputLegt den Schlüssel fest, der diese Texteingabe im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
setHint(hint)TextInputLegt einen Hinweis für die Texteingabe fest.
setMultiline(multiline)TextInputHiermit wird festgelegt, ob der Eingabetext in einer oder mehreren Zeilen angezeigt wird.
setOnChangeAction(action)TextInputHiermit wird eine Aktion festgelegt, die ausgeführt werden soll, wenn sich die Texteingabe ändert.
setSuggestions(suggestions)TextInputHier legen Sie die Vorschläge für die automatische Vervollständigung im Textfeld fest.
setSuggestionsAction(suggestionsAction)TextInputHiermit wird die Callback-Aktion festgelegt, um Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abzurufen.
setTitle(title)TextInputHiermit wird der Titel festgelegt, der über dem Eingabefeld angezeigt wird.
setValidation(validation)TextInputHier legen Sie die Validierungsregel für dieses Widget fest.
setValue(value)TextInputLegt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.

TextParagraph

Methoden

MethodeRückgabetypKurzbeschreibung
setMaxLines(maxLines)TextParagraphHiermit wird die maximale Anzahl von Textzeilen festgelegt, die im Widget angezeigt werden.
setText(text)TextParagraphHiermit wird der Text des Absatzes festgelegt.

TimePicker

Methoden

MethodeRückgabetypKurzbeschreibung
setFieldName(fieldName)TimePickerLegt den Feldnamen fest, der diese Auswahl im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
setHours(hours)TimePickerLegt den im Eingabefeld vorausgefüllten Wert für die Stunden fest.
setMinutes(minutes)TimePickerLegt den voreingestellten Minutenwert fest, der im Eingabefeld festgelegt werden soll.
setOnChangeAction(action)TimePickerLegt eine Action fest, die das Script ausführt, wenn sich die Eingabe der Auswahl ändert.
setTitle(title)TimePickerHiermit wird der Titel festgelegt, der über dem Eingabefeld angezeigt wird.

UniversalActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

UniversalActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()UniversalActionResponseDie aktuelle Antwort für die universelle Aktion wird erstellt und validiert.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderDas Add-on wird mit den angegebenen Karten angezeigt.
setOpenLink(openLink)UniversalActionResponseBuilderHier legen Sie die URL fest, die geöffnet werden soll, wenn die universelle Aktion ausgewählt wird.

UpdateDraftActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.

UpdateDraftActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()UpdateDraftActionResponseDie aktuelle Antwort auf die Aktion „Update-Entwurf“ wird erstellt und validiert.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderHiermit wird eine Aktion festgelegt, mit der die E-Mail-Empfänger in der Zeile „Bcc“ eines Entwurfs aktualisiert werden.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderLegen Sie eine Aktion fest, mit der der E-Mail-Text eines Entwurfs aktualisiert wird.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderHiermit wird eine Aktion festgelegt, die die Cc-Empfänger eines Entwurfs aktualisiert.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderHiermit wird eine Aktion festgelegt, die die Betreffzeile eines Entwurfs aktualisiert.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderHiermit wird eine Aktion festgelegt, die die Empfänger eines Entwurfs aktualisiert.

UpdateDraftBccRecipientsAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionAktualisiert die Bcc-Empfänger eines E-Mail-Entwurfs.

UpdateDraftBodyAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateContent(content, contentType)UpdateDraftBodyActionFügt dem Textkörper des Entwurfs den angegebenen Inhalt hinzu.
setUpdateType(updateType)UpdateDraftBodyActionLegt den UpdateDraftBodyType dieser Aktualisierungsaktion im Textkörper des Entwurfs fest.

UpdateDraftBodyType

Attribute

AttributTypBeschreibung
IN_PLACE_INSERTEnumStandard.
INSERT_AT_STARTEnumBei Aktualisierungsaktionen wird der Inhalt am Anfang des Nachrichtentexts eingefügt.
INSERT_AT_ENDEnumMit Aktualisierungsaktionen wird Inhalt am Ende des Nachrichtentexts eingefügt.

UpdateDraftCcRecipientsAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsActionAktualisiert die Cc-Empfänger eines E-Mail-Entwurfs.

UpdateDraftSubjectAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateSubject(subject)UpdateDraftSubjectActionAktualisiert die Betreffzeile eines E-Mail-Entwurfs.

UpdateDraftToRecipientsAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionAktualisiert die Empfänger eines E-Mail-Entwurfs.

UpdatedWidget

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(text, value, selected, startIconUri, bottomText)UpdatedWidgetHiermit wird ein neues Element hinzugefügt, das ausgewählt werden kann.

Validation

Methoden

MethodeRückgabetypKurzbeschreibung
setCharacterLimit(characterLimit)ValidationHiermit wird die Zeichenbeschränkung des Widgets festgelegt.
setInputType(inputType)ValidationHiermit wird der Eingabetyp des Widgets festgelegt.

VerticalAlignment

Attribute

AttributTypBeschreibung
CENTEREnumDer Inhalt wird vertikal in der Mitte des Containers platziert.
TOPEnumDie Inhalte werden vertikal oben im Container platziert.
BOTTOMEnumDer Inhalt wird vertikal unten im Container platziert.

Widget

WrapStyle

Attribute

AttributTypBeschreibung
NOWRAPEnumOhne Umbruch.
WRAPEnumDer Inhalt aller Widgets in einer Spalte wird umgebrochen.