Card Service

Kartenservice

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 daher für beide Seiten keine separaten UIs entwickeln.

Klassen

NameKurzbeschreibung
ActionEine Aktion, die Interaktivität in UI-Elementen ermöglicht.
ActionResponseDas Antwortobjekt, das von einer Callback-Funktion (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.
AttachmentStellt einen Anhang dar, der von einem Add-on erstellt wurde.
AuthorizationActionEine Autorisierungsaktion, durch die der Nutzer nach einem Klick auf die AuthorizationUrl weitergeleitet wird.
AuthorizationExceptionEin Fehler, der zurückgegeben werden kann, um eine Autorisierungskarte für den Nutzer auszulösen.
BorderStyleEine Klasse, die einen vollständigen Rahmenstil darstellt und 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.
CalendarEventActionResponseEine Antwort, die Änderungen am Kalendertermin vornimmt, die der Nutzer derzeit als Reaktion auf eine in der UI ausgeführte Aktion ausführt, z. B. ein Klick auf eine Schaltfläche
CalendarEventActionResponseBuilderEin Builder für CalendarEventActionResponse-Objekte.
CardEine Kontextkarte, die eine einzelne Ansicht in der UI darstellt.
CardActionEin anklickbarer Menüpunkt, der dem Menü der Kartenüberschrift hinzugefügt wird.
CardBuilderEin Builder für Card-Objekte.
CardHeaderDie Kopfzeile eines Card.
CardSectionEin Kartenabschnitt enthält Gruppen von Widgets und ermöglicht die visuelle Trennung.
CardServiceCardService bietet die Möglichkeit, allgemeine Karten zu erstellen, die für verschiedene Erweiterbarkeitsprodukte von Google verwendet werden, z. B. Google Workspace-Add-ons.
ComposeActionResponseDas Antwortobjekt, das von einer Callback-Methode zum Schreiben einer Aktion in einem Gmail-Add-on zurückgegeben werden kann.
ComposeActionResponseBuilderEin Builder für ComposeActionResponse-Objekte.
ComposedEmailTypeEin Enum-Wert, der angibt, ob es sich bei der erstellten E-Mail um eine eigenständige E-Mail oder einen Antwortentwurf handelt.
ContentTypeEin Enum-Wert, der den Inhaltstyp des von einem UpdateDraftActionResponse generierten Inhalts angibt.
DatePickerEin Eingabefeld, in dem ein Datum eingegeben werden kann.
DateTimePickerEin Eingabefeld, in dem Nutzer ein Datum und eine Uhrzeit eingeben können.
DecoratedTextEin Widget, das Text mit optionalen Verzierungen anzeigt.
DisplayStyleEin Enum, das 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 in der UI ausgeführte Aktion, z. B. ein Klick auf eine Schaltfläche
DriveItemsSelectedActionResponseBuilderEin Builder für DriveItemsSelectedActionResponse-Objekte.
EditorFileScopeActionResponseNimmt Änderungen an einem Editor wie Google Docs, Google Tabellen oder Google Präsentationen als Reaktion auf eine in der Benutzeroberfläche ausgeführte Aktion vor.
EditorFileScopeActionResponseBuilderEin Builder für EditorFileScopeActionResponse-Objekte.
FixedFooterDie feste Fußzeile, die unten in einem Add-on Card angezeigt wird.
GridEin organisiertes Raster zur Anzeige mehrerer Rasterelemente
GridItemDie Elemente, mit denen Nutzer in einem Raster-Widget interagieren.
GridItemLayoutEin Enum, das das Bild und den Textstil eines GridItem definiert.
HorizontalAlignmentEin Enum-Wert, der die horizontale Ausrichtung eines Widgets angibt.
IconVordefinierte Symbole, die in verschiedenen UI-Objekten wie ImageButton- oder DecoratedText-Widgets verwendet werden können.
IconImageEin vordefiniertes Symbol oder ein Symbol aus einer URL mit einem anpassbaren Zuschneidestil.
ImageEin Widget, das ein einzelnes Bild zeigt.
ImageButtonEin ImageButton mit einem Bild.
ImageComponentEine Bildkomponente, die Rasterelementen hinzugefügt werden kann.
ImageCropStyleEine Klasse, die einen Zuschneidestil darstellt, der auf Bildkomponenten angewendet werden kann.
ImageCropTypeEin Enum-Wert, der die auf Bildkomponenten angewendeten Zuschnittsstile darstellt.
ImageStyleEin Enum-Wert, der den Stil des Zuschneidens eines Bildes definiert.
KeyValueDieser Kurs wurde eingestellt.
LoadIndicatorEin Enum-Typ, der den Typ der Lade- oder Fortschrittsanzeige angibt, der angezeigt wird, während ein Action verarbeitet wird.
NavigationEin Hilfsobjekt, das die Kartennavigation steuert
NotificationEine Benachrichtigung, die dem Nutzer als Antwort auf die Interaktion mit einem UI-Element angezeigt wird.
OnCloseEin Enum-Wert, der angibt, was zu tun ist, wenn eine URL durch eine OpenLink geöffnet wird.
OpenAsEin Enum-Wert, der angibt, wie eine URL geöffnet wird.
OpenLinkAktion zum Öffnen eines Links mit einigen Optionen
SelectionInputEin Eingabefeld, in dem Sie aus vordefinierten Optionen auswählen können.
SelectionInputTypeTyp der Auswahleingabe.
SuggestionsAutocomplete-Vorschläge, um ein TextInput-Widget zu 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 das Aktivieren oder Deaktivieren unterstützt.
SwitchControlTypeTyp eines Widget-Steuerelements Switch.
TextButtonEin TextButton mit einem Textlabel.
TextButtonStyleEine Aufzählung, die 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 dem Nutzer eine Zeit 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.
UpdateDraftActionResponseEine Aktion, die den E-Mail-Entwurf aktualisiert, den der Nutzer gerade bearbeitet.
UpdateDraftActionResponseBuilderEin Builder für UpdateDraftActionResponse-Objekte.
UpdateDraftBccRecipientsActionAktualisiert die Bcc-Empfänger eines E-Mail-Entwurfs.
UpdateDraftBodyActionAktualisiert den E-Mail-Entwurf
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 An-Empfänger eines E-Mail-Entwurfs.
WidgetBasisklasse für alle Widgets, die einem Card hinzugefügt werden können.

Action

Methoden

MethodeRückgabetypKurzbeschreibung
setFunctionName(functionName)ActionLegt den Namen der aufzurufenden Callback-Funktion fest.
setLoadIndicator(loadIndicator)ActionLegt die Ladeanzeige fest, die angezeigt wird, während die Aktion ausgeführt wird.
setParameters(parameters)ActionBenutzerdefinierte Parameter können an die Callback-Funktion übergeben werden.

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 ist.
setOpenLink(openLink)ActionResponseBuilderLegt die URL fest, zu der navigiert werden soll, wenn die Aktion aktiviert ist.
setStateChanged(stateChanged)ActionResponseBuilderLegt ein Flag fest, um anzugeben, dass diese Aktion den vorhandenen Datenstatus geändert hat.

Attachment

Methoden

MethodeRückgabetypKurzbeschreibung
setIconUrl(iconUrl)AttachmentLegt die URL des Symbols 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 Nutzer über die Autorisierungsaufforderung weitergeleitet werden.

AuthorizationException

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setAuthorizationUrl(authUrl)AuthorizationExceptionLegt die Autorisierungs-URL fest, zu der Nutzer über die Autorisierungsaufforderung weitergeleitet werden.
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 Autorisierung angezeigt wird.
throwException()voidLöst die Ausnahme aus.

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 Rahmentyp fest.

BorderType

Attribute

PropertyTypBeschreibung
NO_BORDEREnumKein Rahmenstil.
STROKEEnumRahmenlinienstil mit Strichen

Button

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)ButtonLegt eine Autorisierungsaktion fest, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setComposeAction(action, composedEmailType)ButtonLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, 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, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ButtonLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.

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 zum Kalendertermin hinzufügen soll, wenn die zugehörige UI-Aktion ausgeführt wird.
addAttendees(emails)CalendarEventActionResponseBuilderGibt an, dass die Antwort die angegebenen Teilnehmer zum Kalendertermin hinzufügen soll, wenn die zugehörige UI-Aktion ausgeführt wird.
build()CalendarEventActionResponseErstellt die aktuelle Aktionsaktion für Kalendertermine 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, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setComposeAction(action, composedEmailType)CardActionLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, 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, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)CardActionLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.
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 Anzeigestil 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 die Kopfzeile der Vorschaukarte fest.

CardHeader

Methoden

MethodeRückgabetypKurzbeschreibung
setImageAltText(imageAltText)CardHeaderLegt den alternativen Text für das Kopfzeilenbild fest.
setImageStyle(imageStyle)CardHeaderLegt fest, dass das Symbol in der Kopfzeile der Karte zugeschnitten wird.
setImageUrl(imageUrl)CardHeaderLegt das Bild für den Header fest, indem Sie die zugehörige URL oder den Datenstring angeben.
setSubtitle(subtitle)CardHeaderLegt den Untertitel des Kartenheaders fest.
setTitle(title)CardHeaderLegt den Titel der Kopfzeile der Karte 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 angezeigt werden, wenn dieser Bereich minimiert ist.

CardService

Attribute

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

Methoden

MethodeRückgabetypKurzbeschreibung
newAction()ActionErstellt einen neuen Action
newActionResponseBuilder()ActionResponseBuilderErstellt einen neuen ActionResponseBuilder
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
newComposeActionResponseBuilder()ComposeActionResponseBuilderErstellt einen neuen ComposeActionResponseBuilder
newDatePicker()DatePickerErstellt einen neuen DatePicker
newDateTimePicker()DateTimePickerErstellt einen neuen DateTimePicker
newDecoratedText()DecoratedTextErstellt einen neuen DecoratedText
newDivider()DividerErstellt einen neuen Divider
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderErstellt einen neuen DriveItemsSelectedActionResponseBuilder
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderErstellt einen neuen EditorFileScopeActionResponseBuilder
newFixedFooter()FixedFooterErstellt einen neuen FixedFooter
newGrid()GridErstellt einen neuen Grid
newGridItem()GridItemErstellt einen neuen GridItem
newIconImage()IconImageErstellt einen neuen IconImage
newImage()ImageErstellt einen neuen Image
newImageButton()ImageButtonErstellt einen neuen ImageButton
newImageComponent()ImageComponentErstellt einen neuen ImageComponent
newImageCropStyle()ImageCropStyleErstellt einen neuen ImageCropStyle
newKeyValue()KeyValueErstellt einen neuen KeyValue
newNavigation()NavigationErstellt einen neuen Navigation
newNotification()NotificationErstellt einen neuen Notification
newOpenLink()OpenLinkErstellt einen neuen OpenLink
newSelectionInput()SelectionInputErstellt einen neuen SelectionInput
newSuggestions()SuggestionsErstellt einen neuen Suggestions
newSuggestionsResponseBuilder()SuggestionsResponseBuilderErstellt einen neuen SuggestionsResponseBuilder
newSwitch()SwitchErstellt einen neuen Switch
newTextButton()TextButtonErstellt einen neuen TextButton
newTextInput()TextInputErstellt einen neuen TextInput
newTextParagraph()TextParagraphErstellt einen neuen TextParagraph
newTimePicker()TimePickerErstellt einen neuen TimePicker
newUniversalActionResponseBuilder()UniversalActionResponseBuilderErstellt einen neuen UniversalActionResponseBuilder
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderErstellt einen neuen UpdateDraftActionResponseBuilder
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionErstellt eine neue UpdateDraftBccRecipientsAction.
newUpdateDraftBodyAction()UpdateDraftBodyActionErstellt einen neuen UpdateDraftBodyAction
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionErstellt einen neuen UpdateDraftCcRecipientsAction
newUpdateDraftSubjectAction()UpdateDraftSubjectActionErstellt einen neuen UpdateDraftSubjectAction
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionErstellt einen neuen UpdateDraftToRecipientsAction

ComposeActionResponse

Methoden

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

ComposeActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()ComposeActionResponseErstellt die aktuelle Antwortaktion zum Schreiben und validiert sie.
setGmailDraft(draft)ComposeActionResponseBuilderLegt den GmailMessage-Entwurf 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, der eine eigenständige Nachricht darstellt.

ContentType

Attribute

PropertyTypBeschreibung
TEXTEnumGibt an, dass der generierte Inhalt im Nur-Text-Format vorliegt.
MUTABLE_HTMLEnumGibt an, dass der generierte Inhalt als HTML formatiert ist.
IMMUTABLE_HTMLEnumGibt an, dass der generierte Inhalt als HTML formatiert ist. Er kann jedoch nicht mehr bearbeitet werden.

DatePicker

Methoden

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

DisplayStyle

Attribute

PropertyTypBeschreibung
PEEKEnumDie Kartenüberschrift wird im unteren Bereich von Add-on-Inhalten gegenüber vorhandenen Inhalten eingeblendet.
REPLACEEnumErscheinen Sie die Karte durch Ersetzen der vorhandenen Inhalte.

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 der Umfang der Antwort für das kontextrelevante Element in Google Drive angefordert wird.

EditorFileScopeActionResponse

Methoden

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

EditorFileScopeActionResponseBuilder

Methoden

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

FixedFooter

Methoden

MethodeRückgabetypKurzbeschreibung
setPrimaryButton(button)FixedFooterLegen Sie die primäre Schaltflä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, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setBorderStyle(borderStyle)GridLegt den Rahmenstil fest, der auf jedes Rasterelement angewendet wird.
setComposeAction(action, composedEmailType)GridLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, 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, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)GridLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.
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 Bildern 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.
CENTEREnumRichte das Widget in der Mitte aus.
ENDEnumRichte das Widget am Ende der Satzseite aus.

Icon

Attribute

PropertyTypBeschreibung
NONEEnumKein Symbol.
AIRPLANEEnumFlugsymbol
BOOKMARKEnumLesezeichensymbol
BUSEnumBussymbol
CAREnumAutosymbol
CLOCKEnumSymbol "Uhr"
CONFIRMATION_NUMBER_ICONEnumSymbol für die Bestätigungsnummer
DOLLAREnumDollarsymbol
DESCRIPTIONEnumBeschreibungssymbol
EMAILEnumE-Mail-Symbol
EVENT_PERFORMEREnumE-Mail-Symbol
EVENT_SEATEnumSymbol für den Platz
FLIGHT_ARRIVALEnumSymbol für Flugankunft
FLIGHT_DEPARTUREEnumAbflugsymbol
HOTELEnumHotelsymbol
HOTEL_ROOM_TYPEEnumHotelsymbol
INVITEEnumSymbol „Einladen“
MAP_PINEnumSymbol für Markierung auf der Karte
MEMBERSHIPEnumSymbol: Mitgliedschaft
MULTIPLE_PEOPLEEnumSymbol für mehrere Personen
OFFEREnumSymbol: Angebot
PERSONEnumPersonensymbol
PHONEEnumTelefonsymbol
RESTAURANT_ICONEnumRestaurantsymbol
SHOPPING_CARTEnumEinkaufswagensymbol
STAREnumSternsymbol
STOREEnumHändlersymbol
TICKETEnumTicketsymbol
TRAINEnumZugsymbol
VIDEO_CAMERAEnumSymbol „Videokamera“
VIDEO_PLAYEnumVideowiedergabesymbol

IconImage

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)IconImageLegt den alternativen Text der URL fest, der für Bedienungshilfen 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 Zuschneidestil 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, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setComposeAction(action, composedEmailType)ImageLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, wenn auf das Objekt geklickt wird.
setImageUrl(url)ImageLegt das zu verwendende Bild fest, indem Sie die URL oder den Datenstring angeben.
setOnClickAction(action)ImageLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ImageLegt eine Aktion fest, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ImageLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.

ImageButton

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageButtonLegt den alternativen Text der Schaltfläche für Bedienungshilfen fest.
setAuthorizationAction(action)ImageButtonLegt eine Autorisierungsaktion fest, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setComposeAction(action, composedEmailType)ImageButtonLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, wenn auf das Objekt geklickt wird.
setIcon(icon)ImageButtonLegt eine vordefinierte Icon fest, die auf der Schaltfläche angezeigt werden soll.
setIconUrl(url)ImageButtonLegt die URL eines Bilds 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, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ImageButtonLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.

ImageComponent

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageComponentLegt den alternativen Text des Bildes fest.
setBorderStyle(borderStyle)ImageComponentLegt den Rahmenstil für das Bild fest.
setCropStyle(imageCropStyle)ImageComponentLegt den Zuschneidestil 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 Zuschneidetyp RECTANGLE_CUSTOM ist.
setImageCropType(type)ImageCropStyleLegt den Zuschneidetyp für das Bild fest.

ImageCropType

Attribute

PropertyTypBeschreibung
SQUAREEnumZuschneidestil im quadratischen Format
CIRCLEEnumZuschneidestil für kreisförmige Form
RECTANGLE_CUSTOMEnumZuschneidestil mit rechteckigen Formen und benutzerdefiniertem Seitenverhältnis.
RECTANGLE_4_3EnumZuschneidestil mit rechteckigen Formen und einem Seitenverhältnis von 4:3.

ImageStyle

Attribute

PropertyTypBeschreibung
SQUAREEnumKein Zuschneiden.
CIRCLEEnumAuf eine kreisförmige Form zuschneiden.

KeyValue

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)KeyValueLegt eine Autorisierungsaktion fest, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setComposeAction(action, composedEmailType)KeyValueLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, 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, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)KeyValueLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.

LoadIndicator

Attribute

PropertyTypBeschreibung
SPINNEREnumRotierendes Ladesymbol verwenden.
NONEEnumVerwenden Sie keinen Indikator.

Methoden

MethodeRückgabetypKurzbeschreibung
popCard()NavigationRuft eine Karte aus dem Navigationsbereich auf.
popToNamedCard(cardName)NavigationDie Karten werden anhand des Kartennamens aufgerufen.
popToRoot()NavigationVerschiebt das Kartenstapel zur Stammkarte.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
pushCard(card)NavigationDie angegebene Karte wird auf den Stapel verschoben.
updateCard(card)NavigationDie aktuelle Karte wird ersetzt.

Notification

Methoden

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

OnClose

Attribute

PropertyTypBeschreibung
NOTHINGEnumTun Sie nichts.
RELOADEnumDas Add-on wird neu geladen, wenn das Fenster geschlossen wird.

OpenAs

Attribute

PropertyTypBeschreibung
FULL_SIZEEnumIn einem vollständigen Fenster oder Tab öffnen.
OVERLAYEnumAls Overlay öffnen, beispielsweise als Pop-up

Methoden

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

SelectionInput

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(text, value, selected)SelectionInputFügt ein neues Element hinzu, das ausgewählt werden kann.
setFieldName(fieldName)SelectionInputLegt den Schlüssel fest, der diese Auswahleingabe im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion auftritt.
setOnChangeAction(action)SelectionInputLegt ein Action fest, das immer dann ausgeführt werden soll, wenn sich die Auswahleingabe ändert.
setTitle(title)SelectionInputLegt fest, dass der Titel vor dem Eingabefeld angezeigt wird.
setType(type)SelectionInputLegt den Typ dieser Eingabe fest.

SelectionInputType

Attribute

PropertyTypBeschreibung
CHECK_BOXEnumEingabestil für das Kästchen.
RADIO_BUTTONEnumStil des Radio- Buton-Eingabemodus.
DROPDOWNEnumEingabestil für die Drop-down-Menüauswahl.

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 Antwort auf Vorschläge und validiert sie.
setSuggestions(suggestions)SuggestionsResponseBuilderLegt die Vorschläge fest, die automatisch in Textfeldern verwendet werden.

Switch

Methoden

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

SwitchControlType

Attribute

PropertyTypBeschreibung
SWITCHEnumSteuerelement mit Stil für ein Schalter-Widget.
CHECK_BOXEnumSteuerelement-ähnliches Steuerelement für ein Schalter-Widget.

TextButton

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)TextButtonLegt den alternativen Text der Schaltfläche für Bedienungshilfen fest.
setAuthorizationAction(action)TextButtonLegt eine Autorisierungsaktion fest, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setBackgroundColor(backgroundColor)TextButtonLegt die Hintergrundfarbe der Schaltfläche TextButtonStyle.FILLED fest.
setComposeAction(action, composedEmailType)TextButtonLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, 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, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)TextButtonLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.
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
TEXTEnumSchaltfläche für normalen Text mit 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 generiert wird, wenn eine UI-Interaktion auftritt.
setHint(hint)TextInputLegt einen Hinweis für die Texteingabe fest.
setMultiline(multiline)TextInputGibt an, ob der Eingabetext in einer oder 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 fest, mit der Vorschläge auf Grundlage der Nutzereingabe für die automatische Vervollständigung abgerufen werden.
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 generiert wird, wenn eine UI-Interaktion auftritt.
setHours(hours)TimePickerLegt den Wert für die vorausgefüllten Stunden fest, die im Eingabefeld festgelegt werden sollen.
setMinutes(minutes)TimePickerLegt den Wert für die im Voraus ausgefüllten Minuten fest, der im Eingabefeld festgelegt werden soll.
setOnChangeAction(action)TimePickerLegt ein Action fest, das das Skript immer dann ausführt, wenn sich die Auswahl der Auswahl ä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)UniversalActionResponseBuilderDas Add-on mit den angegebenen Karten wird angezeigt.
setOpenLink(openLink)UniversalActionResponseBuilderLegt fest, dass die URL geöffnet wird, wenn die universelle Aktion ausgewählt ist.

UpdateDraftActionResponse

Methoden

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

UpdateDraftActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()UpdateDraftActionResponseErstellt die aktuelle Update-Entwurfs-Aktionsantwort und validiert sie.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderLegt eine Aktion fest, mit der die Bcc-Empfänger von E-Mails eines Entwurfs 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 Empfänger an einen Entwurf aktualisiert werden.

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 Entwurfstext den angegebenen Inhalt hinzu.
setUpdateType(updateType)UpdateDraftBodyActionLegt den UpdateDraftBodyType dieser Aktualisierungsaktion für den Entwurfstext fest.

UpdateDraftBodyType

Attribute

PropertyTypBeschreibung
IN_PLACE_INSERTEnumStandard:
INSERT_AT_STARTEnumBei Updateaktionen werden Inhalte am Anfang des Nachrichtentexts eingefügt.
INSERT_AT_ENDEnumBei Updateaktionen werden die Inhalte 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 An-Empfänger eines E-Mail-Entwurfs.

Widget