Card Service

Kartendienst

Mit diesem Dienst können Skripts Karten- und Widgetkomponenten und -verhalten für eine UI konfigurieren und erstellen. Die UI-Strukturen, die Sie mit diesem Dienst erstellen, sind automatisch sowohl auf Computern als auch auf Mobilgeräten verfügbar. Sie müssen also nicht für beide eine separate UI entwickeln.

Kurse

NameKurzbeschreibung
ActionEine Aktion, die Interaktivität innerhalb von UI-Elementen ermöglicht.
ActionResponseDas Antwortobjekt, das von einer Callback-Funktion zurückgegeben werden kann (z.B. einem Formularantwort-Handler), um eine oder mehrere Aktionen auf dem Client auszuführen.
ActionResponseBuilderEin Builder für ActionResponse-Objekte.
ActionStatus
AttachmentStellt einen von einem Add-on erstellten Anhang dar.
AuthorizationActionEine Autorisierungsaktion, bei der der Nutzer beim Anklicken an die AuthorizationUrl weitergeleitet wird.
AuthorizationExceptionEin Fehler, der zurückgegeben werden kann, um dem Nutzer eine Autorisierungskarte anzuzeigen.
BorderStyleEine Klasse, die einen vollständigen Rahmenstil darstellt, der auf Widgets angewendet werden kann.
BorderTypeEin Enum-Wert, der die Rahmentypen 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, die Änderungen an dem Kalendertermin vornimmt, den der Nutzer gerade bearbeitet, als Reaktion auf eine Aktion in der UI, z. B. das Klicken auf eine Schaltfläche.
CalendarEventActionResponseBuilderEin Builder für CalendarEventActionResponse-Objekte.
CardEine Kontextkarte, die eine einzelne Ansicht auf der UI darstellt.
CardActionKlickbarer Menüpunkt, der dem Menü in der Kopfzeile der Karte hinzugefügt wird
CardBuilderEin Builder für Card-Objekte.
CardHeaderDer Header von Card.
CardSectionEin Kartenabschnitt enthält Gruppen von Widgets und bietet eine visuelle Trennung zwischen ihnen.
CardServiceCardService bietet die Möglichkeit, generische Karten zu erstellen, die in verschiedenen Google-Erweiterbarkeitsprodukten wie Google Workspace-Add-ons verwendet werden.
CardWithId
ChatActionResponse
ChatClientDataSource
ChatResponse
ChatResponseBuilder
ChatSpaceDataSource
ColumnEine Spalte.
ColumnsDas Columns-Widget zeigt bis zu zwei Spalten auf einer Karte oder einem Dialogfeld an.
CommonDataSource
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 des von einem UpdateDraftActionResponse generierten Inhalts angibt.
DatePickerEin Eingabefeld, in das ein Datum eingegeben werden kann.
DateTimePickerEin Eingabefeld, in das Nutzer Datum und Uhrzeit eingeben können.
DecoratedTextEin Widget, das Text mit optionalen Dekorationen anzeigt.
Dialog
DialogAction
DisplayStyleEin Enum-Wert, der den Anzeigestil der Karte definiert.
DividerEine horizontale Trennlinie.
DriveItemsSelectedActionResponseStellt eine Antwort dar, die Änderungen an Drive vornimmt, während Drive-Elemente ausgewählt sind, und als Reaktion auf eine Aktion in der Benutzeroberfläche, z. B. das Klicken auf eine Schaltfläche.
DriveItemsSelectedActionResponseBuilderEin Builder für DriveItemsSelectedActionResponse-Objekte.
EditorFileScopeActionResponseÄnderungen an einem Editor wie Google Docs, Google Tabellen oder Google Präsentationen als Reaktion auf eine Aktion in der UI vornehmen
EditorFileScopeActionResponseBuilderEin Builder für EditorFileScopeActionResponse-Objekte.
FixedFooterDie feste Fußzeile, die unten in Card angezeigt wird.
GridEin organisiertes Raster zur Anzeige einer Sammlung von Rasterelementen.
GridItemDie Elemente, mit denen Nutzende in einem Raster-Widget interagieren.
GridItemLayoutEin Enum-Wert, der das Bild und den Textstil eines GridItems definiert.
HorizontalAlignmentEin Enum-Wert, der die horizontale Ausrichtung eines Widgets angibt.
HorizontalSizeStyleEin Enum, das festlegt, wie Widgets den Bereich einer Spalte ausfüllen.
HostAppDataSource
IconVordefinierte Symbole, die in verschiedenen UI-Objekten wie ImageButton- oder DecoratedText-Widgets verwendet werden können.
IconImageEin vordefiniertes Symbol oder ein Symbol von einer URL mit anpassbarem Zuschnittstil.
ImageEin Widget, das ein einzelnes Bild anzeigt.
ImageButtonEin ImageButton mit einem Bild.
ImageComponentEine Bildkomponente, die Rasterelementen hinzugefügt werden kann
ImageCropStyleEine Klasse, die einen Zuschnittstil darstellt, der auf Bildkomponenten angewendet werden kann.
ImageCropTypeEin Enum-Wert, der die Zuschneidestile darstellt, die auf die Bildkomponenten angewendet werden.
ImageStyleEin Enum-Wert, der einen Bildzuschnittsstil definiert.
Interaction
KeyValueDiese Klasse wurde eingestellt.
LinkPreviewKartenaktion, bei der eine Linkvorschaukarte und ein Smartchip in der Host-App angezeigt werden.
LoadIndicatorEin enum-Typ, der den Typ des Lade- oder Fortschrittsanzeigen angibt, der während der Verarbeitung eines Action angezeigt wird.
NavigationEin Hilfsobjekt, das die Kartennavigation steuert.
NotificationEine Benachrichtigung, die dem Nutzer als Reaktion auf die Interaktion mit einem UI-Element angezeigt wird.
OnCloseEin Enum-Wert, der angibt, was zu tun ist, wenn eine URL, die über einen OpenLink geöffnet wurde, geschlossen wird.
OpenAsEin Enum-Wert, der angibt, wie eine URL geöffnet wird.
OpenLinkStellt eine Aktion zum Öffnen eines Links mit einigen Optionen dar.
PlatformDataSource
ResponseType
SelectionInputEin Eingabefeld, das die Auswahl aus einer Reihe vordefinierter Optionen ermöglicht.
SelectionInputTypeDas Format der Elemente, die Nutzer auswählen können.
StatusEin Enum-Wert, der den Statuscode darstellt.
SuggestionsAutomatische Vervollständigungsvorschläge zur Ergänzung eines TextInput-Widgets.
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 das Ein- und Ausschalten unterstützt.
SwitchControlTypeTyp eines Switch-Widget-Steuerelements.
TextButtonEin TextButton mit einem Textlabel.
TextButtonStyleEin Enum-Wert, der den Stil für TextButton angibt.
TextInputEin Eingabefeld-Widget, das Texteingabe akzeptiert.
TextParagraphEin Widget, das Text anzeigt und die grundlegende 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, mit der der E-Mail-Entwurf aktualisiert wird, den der Nutzer gerade bearbeitet.
UpdateDraftActionResponseBuilderEin Builder für UpdateDraftActionResponse-Objekte.
UpdateDraftBccRecipientsActionHiermit werden die Bcc-Empfänger eines E-Mail-Entwurfs aktualisiert.
UpdateDraftBodyActionAktualisiert den Text des E-Mail-Entwurfs.
UpdateDraftBodyTypeEin ENUM-Wert, der den Typ einer UpdateDraftBodyAction angibt.
UpdateDraftCcRecipientsActionDamit werden die Cc-Empfänger eines E-Mail-Entwurfs aktualisiert.
UpdateDraftSubjectActionAktualisiert die Betreffzeile eines E-Mail-Entwurfs
UpdateDraftToRecipientsActionDamit werden die „An“-Empfänger eines E-Mail-Entwurfs aktualisiert.
UpdatedWidget
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-Wert, der den Umbruchstil für Inhalte in einer Spalte festlegt.

Action

Methoden

MethodeRückgabetypKurzbeschreibung
setFunctionName(functionName)ActionLegt den Namen der aufzurufenden Callback-Funktion fest.
setInteraction(interaction)ActionLegt die Interaktion mit einem Nutzer fest, ist nur beim Öffnen eines Dialogfelds erforderlich.
setLoadIndicator(loadIndicator)ActionLegt die Ladeanzeige fest, die angezeigt wird, während die Aktion ausgeführt wird.
setParameters(parameters)ActionErmöglicht die Übergabe benutzerdefinierter Parameter an die Callback-Funktion.
setPersistValues(persistValues)ActionGibt an, ob Formularwerte von den Werten des Clients oder den Werten des Servers bestimmt werden, nachdem die Card des Formulars durch eine Aktionsantwort aktualisiert wurde.

ActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

ActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()ActionResponseErstellt die aktuelle Aktionsantwort und validiert sie.
setNavigation(navigation)ActionResponseBuilderLegt die Antwort auf eine Navigation-Aktion fest.
setNotification(notification)ActionResponseBuilderLegt fest, dass die Benachrichtigung angezeigt wird, wenn die Aktion aktiviert wird.
setOpenLink(openLink)ActionResponseBuilderLegt die URL fest, zu der navigiert werden soll, wenn die Aktion aktiviert ist.
setStateChanged(stateChanged)ActionResponseBuilderLegt ein Flag fest, das anzeigt, dass durch diese Aktion der vorhandene Datenstatus geändert wurde.

ActionStatus

Methoden

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

Attachment

Methoden

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

AuthorizationAction

Methoden

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

AuthorizationException

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setAuthorizationUrl(authUrl)AuthorizationExceptionLegt die Autorisierungs-URL fest, zu der der Nutzer über die Autorisierungsaufforderung weitergeleitet wird.
setCustomUiCallback(callback)AuthorizationExceptionDer Name einer Funktion, die zum Generieren einer benutzerdefinierten Autorisierungsaufforderung aufgerufen werden soll.
setResourceDisplayName(name)AuthorizationExceptionLegt den Namen fest, der dem Nutzer bei der Autorisierungsanfrage angezeigt wird.
throwException()voidLöst diese Ausnahme aus, die ausgelöst wird.

BorderStyle

Methoden

MethodeRückgabetypKurzbeschreibung
setCornerRadius(radius)BorderStyleLegt den Eckenradius des Rahmens fest, z. B. 8.
setStrokeColor(color)BorderStyleLegt die Rahmenfarbe fest.
setType(type)BorderStyleLegt den Typ des Rahmens fest.

BorderType

Attribute

PropertyTypBeschreibung
NO_BORDEREnumKein Rahmenstil.
STROKEEnumKontur-Rahmenstil.

Button

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)ButtonLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setComposeAction(action, composedEmailType)ButtonLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setOnClickAction(action)ButtonLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ButtonLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ButtonLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.

ButtonSet

Methoden

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

CalendarEventActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

CalendarEventActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addAttachments(attachments)CalendarEventActionResponseBuilderGibt an, dass die Antwort die Anhänge dem Kalendertermin hinzufügen soll, wenn die zugehörige UI-Aktion ausgeführt wird.
addAttendees(emails)CalendarEventActionResponseBuilderGibt an, dass die Antwort die angegebenen Teilnehmer dem Kalendertermin hinzufügen soll, wenn die zugehörige UI-Aktion ausgeführt wird.
build()CalendarEventActionResponseErstellt die Antwort auf die aktuelle Kalenderereignisaktion und validiert sie.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderGibt an, dass die Antwort die angegebenen Konferenzdaten auf den Kalendertermin festlegen soll, wenn die zugehörige UI-Aktion ausgeführt wird.

Card

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

CardAction

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)CardActionLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setComposeAction(action, composedEmailType)CardActionLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setOnClickAction(action)CardActionLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)CardActionLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)CardActionLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.
setText(text)CardActionLegt den Menütext für diese Aktion fest.

CardBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addCardAction(cardAction)CardBuilderFügt dieser Karte eine CardAction hinzu.
addSection(section)CardBuilderFügt dieser Karte einen Abschnitt hinzu.
build()CardErstellt die aktuelle Karte und validiert sie.
setDisplayStyle(displayStyle)CardBuilderLegt den Darstellungsstil für diese Karte fest.
setFixedFooter(fixedFooter)CardBuilderLegt eine feste Fußzeile für diese Karte fest.
setHeader(cardHeader)CardBuilderLegt die Kopfzeile für diese Karte fest.
setName(name)CardBuilderLegt den Namen für diese Karte fest.
setPeekCardHeader(peekCardHeader)CardBuilderLegt den Titel der Peek-Karte fest.

CardHeader

Methoden

MethodeRückgabetypKurzbeschreibung
setImageAltText(imageAltText)CardHeaderLegt den alternativen Text für das Kopfzeilenbild fest.
setImageStyle(imageStyle)CardHeaderLegt fest, wie das Symbol in der Kopfzeile der Karte zugeschnitten werden soll.
setImageUrl(imageUrl)CardHeaderLegt das im Header zu verwendende Bild durch Angabe der URL oder des Datenstrings fest.
setSubtitle(subtitle)CardHeaderLegt den Untertitel des Kartenheaders fest.
setTitle(title)CardHeaderLegt den Titel der Kartenüberschrift fest.

CardSection

Methoden

MethodeRückgabetypKurzbeschreibung
addWidget(widget)CardSectionFügt das angegebene Widget zu diesem Abschnitt hinzu.
setCollapsible(collapsible)CardSectionLegt fest, ob der Abschnitt minimiert werden kann.
setHeader(header)CardSectionLegt die Kopfzeile des Abschnitts fest.
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSectionLegt die Anzahl der Widgets fest, die weiterhin angezeigt werden, wenn dieser Abschnitt minimiert wird.

CardService

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

CardWithId

Methoden

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

ChatActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
setDialogAction(dialogAction)ChatActionResponseLegt die Dialogaktion auf ein Ereignis fest, das sich auf ein Dialogfeld bezieht.
setResponseType(responseType)ChatActionResponseDer Antworttyp der Chat-App.
setUpdatedWidget(updatedWidget)ChatActionResponseLegt das aktualisierte Widget fest, mit dem Optionen für die automatische Vervollständigung für ein Widget bereitgestellt werden.
setUrl(url)ChatActionResponseDie URL, über die sich Nutzer authentifizieren oder konfigurieren können.

ChatClientDataSource

Methoden

MethodeRückgabetypKurzbeschreibung
setSpaceDataSource(spaceDataSource)ChatClientDataSourceEine Datenquelle, die in Google Chat-Gruppenbereichen als Auswahlelemente für ein Mehrfachauswahlmenü eingefügt wird.

ChatResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

ChatResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addCardsV2(cardWithId)ChatResponseBuilderLegt das Kartenfeld der Nachricht fest.
build()ChatResponseErstellt die aktuelle Aktionsantwort und validiert sie.
setActionResponse(actionResponse)ChatResponseBuilderLegt das Aktionsantwortfeld der Nachricht fest.
setText(text)ChatResponseBuilderLegt den Text der Chatnachricht fest.

ChatSpaceDataSource

Methoden

MethodeRückgabetypKurzbeschreibung
setDefaultToCurrentSpace(defaultToCurrentSpace)ChatSpaceDataSourceWenn true festgelegt ist, wird im Mehrfachauswahlmenü standardmäßig der aktuelle Google Chat-Bereich als Element ausgewählt.

Column

Columns

Methoden

MethodeRückgabetypKurzbeschreibung
addColumn(column)ColumnsFügt dem Spalten-Widget ein Column hinzu.
setWrapStyle(wrapStyle)ColumnsLegt den Zeilenumbruchstil der Spalten fest und steuert, wie die Spaltengröße basierend auf der Bildschirmbreite angepasst wird.

CommonDataSource

Attribute

PropertyTypBeschreibung
UNKNOWNEnumStandardwert.
USEREnumGoogle Workspace-Nutzer*innen.

ComposeActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

ComposeActionResponseBuilder

Methoden

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

ComposedEmailType

Attribute

PropertyTypBeschreibung
REPLY_AS_DRAFTEnumEinen Entwurf, der eine Antwort auf eine andere Nachricht ist
STANDALONE_DRAFTEnumEin Entwurf, bei dem es sich um eine eigenständige Nachricht handelt.

ContentType

Attribute

PropertyTypBeschreibung
TEXTEnumGibt an, dass der generierte Inhalt Nur-Text ist.
MUTABLE_HTMLEnumGibt an, dass der generierte Inhalt als HTML formatiert ist.
IMMUTABLE_HTMLEnumGibt an, dass der generierte Inhalt als HTML formatiert ist, aber nach der Generierung nicht mehr bearbeitet werden kann.

DatePicker

Methoden

MethodeRückgabetypKurzbeschreibung
setFieldName(fieldName)DatePickerLegt den Feldnamen fest, der diese Auswahl im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird.
setOnChangeAction(action)DatePickerLegt eine Action fest, die das Skript immer dann ausführt, wenn sich die Auswahleingabe ändert.
setTitle(title)DatePickerLegt den Titel fest, 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 bei einer UI-Interaktion generiert wird.
setOnChangeAction(action)DateTimePickerLegt eine Action fest, die das Skript immer dann ausführt, wenn sich die Auswahleingabe ändert.
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePickerLegt die Anzahl der Minuten fest, um die die Zeitzone von der UTC abweichen soll.
setTitle(title)DateTimePickerLegt den Titel fest, 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)DecoratedTextLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setBottomLabel(text)DecoratedTextLegt den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt.
setButton(button)DecoratedTextLegt das Button fest, das rechts neben dem Text angezeigt wird.
setComposeAction(action, composedEmailType)DecoratedTextLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setEndIcon(endIcon)DecoratedTextLegt den optionalen IconImage fest, der rechts neben dem Inhalt angezeigt wird.
setOnClickAction(action)DecoratedTextLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)DecoratedTextLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)DecoratedTextLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.
setStartIcon(startIcon)DecoratedTextLegt das optionale IconImage-Element fest, das vor dem Textinhalt angezeigt wird.
setSwitchControl(switchToSet)DecoratedTextLegt das Switch fest, das rechts neben dem Inhalt angezeigt wird.
setText(text)DecoratedTextLegt den Text fest, der als Wert verwendet werden soll.
setTopLabel(text)DecoratedTextLegt den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird über dem Textinhalt angezeigt.
setWrapText(wrapText)DecoratedTextLegt fest, ob der Werttext in einer einzelnen Zeile oder in mehreren Zeilen angezeigt werden soll.

Dialog

Methoden

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

DialogAction

Methoden

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

DisplayStyle

Attribute

PropertyTypBeschreibung
PEEKEnumDie Kopfzeile der Karte wird im unteren Bereich von Add-on-Inhalten über vorhandenen Inhalten angezeigt.
REPLACEEnumVorhandenen Inhalt ersetzen, um die Karte einzublenden.

Divider

DriveItemsSelectedActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

DriveItemsSelectedActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()DriveItemsSelectedActionResponseErstellt die aktuelle Drive-Aktionsantwort.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderGibt an, dass in der Antwort Dateiumfang für das kontextrelevante Element in Drive angefordert wird.

EditorFileScopeActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

EditorFileScopeActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()EditorFileScopeActionResponseErstellt die aktuelle Antwort auf die Editoraktion.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderFordert den Bereich drive.file für das aktuell aktive Editor-Dokument an.

FixedFooter

Methoden

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

Grid

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(gridItem)GridFügt dem Raster ein neues Rasterelement hinzu.
setAuthorizationAction(action)GridLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setBorderStyle(borderStyle)GridLegt den auf jedes Rasterelement angewendeten Rahmenstil fest.
setComposeAction(action, composedEmailType)GridLegt eine Aktion fest, mit der 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)GridLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)GridLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)GridLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.
setTitle(title)GridLegt den Titeltext des Rasters fest.

GridItem

Methoden

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

GridItemLayout

Attribute

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

HorizontalAlignment

Attribute

PropertyTypBeschreibung
STARTEnumRichte das Widget am Anfang der Satzseite aus.
CENTEREnumRichten Sie das Widget zentriert aus.
ENDEnumRichten Sie das Widget am Ende der Satzseite aus.

HorizontalSizeStyle

Attribute

PropertyTypBeschreibung
FILL_AVAILABLE_SPACEEnumDie Größe von Widget wird so angepasst, dass es die verfügbare horizontale Fläche von Column ausfüllt.
FILL_MINIMUM_SPACEEnumDie Größe von Widget wird so angepasst, dass es die geringste horizontale Fläche in einem Column-Element ausfüllt.

HostAppDataSource

Methoden

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

Icon

Attribute

PropertyTypBeschreibung
NONEEnumKein Symbol.
AIRPLANEEnumSymbol 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 Sitzplatz
FLIGHT_ARRIVALEnumLandesymbol
FLIGHT_DEPARTUREEnumSymbol für Abflug
HOTELEnumHotelsymbol
HOTEL_ROOM_TYPEEnumHotelsymbol
INVITEEnumEinladungssymbol
MAP_PINEnumStecknadelsymbol für die Karte
MEMBERSHIPEnumSymbol „Mitgliedschaft“
MULTIPLE_PEOPLEEnumSymbol für mehrere Personen
OFFEREnumSymbol: Angebot
PERSONEnumPersonensymbol
PHONEEnumTelefonsymbol
RESTAURANT_ICONEnumRestaurantsymbol
SHOPPING_CARTEnumEinkaufswagensymbol
STAREnumSternsymbol
STOREEnumStore-Symbol
TICKETEnumSymbol: Ticket
TRAINEnumZugsymbol
VIDEO_CAMERAEnumKamerasymbol
VIDEO_PLAYEnumVideowiedergabesymbol

IconImage

Methoden

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

Image

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageLegt den alternativen Text des Bildes für Barrierefreiheit fest.
setAuthorizationAction(action)ImageLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setComposeAction(action, composedEmailType)ImageLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setImageUrl(url)ImageLegt das zu verwendende Bild durch Angabe der URL oder des Datenstrings fest.
setOnClickAction(action)ImageLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ImageLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ImageLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.

ImageButton

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageButtonLegt den alternativen Text der Schaltfläche für Barrierefreiheit fest.
setAuthorizationAction(action)ImageButtonLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setComposeAction(action, composedEmailType)ImageButtonLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setIcon(icon)ImageButtonLegt eine vordefinierte Icon fest, die auf der Schaltfläche angezeigt wird.
setIconUrl(url)ImageButtonLegt die URL eines Bildes fest, das als Symbol für diese Schaltfläche verwendet werden soll.
setOnClickAction(action)ImageButtonLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ImageButtonLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ImageButtonLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.

ImageComponent

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageComponentLegt den alternativen Text des Bildes fest.
setBorderStyle(borderStyle)ImageComponentLegt den auf das Bild angewendeten Rahmenstil fest.
setCropStyle(imageCropStyle)ImageComponentLegt den Zuschnittstil für das Bild fest.
setImageUrl(url)ImageComponentLegt die URL des Bildes fest.

ImageCropStyle

Methoden

MethodeRückgabetypKurzbeschreibung
setAspectRatio(ratio)ImageCropStyleLegt das Seitenverhältnis fest, das verwendet werden soll, wenn der Zuschnitttyp RECTANGLE_CUSTOM ist.
setImageCropType(type)ImageCropStyleLegt den Zuschnitttyp für das Bild fest.

ImageCropType

Attribute

PropertyTypBeschreibung
SQUAREEnumZuschnitt in quadratischer Form.
CIRCLEEnumZuschneidestil Kreis
RECTANGLE_CUSTOMEnumZuschnittstil in Form eines Rechtecks mit benutzerdefiniertem Seitenverhältnis.
RECTANGLE_4_3EnumZuschnitt in rechteckiger Form mit Seitenverhältnis 4:3.

ImageStyle

Attribute

PropertyTypBeschreibung
SQUAREEnumNicht zugeschnitten.
CIRCLEEnumAuf Kreisform zuschneiden.

Interaction

Attribute

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

KeyValue

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)KeyValueLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setComposeAction(action, composedEmailType)KeyValueLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setOnClickAction(action)KeyValueLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)KeyValueLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)KeyValueLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.

LinkPreview

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setLinkPreviewTitle(title)LinkPreviewLegt 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 Drittanbieterdienst angezeigt werden.
setTitle(title)LinkPreviewLegt den Titel fest, der im Smartchip für die Linkvorschau angezeigt wird.

LoadIndicator

Attribute

PropertyTypBeschreibung
SPINNEREnumVerwenden Sie ein rotierendes Ladesymbol.
NONEEnumVerwenden Sie keinen Indikator.

Methoden

MethodeRückgabetypKurzbeschreibung
popCard()NavigationZieht eine Karte aus dem Navigationsstapel heraus.
popToNamedCard(cardName)NavigationRuft die angegebene Karte anhand ihres Kartennamens auf.
popToRoot()NavigationSetzt den Kartenstapel auf die Stammkarte.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
pushCard(card)NavigationSetzt die betreffende Karte auf den Stapel.
updateCard(card)NavigationErsetzt die aktuelle Karte direkt.

Notification

Methoden

MethodeRückgabetypKurzbeschreibung
setText(text)NotificationLegt den Text fest, der in der Benachrichtigung angezeigt werden soll.

OnClose

Attribute

PropertyTypBeschreibung
NOTHINGEnumBeim Schließen nichts unternehmen.
RELOADEnumDas Add-on wird aktualisiert, wenn das Fenster geschlossen wird.

OpenAs

Attribute

PropertyTypBeschreibung
FULL_SIZEEnumIn einem vollständigen Fenster oder Tab öffnen.
OVERLAYEnumSie kann als Overlay, beispielsweise als Pop-up, geöffnet werden.

Methoden

MethodeRückgabetypKurzbeschreibung
setOnClose(onClose)OpenLinkLegt das Verhalten der URL-Aktion beim Schließen des URL-Fensters oder -Tabs fest.
setOpenAs(openAs)OpenLinkLegt das Verhalten der URL beim Öffnen fest.
setUrl(url)OpenLinkLegt die URL fest, die geöffnet werden soll.

PlatformDataSource

Methoden

MethodeRückgabetypKurzbeschreibung
setCommonDataSource(commonDataSource)PlatformDataSourceLegt die Datenquelle aus Google Workspace fest.
setHostAppDataSource(hostAppDataSource)PlatformDataSourceWird zum Ausfüllen von Gruppenbereichen im Mehrfachauswahlmenü verwendet.

ResponseType

Attribute

PropertyTypBeschreibung
TYPE_UNSPECIFIEDEnumStandardtyp, der als NEW_MESSAGE verarbeitet wird.
NEW_MESSAGEEnumPosten Sie eine neue Nachricht im Thema.
UPDATE_MESSAGEEnumAktualisieren Sie die Nachricht 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.
DIALOGEnumÖffnet ein Dialogfeld.
UPDATE_WIDGETEnumAbfrage der Optionen für die automatische Vervollständigung von Widget-Texten.

SelectionInput

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(text, value, selected)SelectionInputFügt ein neues Element hinzu, das ausgewählt werden kann.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputFügt ein neues Element hinzu, das für Mehrfachauswahl-Menüs 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 bei einer UI-Interaktion generiert wird.
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 eingibt, bevor die App die automatische Vervollständigung abfragt, und zeigt vorgeschlagene Elemente auf der Karte an.
setOnChangeAction(action)SelectionInputLegt eine Action fest, die immer dann ausgeführt wird, wenn sich die Auswahleingabe ändert.
setPlatformDataSource(platformDataSource)SelectionInputLegt eine Datenquelle aus Google Workspace fest.
setTitle(title)SelectionInputLegt den Titel fest, der vor dem Eingabefeld angezeigt werden soll.
setType(type)SelectionInputLegt den Typ dieser Eingabe fest.

SelectionInputType

Attribute

PropertyTypBeschreibung
CHECK_BOXEnumEingabestil für Kästchen.
RADIO_BUTTONEnumEingabestil für Optionsfeld.
DROPDOWNEnumEingabestil für Drop-down-Menüauswahl.
SWITCHEnumEine Reihe von Schaltern.
MULTI_SELECTEnum

Status

Attribute

PropertyTypBeschreibung
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 sich das System nicht in einem Zustand befindet, der für die Ausführung des Vorgangs erforderlich ist.
ABORTEDEnumDer Vorgang wurde abgebrochen, in der Regel aufgrund eines Parallelitätsproblems wie einer fehlgeschlagenen Sequencer-Prüfung oder eines Transaktionsabbruchs.
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)SuggestionsTextvorschlag hinzufügen.
addSuggestions(suggestions)SuggestionsFügen Sie eine Liste mit Textvorschlägen hinzu.

SuggestionsResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

SuggestionsResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()SuggestionsResponseErstellt die aktuelle Vorschlagsantwort und validiert sie.
setSuggestions(suggestions)SuggestionsResponseBuilderLegt die Vorschläge fest, die bei der automatischen Vervollständigung in Textfeldern verwendet werden.

Switch

Methoden

MethodeRückgabetypKurzbeschreibung
setControlType(controlType)SwitchLegt den Steuerelementtyp des Schalters fest.
setFieldName(fieldName)SwitchLegt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert. Dieses wird bei einer UI-Interaktion generiert.
setOnChangeAction(action)SwitchLegt die Aktion fest, die ausgeführt werden soll, wenn der Schalter umgelegt wird.
setSelected(selected)SwitchLegt fest, ob dieser Schalter als aktiviert oder nicht ausgewählt beginnen soll.
setValue(value)SwitchLegt den Wert fest, der als Formulareingabe gesendet wird, wenn dieser Schalter aktiviert ist.

SwitchControlType

Attribute

PropertyTypBeschreibung
SWITCHEnumEin-/Aus-Steuerelement für ein Schalter-Widget.
CHECK_BOXEnumSteuerelement als Kästchen für ein Schalter-Widget.

TextButton

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)TextButtonLegt den alternativen Text der Schaltfläche für Barrierefreiheit fest.
setAuthorizationAction(action)TextButtonLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setBackgroundColor(backgroundColor)TextButtonLegt die Hintergrundfarbe für die Schaltfläche "TextButtonStyle.FILLED" fest.
setComposeAction(action, composedEmailType)TextButtonLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setDisabled(disabled)TextButtonLegt fest, ob die Schaltfläche deaktiviert ist.
setOnClickAction(action)TextButtonLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)TextButtonLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)TextButtonLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.
setText(text)TextButtonLegt den Text fest, der auf der Schaltfläche angezeigt wird.
setTextButtonStyle(textButtonStyle)TextButtonLegt den Stil der Schaltfläche fest.

TextButtonStyle

Attribute

PropertyTypBeschreibung
OUTLINEDEnumSchaltfläche mit normalem Text und klarem Hintergrund
FILLEDEnumTextschaltfläche mit farbigem Hintergrund.

TextInput

Methoden

MethodeRückgabetypKurzbeschreibung
setFieldName(fieldName)TextInputLegt den Schlüssel fest, der diese Texteingabe im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird.
setHint(hint)TextInputLegt einen Hinweis für die Texteingabe fest.
setMultiline(multiline)TextInputLegt fest, ob der Eingabetext in einer Zeile oder in mehreren Zeilen angezeigt wird.
setOnChangeAction(action)TextInputLegt eine Aktion fest, die bei jeder Änderung der Texteingabe ausgeführt werden soll.
setSuggestions(suggestions)TextInputLegt die Vorschläge für die automatische Vervollständigung im Textfeld fest.
setSuggestionsAction(suggestionsAction)TextInputLegt die Callback-Aktion zum Abrufen von Vorschlägen auf Basis der Nutzereingaben für die automatische Vervollständigung fest.
setTitle(title)TextInputLegt den Titel fest, der über dem Eingabefeld angezeigt werden soll.
setValue(value)TextInputLegt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.

TextParagraph

Methoden

MethodeRückgabetypKurzbeschreibung
setText(text)TextParagraphLegt den Text des Absatzes fest.

TimePicker

Methoden

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

UniversalActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

UniversalActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()UniversalActionResponseErstellt die aktuelle universelle Aktionsantwort und validiert sie.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderZeigt das Add-on mit den angegebenen Karten an.
setOpenLink(openLink)UniversalActionResponseBuilderLegt fest, dass die URL geöffnet wird, wenn die universelle Aktion ausgewählt wird.

UpdateDraftActionResponse

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.

UpdateDraftActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()UpdateDraftActionResponseErstellt die Antwort auf den aktuellen Updateentwurf und validiert sie.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderLegt eine Aktion fest, durch die die Bcc-Empfänger eines Entwurfs für E-Mails aktualisiert werden.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderLegen Sie eine Aktion fest, mit der der E-Mail-Text eines Entwurfs aktualisiert wird.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderLegt eine Aktion fest, mit der die Cc-Empfänger eines Entwurfs aktualisiert werden.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderLegt eine Aktion fest, mit der die Betreffzeile eines Entwurfs aktualisiert wird.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderLegt eine Aktion fest, mit der die An-Empfänger eines Entwurfs aktualisiert werden.

UpdateDraftBccRecipientsAction

Methoden

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

UpdateDraftBodyAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateContent(content, contentType)UpdateDraftBodyActionFügt den angegebenen Inhalt in den Textentwurf ein.
setUpdateType(updateType)UpdateDraftBodyActionLegt den UpdateDraftBodyType dieser Aktualisierungsaktion für den Entwurfstext fest.

UpdateDraftBodyType

Attribute

PropertyTypBeschreibung
IN_PLACE_INSERTEnumStandard.
INSERT_AT_STARTEnumAktualisierungsaktionen fügen Inhalte am Anfang des Nachrichtentexts ein.
INSERT_AT_ENDEnumAktualisierungsaktionen fügen Inhalte am Ende des Nachrichtentexts ein.

UpdateDraftCcRecipientsAction

Methoden

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

UpdateDraftSubjectAction

Methoden

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

UpdateDraftToRecipientsAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionDamit werden die „An“-Empfänger eines E-Mail-Entwurfs aktualisiert.

UpdatedWidget

Methoden

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

VerticalAlignment

Attribute

PropertyTypBeschreibung
CENTEREnumDer Inhalt wird vertikal in der Mitte des Containers platziert.
TOPEnumDer Inhalt wird vertikal oben im Container platziert.
BOTTOMEnumDer Inhalt wird vertikal unten im Container platziert.

Widget

WrapStyle

Attribute

PropertyTypBeschreibung
NOWRAPEnumKein Zeilenumbruch.
WRAPEnumFügt dem Inhalt für alle Widgets in einer Spalte einen Text hinzu.