AddOns Response Service

Add-on-Antwortdienst

Mit diesem Dienst können Skripts Google Workspace-Add‑ons konfigurieren und erstellen, die Google Workspace Studio erweitern.

Klassen

NameKurzbeschreibung
ActionEine Aktion, mit der Google Workspace-Add-ons, die Google Workspace Studio erweitern, eine neue Karte rendern können.
AddOnsResponseServiceAddOnsResponseService bietet die Möglichkeit, Antworten für Google Workspace-Add-ons zu erstellen, die Google Workspace Studio erweitern.
BasicDataTypeEin Enum, das die grundlegenden generischen Datentypen darstellt.
ColorEin Color-Objekt, das eine Farbe im RGBA-Farbraum darstellt.
DataTypeMit einem DataType wird der Typ einer Variablen festgelegt.
DynamicResourceDefinitionEine DynamicResourceDefinition ist ein Baustein für eine ResourceFieldsDefinitionRetrievedAction. Sie kann eine oder mehrere ResourceField enthalten, um die Anzahl der Ausgabevariablen, die von einem Schritt in Google Workspace Studio bereitgestellt werden, dynamisch zu definieren.
ErrorActionabilityEin Enum-Wert, der die Behebbarkeit des Fehlers darstellt.
ErrorRetryabilityEin Enum, das die Möglichkeit zum Wiederholen 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.
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.
RemoveSectionEin Builder für RemoveSection-Objekte.
RemoveWidgetEin Builder für RemoveWidget-Objekte.
RenderActionRendert oder aktualisiert eine Karte durch Ausführen von 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 Kennzeichnung des Ressourcentyps muss 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.
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.
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 soll.

Action

Methoden

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

AddOnsResponseService

Methoden

MethodeRückgabetypKurzbeschreibung
newAction()ActionErstellt einen neuen Action
newNavigation()NavigationErstellt einen neuen Navigation
newRenderActionBuilder()RenderActionBuilderErstellt einen neuen RenderActionBuilder

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 umfangreicher Formatierung.

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.

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.

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.

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_UNSPECIFIEDEnumStandardgewicht mit normaler Stärke.
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.

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 ModifyCard-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
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
pushCard(card)NavigationLegt die angegebene Karte auf den Stapel.

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

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.
UNDERLINEEnumUnterstreichungsstil.
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. Sie stellen die Anzahl der Nanosekunden innerhalb der aktuellen Sekunde dar.
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.

UpdateWidget

Methoden

MethodeRückgabetypKurzbeschreibung
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetFügt für Menüs mit Mehrfachauswahl ein neues Element hinzu, das 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 „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.