AddOns Response Service

Add-on-Antwortdienst

Mit diesem Dienst können Skripts Google Workspace-Add-ons konfigurieren und erstellen.

Klassen

NameKurzbeschreibung
AccessoryWidget
ActionEine Aktion, mit der Google Workspace-Add-ons, die Google Workspace Studio erweitern, eine neue Karte rendern können.
ActionResponse
ActionResponseBuilder
AddOnsResponseServiceMit AddOnsResponseService können Antworten für Google Workspace-Add-ons erstellt werden.
AddonComposeUiActionResponse
AddonComposeUiActionResponseBuilder
AddonComposeUiActionType
Attachment
BasicDataTypeEin Enum, das die grundlegenden generischen Datentypen darstellt.
CalendarEventActionResponse
CalendarEventActionResponseBuilder
ChatDataActionsResponseBuilder
ChatMessage
ColorEin Color-Objekt, das eine Farbe im RGBA-Farbraum darstellt.
ComposeActionResponse
ComposeActionResponseBuilder
ComposedEmailType
ContentType
CreateMessageAction
DataActionsResponse
DataTypeMit einem DataType wird der Typ einer Variablen festgelegt.
DriveItemsSelectedActionResponse
DriveItemsSelectedActionResponseBuilder
DynamicResourceDefinitionEine DynamicResourceDefinition ist ein Baustein für eine ResourceFieldsDefinitionRetrievedAction. Sie kann eine oder mehrere Zahlen von ResourceField enthalten, um die Anzahl der Ausgabevariablen, die von einem Schritt in Google Workspace Studio bereitgestellt werden, dynamisch zu definieren.
EditorFileScopeActionResponse
EditorFileScopeActionResponseBuilder
EndNavigation
ErrorActionabilityEin Enum-Wert, der die Behebbarkeit des Fehlers darstellt.
ErrorRetryabilityEin Enum, das die Wiederholbarkeit des Aktionsaufrufs bei einem Fehler darstellt.
FontWeightEin Enum-Wert, der die Schriftstärke des formatierten Texts darstellt.
HostAppActionEine HostAppAction ist eine Art von Aktion, die von einzelnen Host-Apps verarbeitet wird.
HyperlinkEin Hyperlink-Element, das in TextFormatElement verwendet wird.
InsertSectionEin Builder für InsertSection-Objekte.
InsertWidgetEin Builder für InsertWidget-Objekte.
LinkDas Linkobjekt aus einer Drittanbieterressource, das in der Hostanwendung in einen Smartchip konvertiert wird.
LinkPreview
ListContainerContainer für Listenelemente, wobei jedes Listenelement mehrere TextFormatElement enthalten kann.
ListItemEin Listenelement, das mehrere TextFormatElement enthalten kann.
ListTypeEin Enum-Wert, der den Typ der Liste darstellt.
ModifyCardEin Builder für ModifyCard-Objekte, mit dem die Benutzeroberfläche einer vorhandenen Karte geändert und aktualisiert wird, indem das ModifyCard-Objekt an ein Action übergeben wird.
NavigationEin Hilfsobjekt, das die Kartennavigation steuert.
Notification
OnClose
OpenAs
OpenLink
RemoveSectionEin Builder für RemoveSection-Objekte.
RemoveWidgetEin Builder für RemoveWidget-Objekte.
RenderActionRendert oder aktualisiert eine Karte durch Ausführen eines Action als Reaktion auf eine Nutzerinteraktion.
RenderActionBuilderEin Builder für RenderAction-Objekte.
ResourceDataStellt anwendungsspezifische Ressourcendaten dar. Ressourcendaten enthalten eine Sammlung von Schlüssel-Wert-Paaren mit Variablennamen und VariableData.
ResourceFieldEin ResourceField ist ein grundlegender Baustein eines DynamicResourceDefinition. Jedes Ressourcenfeld entspricht einer Ausgabevariablen des aktuellen Schritts.
ResourceFieldsDefinitionRetrievedActionEin ResourceFieldsDefinitionRetrievedAction ist ein Typ von ResourceFieldsDefinitionRetrievedAction, der verwendet wird, um die Definition einer Liste von Ressourcenfeldern über die im Manifest angegebene Funktion dynamicResourceDefinitionProvider abzurufen.
ResourceRetrievedActionMit einer ResourceRetrievedAction wird bei Bedarf benutzerdefinierter Ressourceninhalt abgerufen. Das Feld für die benutzerdefinierte Ressource wird in den ResourceData definiert.
ResourceTypeEin anwendungsspezifischer Ressourcentyp. Die eindeutige Kennung des Ressourcentyps sollte eine entsprechende WorkflowResourceDefinition haben.
ReturnElementErrorActionEin ReturnElementErrorAction gibt an, dass beim Aufrufen des Elements ein Fehler aufgetreten ist.
ReturnOutputVariablesActionEnthält Ausgabevariablen, die von der ausgeführten Aktion in Google Workspace Studio generiert wurden.
SaveWorkflowActionDiese Aktion gibt an, dass die Host-App (Google Workspace Studio) den Agent speichern soll.
SendStatus
StyledTextTextelement mit Formatierungen wie fett, kursiv und Farbe.
TextFormatChipEin anklickbarer Chip im Textformat.
TextFormatElementEin Textformatelement, das TextFormatChip, StyledText, Hyperlink oder ListContainer sein kann.
TextFormatIconEin Symbol, das in einem TextFormatChip angezeigt wird.
TextStyleEin Enum-Wert, der den Stil des formatierten Texts darstellt.
TimeStampStellt ein Zeitstempelobjekt dar, das einer VariableData hinzugefügt werden kann.
UniversalActionResponse
UniversalActionResponseBuilder
UpdateDraftActionResponse
UpdateDraftActionResponseBuilder
UpdateDraftBccRecipientsAction
UpdateDraftBodyAction
UpdateDraftBodyType
UpdateDraftCcRecipientsAction
UpdateDraftSubjectAction
UpdateDraftToRecipientsAction
UpdateInlinePreviewAction
UpdateMessageAction
UpdateWidgetEin Builder für UpdateWidget-Objekte.
ValidationErrorSeverityEin Enum-Wert, der den Schweregrad des Validierungsfehlers darstellt.
ValueMetadataEin „valueMetadata“-Objekt enthält Informationen zu den möglichen Werten einer Variablen.
VariableDataStellt variable Daten dar, die eine Sammlung von Werten verschiedener Typen enthalten können.
WorkflowActionEine WorkflowAction ist ein Typ von HostAppAction, der verwendet wird, um eine bestimmte Aktion in Google Workspace Studio auszuführen.
WorkflowTextFormatEin Textblock mit Rich-Text-Formatierungsoptionen wie Stilen, Hyperlinks und interaktiven Elementen, die in TextFormatElement definiert sind.
WorkflowValidationErrorActionDiese Aktion weist darauf hin, dass in der Host-App (Google Workspace Studio) ein Validierungsfehler angezeigt werden sollte.

AccessoryWidget

Methoden

MethodeRückgabetypKurzbeschreibung
addWidget(widget)AccessoryWidgetLegt das Widget für diese Aktion fest.

Action

Methoden

MethodeRückgabetypKurzbeschreibung
addModifyCard(modifyCard)ActionFügt der Aktion einen ModifyCard-Vorgang hinzu.
addNavigation(navigation)ActionFügt der Aktion eine Kartennavigation hinzu.

ActionResponse

Methoden

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

ActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addModifyCard(modifyCard)ActionResponseBuilderLegt den Vorgang zum Ändern der Karte für die Aktion fest.
build()ActionResponseErstellt die aktuelle Aktionsantwort und validiert sie.
setLinkPreview(linkPreview)ActionResponseBuilderLegt die Linkvorschau für die Aktion fest.
setNavigation(navigation)ActionResponseBuilderLegt die Antwort auf eine Navigation-Aktion fest.
setNotification(notification)ActionResponseBuilderLegt fest, welche Benachrichtigung angezeigt werden soll, wenn die Aktion aktiviert wird.
setOpenLink(openLink)ActionResponseBuilderLegt die URL fest, zu der navigiert werden soll, wenn die Aktion aktiviert wird.
setStateChanged(stateChanged)ActionResponseBuilderLegt ein Flag fest, um anzugeben, dass durch diese Aktion der vorhandene Datenstatus geändert wurde.

AddOnsResponseService

Attribute

AttributTypBeschreibung
AddonComposeUiActionTypeAddonComposeUiActionTypeDie Aufzählung AddonComposeUiActionType.
ComposedEmailTypeComposedEmailTypeDie Aufzählung ComposedEmailType.
ContentTypeContentTypeDie Aufzählung ContentType.
EndNavigationEndNavigationDie Aufzählung EndNavigation.
OnCloseOnCloseDie Aufzählung OnClose.
OpenAsOpenAsDie Aufzählung OpenAs.
SendStatusSendStatusDie Aufzählung SendStatus.
UpdateDraftBodyTypeUpdateDraftBodyTypeDie Aufzählung UpdateDraftBodyType.

Methoden

MethodeRückgabetypKurzbeschreibung
newAccessoryWidget()AccessoryWidgetErstellt einen neuen AccessoryWidget
newAction()ActionErstellt einen neuen Action
newActionResponseBuilder()ActionResponseBuilderErstellt ein ActionResponseBuilder.
newAddonComposeUiActionResponseBuilder()AddonComposeUiActionResponseBuilderErstellt ein AddonComposeUiActionResponseBuilder.
newAttachment()AttachmentErstellt ein Attachment.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderErstellt ein CalendarEventActionResponseBuilder.
newChatDataActionBuilder()ChatDataActionsResponseBuilderErstellt ein ChatDataActionsResponseBuilder.
newChatMessage()ChatMessageErstellt ein ChatMessage.
newComposeActionResponseBuilder()ComposeActionResponseBuilderErstellt ein ComposeActionResponseBuilder.
newCreateMessageAction()CreateMessageActionErstellt ein CreateMessageAction.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderErstellt ein DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderErstellt ein EditorFileScopeActionResponseBuilder.
newLinkPreview()LinkPreviewErstellt ein LinkPreview.
newNavigation()NavigationErstellt ein Navigation.
newNotification()NotificationErstellt ein Notification.
newOpenLink()OpenLinkErstellt ein OpenLink.
newRenderActionBuilder()RenderActionBuilderErstellt einen neuen RenderActionBuilder
newUniversalActionResponseBuilder()UniversalActionResponseBuilderErstellt ein UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderErstellt ein UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionErstellt ein UpdateDraftBccRecipientsAction.
newUpdateDraftBodyAction()UpdateDraftBodyActionErstellt ein UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionErstellt ein UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionErstellt ein UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionErstellt ein UpdateDraftToRecipientsAction.
newUpdateInlinePreviewAction()UpdateInlinePreviewActionErstellt ein UpdateInlinePreviewAction.
newUpdateMessageAction()UpdateMessageActionErstellt ein UpdateMessageAction.

AddonComposeUiActionResponse

Methoden

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

AddonComposeUiActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()AddonComposeUiActionResponseErstellt die aktuelle Add-on-Compose-UI-Aktionsantwort und validiert sie.
setType(type)AddonComposeUiActionResponseBuilderLegt das Enum-Feld fest, das die Compose-UI-Aktion des Add-ons bestimmt.

AddonComposeUiActionType

Attribute

AttributTypBeschreibung
DISMISSEnumStandard.

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.

BasicDataType

Attribute

AttributTypBeschreibung
BASIC_TYPE_UNSPECIFIEDEnumStandardwert.
STRINGEnumEine Zeichenfolge.
INTEGEREnumEin Ganzzahlwert.
FLOATEnumEine Gleitkommazahl
TIMESTAMPEnumEin Zeitstempel im ISO 8601-Format.
BOOLEANEnumEin boolescher Wert.
EMAIL_ADDRESSEnumEin String im Format einer E-Mail-Adresse.
GOOGLE_USEREnumEin Nutzer der Google-Dienste im Format „users/encoded_GAIA_ID“
FILEEnumEin Dateityp.
FORMATTED_TEXTEnumEin Text mit Rich-Text-Formatierung.

CalendarEventActionResponse

Methoden

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

CalendarEventActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addAttachments(attachments)CalendarEventActionResponseBuilderGibt an, dass der Antwort die Anhänge zum Kalendertermin hinzugefügt werden sollen, wenn die zugehörige UI-Aktion ausgeführt wird.
addAttendees(emails)CalendarEventActionResponseBuilderGibt an, dass der Antwort die angegebenen Teilnehmer dem Kalendertermin hinzugefügt werden sollen, wenn die zugehörige UI-Aktion ausgeführt wird.
build()CalendarEventActionResponseErstellt die aktuelle Antwort auf die Aktion für Kalendertermine 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.

ChatDataActionsResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()DataActionsResponseErstellt die aktuelle Aktionsantwort.
setCreateChatMessageAction(createMessageAction)ChatDataActionsResponseBuilderLegt die CreateMessageAction für diese DataActionsResponse fest.
setUpdateChatMessageAction(updateMessageAction)ChatDataActionsResponseBuilderLegt die UpdateMessageAction für diese DataActionsResponse fest.
setUpdateInlinePreviewAction(updateInlinePreviewAction)ChatDataActionsResponseBuilderLegt die UpdateInlinePreviewAction für diese DataActionsResponse fest.

ChatMessage

Methoden

MethodeRückgabetypKurzbeschreibung
addCardWithId(cardWithId)ChatMessageLegt die Karte der Nachricht fest.
setText(text)ChatMessageLegt den Text der Nachricht fest.

Color

Methoden

MethodeRückgabetypKurzbeschreibung
setAlpha(alpha)ColorLegt die Alphakomponente der Farbe fest.
setBlue(blue)ColorLegt die blaue Komponente der Farbe fest.
setGreen(green)ColorLegt die grüne Komponente der Farbe fest.
setRed(red)ColorLegt die rote Komponente der Farbe fest.

ComposeActionResponse

Methoden

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

ComposeActionResponseBuilder

Methoden

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

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 die generierten Inhalte als HTML formatiert sind.
IMMUTABLE_HTMLEnumGibt an, dass der generierte Inhalt als HTML formatiert ist, aber nach der Generierung nicht bearbeitet werden kann.

CreateMessageAction

Methoden

MethodeRückgabetypKurzbeschreibung
setMessage(message)CreateMessageActionLegt die Meldung für diese Aktion fest.

DataActionsResponse

Methoden

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

DataType

Methoden

MethodeRückgabetypKurzbeschreibung
setBasicDataType(basicDataType)DataTypeLegt den Datentyp auf einen der unterstützten BasicDataType fest.
setResourceType(resourceType)DataTypeLegt den Datentyp auf einen benutzerdefinierten ResourceType fest.
setValueMetadata(valueMetadata)DataTypeLegt die ValueMetadata fest, die typspezifische Informationen zur Variablen enthält.

DriveItemsSelectedActionResponse

Methoden

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

DriveItemsSelectedActionResponseBuilder

Methoden

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

DynamicResourceDefinition

Methoden

MethodeRückgabetypKurzbeschreibung
addResourceField(resourceField)DynamicResourceDefinitionFügt der dynamischen Ressourcendefinition ein Ressourcenfeld hinzu.
setResourceId(resourceId)DynamicResourceDefinitionLegt die ID für die dynamische Ressourcendefinition fest. Diese ID entspricht workflowResourceDefinitionId im Manifest.

EditorFileScopeActionResponse

Methoden

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

EditorFileScopeActionResponseBuilder

Methoden

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

EndNavigation

Attribute

AttributTypBeschreibung
ACTION_UNSPECIFIEDEnumAktion nicht angegeben.
CLOSE_DIALOGEnumSchließt ein Dialogfeld.
CLOSE_DIALOG_AND_EXECUTEEnumSchließt ein Dialogfeld und aktualisiert die Karte, über die das Dialogfeld geöffnet wurde.

ErrorActionability

Attribute

AttributTypBeschreibung
ERROR_ACTIONABILITY_UNSPECIFIEDEnumNicht angegeben
NOT_ACTIONABLEEnumDer Fehler kann vom Nutzer nicht über die Konfigurationskarte behoben werden.
ACTIONABLEEnumDer Fehler kann vom Nutzer über die Konfigurationskarte behoben werden.

ErrorRetryability

Attribute

AttributTypBeschreibung
RETRYABILITY_UNSPECIFIEDEnumNicht angegeben
NOT_RETRYABLEEnumDer Fehler kann nicht wiederholt werden. Der Ablauf wird nach dem ersten Versuch beendet.
RETRYABLEEnumDer Fehler kann wiederholt werden. Der Workflow versucht, den Schritt bis zu fünfmal auszuführen.

FontWeight

Attribute

AttributTypBeschreibung
FONT_WEIGHT_UNSPECIFIEDEnumStandardstärke mit normaler Dicke.
LIGHTEnumGeringeres Gewicht und geringere Dicke.
MEDIUMEnumMittleres Gewicht zwischen „Light“ und „Bold“.
BOLDEnumHöheres Gewicht bei erhöhter Dicke.

HostAppAction

Methoden

MethodeRückgabetypKurzbeschreibung
setWorkflowAction(workflowAction)HostAppActionLegt die Host-App-Aktion auf „Workflow-Aktion“ fest.

Methoden

MethodeRückgabetypKurzbeschreibung
setLink(link)HyperlinkLegt die Ziel-URL des Hyperlinks fest.
setText(text)HyperlinkLegt den Text des Hyperlinks fest.

InsertSection

Methoden

MethodeRückgabetypKurzbeschreibung
insertAtTop(onCardTop)InsertSectionLegt das Flag „onCardTop“ fest, das angibt, ob der neue Bereich oben auf der Karte eingefügt werden soll.
insertBelowSection(sectionId)InsertSectionLegt die Abschnitts-ID fest. Der neue Abschnitt wird darunter eingefügt.
setSection(section)InsertSectionLegt den einzufügenden Kartenabschnitt fest.

InsertWidget

Methoden

MethodeRückgabetypKurzbeschreibung
insertAboveWidget(widgetId)InsertWidgetLegt die Widget-ID fest. Das neue Widget wird über dem Widget mit der angegebenen ID eingefügt.
insertBelowWidget(widgetId)InsertWidgetLegt die Widget-ID fest. Das neue Widget wird unter dem Widget mit der angegebenen ID eingefügt.
setWidget(widget)InsertWidgetLegt die einzufügende Widget fest.

Methoden

MethodeRückgabetypKurzbeschreibung
setTitle(title)LinkLegt den Titel des Links fest.
setUrl(url)LinkLegt die URL des Links fest.

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 Drittanbieterdienst oder einem Dienst, der nicht von Google stammt, angezeigt werden.
setTitle(title)LinkPreviewLegt den Titel fest, der im Smartchip für die Linkvorschau angezeigt wird.

ListContainer

Methoden

MethodeRückgabetypKurzbeschreibung
addListItem(listItem)ListContainerFügt dem Listencontainer ein Listenelement hinzu.
setListNestLevel(listLevel)ListContainerLegt die Ebene der Liste fest. Die oberste Ebene beginnt bei 0 und wird für jede verschachtelte Liste um 1 erhöht.
setListType(listType)ListContainerLegt fest, ob die Liste sortiert oder unsortiert sein soll.

ListItem

Methoden

MethodeRückgabetypKurzbeschreibung
addTextFormatElement(textFormatElement)ListItemFügt dem Listenelement ein TextFormatElement hinzu.

ListType

Attribute

AttributTypBeschreibung
LIST_TYPE_UNSPECIFIEDEnumStandardwert.
ORDEREDEnumSortierte Liste.
UNORDEREDEnumUnsortierte Liste.

ModifyCard

Methoden

MethodeRückgabetypKurzbeschreibung
setInsertSection(insertSection)ModifyCardLegt die InsertSection für dieses Objekt zum Ändern der Karte fest.
setInsertWidget(insertWidget)ModifyCardLegt die InsertWidget für dieses Objekt zum Ändern der Karte fest.
setRemoveSection(removeSection)ModifyCardLegt die RemoveSection für dieses Objekt zum Ändern der Karte fest.
setRemoveWidget(removeWidget)ModifyCardLegt die RemoveWidget für dieses Objekt zum Ändern der Karte fest.
setReplaceSection(replacementSection)ModifyCardLegt den Ersatz-CardSection für dieses Objekt zum Ändern der Karte fest. Der Ersatzabschnitt sollte dieselbe ID wie ein vorhandener Kartenabschnitt haben.
setReplaceWidget(replacementWidget)ModifyCardLegt das Ersatz-Widget für dieses „modify card“-Objekt fest. Das Ersatz-Widget sollte dieselbe ID wie ein vorhandenes Widget haben.
setUpdateWidget(updateWidget)ModifyCardLegt die UpdateWidget für dieses Objekt zum Ändern der Karte fest.

Methoden

MethodeRückgabetypKurzbeschreibung
popCard()Navigation
popToNamedCard(cardName)Navigation
popToRoot()Navigation
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
pushCard(card)NavigationLegt die angegebene Karte auf den Stapel.
setEndNavigation(endNavigation)NavigationLegt die Endnavigationsaktion fest.
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

AttributTypBeschreibung
NOTHINGEnumBeim Schließen nichts unternehmen.
RELOADEnumLädt das Add-on neu, wenn das Fenster geschlossen wird.

OpenAs

Attribute

AttributTypBeschreibung
FULL_SIZEEnumIn einem Vollbildfenster oder ‑tab öffnen.
OVERLAYEnumAls Overlay wie ein Pop‑up-Fenster öffnen

Methoden

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

RemoveSection

Methoden

MethodeRückgabetypKurzbeschreibung
setSectionId(sectionId)RemoveSectionLegt die Abschnitts-ID des zu entfernenden Abschnitts fest.

RemoveWidget

Methoden

MethodeRückgabetypKurzbeschreibung
setWidgetId(widgetId)RemoveWidgetLegt die Widget-ID des zu entfernenden Widgets fest.

RenderAction

Methoden

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

RenderActionBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()RenderActionErstellt die aktuelle Rendering-Aktion und validiert sie.
setAction(action)RenderActionBuilderLegt die Aktion fest, mit der Add-ons die Benutzeroberfläche auf die Render-Aktion aktualisieren können.
setHostAppAction(hostAppAction)RenderActionBuilderLegt die HostAppAction fest, die von einzelnen Host-Apps für die Rendering-Aktion verarbeitet werden.

ResourceData

Methoden

MethodeRückgabetypKurzbeschreibung
addVariableData(key, value)ResourceDataFügt ein VariableData mit dem Variablennamen als Schlüssel hinzu. Ein Wert wird überschrieben, wenn der Schlüssel bereits vorhanden ist.
setVariableDataMap(fields)ResourceDataLegt die Zuordnung der Variablendaten nach Variablennamen fest.

ResourceField

Methoden

MethodeRückgabetypKurzbeschreibung
setDataType(dataType)ResourceFieldLegt den Datentyp des Felds fest. In anderen Schritten können die Variablen bei der Auswahl nach Typ gefiltert werden.
setDisplayText(displayText)ResourceFieldLegt die Beschreibung des Felds fest, die dem Endnutzer bei der Variablenauswahl in nachfolgenden Schritten angezeigt wird.
setSelector(selector)ResourceFieldLegt einen Schlüssel für die Anbieterfunktion fest, um den Wert während der Ausführung des Schritts bereitzustellen.

ResourceFieldsDefinitionRetrievedAction

Methoden

MethodeRückgabetypKurzbeschreibung
addDynamicResourceDefinition(dynamicResourceDefinition)ResourceFieldsDefinitionRetrievedActionFügt der abgerufenen Aktion für die Definition der Ressourcenfelder ein DynamicResourceDefinition hinzu.

ResourceRetrievedAction

Methoden

MethodeRückgabetypKurzbeschreibung
setResourceData(resourceData)ResourceRetrievedActionLegt die ResourceData auf die Aktion zum Abrufen der Ressource fest, um Werte für die dynamischen Ressourcenfelder oder benutzerdefinierten Ressourcenfelder bereitzustellen.

ResourceType

Methoden

MethodeRückgabetypKurzbeschreibung
setWorkflowResourceDefinitionId(resourceType)ResourceTypeLegt die ID der Workflow-Ressourcendefinition fest.

ReturnElementErrorAction

Methoden

MethodeRückgabetypKurzbeschreibung
setErrorActionability(errorActionability)ReturnElementErrorActionLegt die Umsetzbarkeit des Fehlers fest. Ein Fehler sollte umsetzbar sein, wenn er durch eine Neukonfiguration des Schritts behoben werden kann.
setErrorLog(log)ReturnElementErrorActionLegt fest, dass das Fehlerprotokoll im Aktivitätsfeed des Workflows für den Endnutzer angezeigt wird.
setErrorRetryability(errorRetryability)ReturnElementErrorActionLegt fest, ob ein Fehler wiederholt werden kann. Der Ablauf wird nach dem ersten Versuch beendet, wenn ein Fehler nicht wiederholt werden kann.

ReturnOutputVariablesAction

Methoden

MethodeRückgabetypKurzbeschreibung
addVariableData(key, value)ReturnOutputVariablesActionFügt variable Daten hinzu, die nach dem Variablennamen indexiert werden. Ein Wert wird überschrieben, wenn der Schlüssel bereits vorhanden ist.
setLog(log)ReturnOutputVariablesActionLegt das Protokoll der ausgeführten Workflow-Aktion für den Endnutzer im Aktivitätsfeed des Workflows fest.
setVariableDataMap(variables)ReturnOutputVariablesActionLegt die Zuordnung der Variablendaten fest, die nach Variablennamen indexiert werden. Ein Wert wird überschrieben, wenn der Schlüssel bereits vorhanden ist.

SaveWorkflowAction

SendStatus

Attribute

AttributTypBeschreibung
NOT_SENDEnumStandard.
CONTINUE_SENDEnumDie E-Mail wird nach dem Aktualisieren des Entwurfs weiterhin gesendet.

StyledText

Methoden

MethodeRückgabetypKurzbeschreibung
addStyle(style)StyledTextLegt das Format des formatierten Texts fest. Auf einen einzelnen formatierten Text können mehrere Formatierungen angewendet werden.
setColor(color)StyledTextLegt die Farbe des formatierten Texts fest.
setFontWeight(fontWeight)StyledTextLegt die Schriftstärke des formatierten Texts fest.
setText(text)StyledTextLegt den Hauptinhalt des formatierten Texts fest.

TextFormatChip

Methoden

MethodeRückgabetypKurzbeschreibung
setLabel(label)TextFormatChipLegt den im Chip angezeigten Text fest.
setTextFormatIcon(icon)TextFormatChipLegt das im Chip angezeigte Symbol fest.
setUrl(url)TextFormatChipLegt die URL fest, zu der der Nutzer weitergeleitet wird, wenn er auf den Chip klickt.

TextFormatElement

Methoden

MethodeRückgabetypKurzbeschreibung
setHyperlink(hyperlink)TextFormatElementLegt das Textformatelement als Hyperlink fest.
setListContainer(listContainer)TextFormatElementLegt das Textformatelement als ListContainer fest.
setStyledText(styledText)TextFormatElementLegt das Textformatelement als StyledText fest.
setText(text)TextFormatElementLegt das Textformat-Element als Textstring fest.
setTextFormatChip(chip)TextFormatElementLegt das Textformatelement als TextFormatChip fest.

TextFormatIcon

Methoden

MethodeRückgabetypKurzbeschreibung
setIconUrl(iconUrl)TextFormatIconLegt die Symbol-URL fest.
setMaterialIconName(materialIconName)TextFormatIconLegt den Namen des Material-Symbols fest, das in Google Material Icons definiert ist.

TextStyle

Attribute

AttributTypBeschreibung
STYLE_UNSPECIFIEDEnumEs wurde kein Stil angewendet.
ITALICEnumKursiver Stil.
UNDERLINEEnumUnterstreichungsart.
STRIKETHROUGHEnumDurchgestrichener Stil.
LINE_BREAKEnumZeilenumbruch.
UPPERCASEEnumGroßschreibung.
CODEEnumCodestil
CODE_BLOCKEnumStil für Codeblöcke.

TimeStamp

Methoden

MethodeRückgabetypKurzbeschreibung
setNanos(nanos)TimeStampLegt die Nanosekunden des Zeitstempels fest. Dies entspricht der Anzahl der Nanosekunden innerhalb der aktuellen Sekunde.
setSeconds(seconds)TimeStampLegt die Sekunden des Zeitstempels fest. Er gibt die Anzahl der Sekunden seit der Unix-Epoche(1. Januar 1970, 00:00:00 UTC) an.

UniversalActionResponse

Methoden

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

UniversalActionResponseBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
build()UniversalActionResponseErstellt die aktuelle Antwort für die universelle Aktion und validiert sie.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderZeigt das Add-on mit den angegebenen Karten an.
setOpenLink(openLink)UniversalActionResponseBuilderLegt die URL fest, die geöffnet werden soll, 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 für die Aktion zum Aktualisieren des aktuellen Entwurfs und validiert sie.
setSendStatus(sendStatus)UpdateDraftActionResponseBuilderLegt das Enum-Feld fest, das bestimmt, ob die E‑Mail nach der Aktualisierungsaktion gesendet wird.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderLegt eine Aktion fest, mit der die Bcc-Empfänger einer E‑Mail-Vorlage 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)UpdateDraftBccRecipientsActionAktualisiert die Bcc-Empfänger eines E‑Mail-Entwurfs.

UpdateDraftBodyAction

Methoden

MethodeRückgabetypKurzbeschreibung
addUpdateContent(content, contentType)UpdateDraftBodyActionFügt dem Entwurfstext die angegebenen Inhalte hinzu.
setUpdateType(updateType)UpdateDraftBodyActionLegt die UpdateDraftBodyType dieser Aktualisierungsaktion für den Draft-Textkörper fest.

UpdateDraftBodyType

Attribute

AttributTypBeschreibung
IN_PLACE_INSERTEnumStandard.
INSERT_AT_STARTEnumDurch Update-Aktionen wird Inhalt am Anfang des Nachrichtentexts eingefügt.
INSERT_AT_ENDEnumBei Update-Aktionen 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 „An“-Empfänger eines E‑Mail-Entwurfs.

UpdateInlinePreviewAction

Methoden

MethodeRückgabetypKurzbeschreibung
addCardWithId(cardWithId)UpdateInlinePreviewActionFügt die Karte für diese Aktion hinzu.
addExpiration(ttl)UpdateInlinePreviewActionFügt das Ablaufdatum für diese Aktion hinzu.

UpdateMessageAction

Methoden

MethodeRückgabetypKurzbeschreibung
setMessage(message)UpdateMessageActionLegt die Meldung für diese Aktion fest.

UpdateWidget

Methoden

MethodeRückgabetypKurzbeschreibung
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetFügt ein neues Element hinzu, das in Menüs mit Mehrfachauswahl ausgewählt werden kann.

ValidationErrorSeverity

Attribute

AttributTypBeschreibung
SEVERITY_UNSPECIFIEDEnumNicht angegeben
CRITICALEnumKritisch: Der Fehler ist kritisch und muss vor der Veröffentlichung behoben werden.
WARNINGEnumWarnung: Der Fehler ist nicht kritisch und verhindert die Veröffentlichung nicht.

ValueMetadata

Methoden

MethodeRückgabetypKurzbeschreibung
addCastableType(dataType)ValueMetadataFügt dieser Wert-Metadaten optional zulässige Typen hinzu, die für Variablendaten dynamisch umgewandelt werden können.
addEnumValue(enumValue)ValueMetadataFügt den zulässigen Enumerationswerten einer Variablen einen optionalen Stringwert hinzu. Dieses Feld kann nur festgelegt werden, wenn DataType auf den Typ „String“ gesetzt ist.
setDefaultValue(defaultValue)ValueMetadataLegt den optionalen Standardwert der Variablen fest. Wenn der Variablentyp beispielsweise „boolean“ ist, kann „defaultValue“ auf „true“ oder „false“ festgelegt werden.

VariableData

Methoden

MethodeRückgabetypKurzbeschreibung
addBooleanValue(value)VariableDataFügt den Variablendaten einen booleschen Wert hinzu.
addEmailAddress(emailAddress)VariableDataFügt den Variablendaten eine E‑Mail-Adresse hinzu.
addFloatValue(value)VariableDataFügt den Variablendaten einen Gleitkommawert hinzu.
addGoogleUser(googleUser)VariableDataFügt den Variablendaten einen Google-Nutzer hinzu.
addIntegerValue(value)VariableDataFügt den Variablendaten einen Ganzzahlwert hinzu.
addResourceData(resourceData)VariableDataFügt den Variablendaten einen ResourceData-Wert hinzu.
addResourceReference(resourceReference)VariableDataFügt den Variablendaten eine Ressourcenreferenz-ID hinzu.
addStringValue(value)VariableDataFügt den Variablendaten einen Stringwert hinzu.
addTimestampValue(value)VariableDataFügt den Variablendaten einen TimeStamp-Wert hinzu.
addWorkflowTextFormat(workflowTextFormat)VariableDataFügt den Variablendaten einen WorkflowTextFormat-Wert hinzu.

WorkflowAction

WorkflowTextFormat

Methoden

MethodeRückgabetypKurzbeschreibung
addTextFormatElement(textFormatElement)WorkflowTextFormatFügt dem Workflow-Textformat ein TextFormatElement hinzu.

WorkflowValidationErrorAction

Methoden

MethodeRückgabetypKurzbeschreibung
setSeverity(severity)WorkflowValidationErrorActionLegt den Schweregrad des Validierungsfehlers fest.