Mit diesem Dienst können Skripts Google Workspace-Add‑ons konfigurieren und erstellen, die Google Workspace Studio erweitern.
Klassen
| Name | Kurzbeschreibung |
|---|---|
Action | Eine Aktion, mit der Google Workspace-Add-ons, die Google Workspace Studio erweitern, eine neue Karte rendern können. |
Add | Add bietet die Möglichkeit, Antworten für Google Workspace-Add-ons zu erstellen, die Google Workspace Studio erweitern. |
Basic | Ein Enum, das die grundlegenden generischen Datentypen darstellt. |
Color | Ein Color-Objekt, das eine Farbe im RGBA-Farbraum darstellt. |
Data | Mit einem DataType wird der Typ einer Variablen festgelegt. |
Dynamic | Eine DynamicResourceDefinition ist ein Baustein für eine Resource. Sie kann eine oder mehrere Resource enthalten, um die Anzahl der Ausgabevariablen, die von einem Schritt in Google Workspace Studio bereitgestellt werden, dynamisch zu definieren. |
Error | Ein Enum-Wert, der die Behebbarkeit des Fehlers darstellt. |
Error | Ein Enum, das die Möglichkeit zum Wiederholen des Aktionsaufrufs bei einem Fehler darstellt. |
Font | Ein Enum-Wert, der die Schriftstärke des formatierten Texts darstellt. |
Host | Eine HostAppAction ist eine Art von Aktion, die von einzelnen Host-Apps verarbeitet wird. |
Hyperlink | Ein Hyperlink-Element, das in Text verwendet wird. |
Insert | Ein Builder für InsertSection-Objekte. |
Insert | Ein Builder für InsertWidget-Objekte. |
Link | Das Linkobjekt aus einer Drittanbieterressource, das in der Hostanwendung in einen Smartchip konvertiert wird. |
List | Container für Listenelemente, wobei jedes Listenelement mehrere Text enthalten kann. |
List | Ein Listenelement, das mehrere Text enthalten kann. |
List | Ein Enum-Wert, der den Typ der Liste darstellt. |
Modify | Ein Builder für Modify-Objekte, mit dem die Benutzeroberfläche einer vorhandenen Karte geändert und aktualisiert wird, indem das Modify-Objekt an ein Action übergeben wird. |
Navigation | Ein Hilfsobjekt, das die Kartennavigation steuert. |
Remove | Ein Builder für Remove-Objekte. |
Remove | Ein Builder für RemoveWidget-Objekte. |
Render | Rendert oder aktualisiert eine Karte durch Ausführen von Action als Reaktion auf eine Nutzerinteraktion. |
Render | Ein Builder für Render-Objekte. |
Resource | Stellt anwendungsspezifische Ressourcendaten dar. Ressourcendaten enthalten eine Sammlung von Schlüssel-Wert-Paaren mit Variablennamen und Variable. |
Resource | Ein ResourceField ist ein grundlegender Baustein eines Dynamic. Jedes Ressourcenfeld entspricht einer Ausgabevariablen des aktuellen Schritts. |
Resource | Ein Resource ist ein Typ von Resource, der verwendet wird, um die Definition einer Liste von Ressourcenfeldern über die im Manifest angegebene Funktion dynamic abzurufen. |
Resource | Mit einer ResourceRetrievedAction wird bei Bedarf benutzerdefinierter Ressourceninhalt abgerufen. Das Feld für die benutzerdefinierte Ressource wird in den ResourceData definiert. |
Resource | Ein anwendungsspezifischer Ressourcentyp. Die eindeutige Kennzeichnung des Ressourcentyps muss eine entsprechende WorkflowResourceDefinition haben. |
Return | Ein ReturnElementErrorAction gibt an, dass beim Aufrufen des Elements ein Fehler aufgetreten ist. |
Return | Enthält Ausgabevariablen, die von der ausgeführten Aktion in Google Workspace Studio generiert wurden. |
Save | Diese Aktion gibt an, dass die Host-App (Google Workspace Studio) den Agent speichern soll. |
Styled | Textelement mit Formatierungen wie fett, kursiv und Farbe. |
Text | Ein anklickbarer Chip im Textformat. |
Text | Ein Textformatelement, das Text, Styled, Hyperlink oder List sein kann. |
Text | Ein Symbol, das in einem Text angezeigt wird. |
Text | Ein Enum-Wert, der den Stil des formatierten Texts darstellt. |
Time | Stellt ein Zeitstempelobjekt dar, das einer Variable hinzugefügt werden kann. |
Update | Ein Builder für Update-Objekte. |
Validation | Ein Enum-Wert, der den Schweregrad des Validierungsfehlers darstellt. |
Value | Ein „valueMetadata“-Objekt enthält Informationen zu den möglichen Werten einer Variablen. |
Variable | Stellt variable Daten dar, die eine Sammlung von Werten verschiedener Typen enthalten können. |
Workflow | Eine WorkflowAction ist ein Typ von Host, der verwendet wird, um eine bestimmte Aktion in Google Workspace Studio auszuführen. |
Workflow | Ein Textblock mit Rich-Text-Formatierungsoptionen wie Stilen, Hyperlinks und interaktiven Elementen, die in Text definiert sind. |
Workflow | Diese Aktion weist darauf hin, dass in der Host-App (Google Workspace Studio) ein Validierungsfehler angezeigt werden soll. |
Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Action | Fügt der Aktion einen ModifyCard-Vorgang hinzu. |
add | Action | Fügt der Aktion eine Kartennavigation hinzu. |
Add Ons Response Service
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
new | Action | Erstellt einen neuen Action |
new | Navigation | Erstellt einen neuen Navigation |
new | Render | Erstellt einen neuen Render |
Basic Data Type
Attribute
| Attribut | Typ | Beschreibung |
|---|---|---|
BASIC_TYPE_UNSPECIFIED | Enum | Standardwert. |
STRING | Enum | Eine Zeichenfolge. |
INTEGER | Enum | Ein Ganzzahlwert. |
FLOAT | Enum | Eine Gleitkommazahl |
TIMESTAMP | Enum | Ein Zeitstempel im ISO 8601-Format. |
BOOLEAN | Enum | Ein boolescher Wert. |
EMAIL_ADDRESS | Enum | Ein String im Format einer E-Mail-Adresse. |
GOOGLE_USER | Enum | Ein Nutzer der Google-Dienste im Format „users/encoded_GAIA_ID“ |
FILE | Enum | Ein Dateityp. |
FORMATTED_TEXT | Enum | Ein Text mit umfangreicher Formatierung. |
Color
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Color | Legt die Alphakomponente der Farbe fest. |
set | Color | Legt die blaue Komponente der Farbe fest. |
set | Color | Legt die grüne Komponente der Farbe fest. |
set | Color | Legt die rote Komponente der Farbe fest. |
Data Type
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Data | Legt den Datentyp auf einen der unterstützten Basic fest. |
set | Data | Legt den Datentyp auf einen benutzerdefinierten Resource fest. |
set | Data | Legt die Value fest, die typspezifische Informationen zur Variablen enthält. |
Dynamic Resource Definition
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Dynamic | Fügt der dynamischen Ressourcendefinition ein Ressourcenfeld hinzu. |
set | Dynamic | Legt die ID für die dynamische Ressourcendefinition fest. Diese ID entspricht workflow im Manifest. |
Error Actionability
Attribute
| Attribut | Typ | Beschreibung |
|---|---|---|
ERROR_ACTIONABILITY_UNSPECIFIED | Enum | Nicht angegeben |
NOT_ACTIONABLE | Enum | Der Fehler kann vom Nutzer nicht über die Konfigurationskarte behoben werden. |
ACTIONABLE | Enum | Der Fehler kann vom Nutzer über die Konfigurationskarte behoben werden. |
Error Retryability
Attribute
| Attribut | Typ | Beschreibung |
|---|---|---|
RETRYABILITY_UNSPECIFIED | Enum | Nicht angegeben |
NOT_RETRYABLE | Enum | Der Fehler kann nicht wiederholt werden. Der Ablauf wird nach dem ersten Versuch beendet. |
RETRYABLE | Enum | Der Fehler kann wiederholt werden. Der Workflow versucht, den Schritt bis zu fünfmal auszuführen. |
Font Weight
Attribute
| Attribut | Typ | Beschreibung |
|---|---|---|
FONT_WEIGHT_UNSPECIFIED | Enum | Standardgewicht mit normaler Stärke. |
LIGHT | Enum | Geringeres Gewicht und geringere Dicke. |
MEDIUM | Enum | Mittleres Gewicht zwischen „Light“ und „Bold“. |
BOLD | Enum | Höheres Gewicht bei erhöhter Dicke. |
Host App Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Host | Legt die Host-App-Aktion auf „Workflow-Aktion“ fest. |
Hyperlink
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Hyperlink | Legt die Ziel-URL des Hyperlinks fest. |
set | Hyperlink | Legt den Text des Hyperlinks fest. |
Insert Section
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
insert | Insert | Legt das Flag „onCardTop“ fest, das angibt, ob der neue Bereich oben auf der Karte eingefügt werden soll. |
insert | Insert | Legt die Abschnitts-ID fest. Der neue Abschnitt wird darunter eingefügt. |
set | Insert | Legt den einzufügenden Kartenabschnitt fest. |
Insert Widget
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
insert | Insert | Legt die Widget-ID fest. Das neue Widget wird über dem Widget mit der angegebenen ID eingefügt. |
insert | Insert | Legt die Widget-ID fest. Das neue Widget wird unter dem Widget mit der angegebenen ID eingefügt. |
set | Insert | Legt die einzufügende Widget fest. |
Link
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Link | Legt den Titel des Links fest. |
set | Link | Legt die URL des Links fest. |
List Container
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | List | Fügt dem Listencontainer ein Listenelement hinzu. |
set | List | Legt die Ebene der Liste fest. Die oberste Ebene beginnt bei 0 und wird für jede verschachtelte Liste um 1 erhöht. |
set | List | Legt fest, ob die Liste sortiert oder unsortiert sein soll. |
List Item
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | List | Fügt dem Listenelement ein Text hinzu. |
List Type
Attribute
| Attribut | Typ | Beschreibung |
|---|---|---|
LIST_TYPE_UNSPECIFIED | Enum | Standardwert. |
ORDERED | Enum | Sortierte Liste. |
UNORDERED | Enum | Unsortierte Liste. |
Modify Card
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Modify | Legt die Insert für dieses Objekt zum Ändern der Karte fest. |
set | Modify | Legt die Insert für dieses Objekt zum Ändern der Karte fest. |
set | Modify | Legt die Remove für dieses Objekt zum Ändern der Karte fest. |
set | Modify | Legt die Remove für dieses Objekt zum Ändern der Karte fest. |
set | Modify | Legt den Ersatz-Card für dieses Objekt zum Ändern der Karte fest. Der Ersatzabschnitt sollte dieselbe ID wie ein vorhandener Kartenabschnitt haben. |
set | Modify | Legt das Ersatz-Widget für dieses ModifyCard-Objekt fest. Das Ersatz-Widget sollte dieselbe ID wie ein vorhandenes Widget haben. |
set | Modify | Legt die Update für dieses Objekt zum Ändern der Karte fest. |
Navigation
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
print | String | Gibt die JSON-Darstellung dieses Objekts aus. |
push | Navigation | Legt die angegebene Karte auf den Stapel. |
Remove Section
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Remove | Legt die Abschnitts-ID des zu entfernenden Abschnitts fest. |
Remove Widget
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Remove | Legt die Widget-ID des zu entfernenden Widgets fest. |
Render Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
print | String | Gibt die JSON-Darstellung dieses Objekts aus. |
Render Action Builder
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
build() | Render | Erstellt die aktuelle Rendering-Aktion und validiert sie. |
set | Render | Legt die Aktion fest, mit der Add-ons die Benutzeroberfläche auf die Render-Aktion aktualisieren können. |
set | Render | Legt die Host fest, die von einzelnen Host-Apps für die Render-Aktion verarbeitet werden. |
Resource Data
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Resource | Fügt ein Variable mit dem Variablennamen als Schlüssel hinzu. Ein Wert wird überschrieben, wenn der Schlüssel bereits vorhanden ist. |
set | Resource | Legt die Zuordnung der Variablendaten nach Variablennamen fest. |
Resource Field
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Resource | Legt den Datentyp des Felds fest. In anderen Schritten können die Variablen bei der Auswahl nach Typ gefiltert werden. |
set | Resource | Legt die Beschreibung des Felds fest, die dem Endnutzer bei der Variablenauswahl in nachfolgenden Schritten angezeigt wird. |
set | Resource | Legt einen Schlüssel für die Anbieterfunktion fest, um den Wert während der Ausführung des Schritts bereitzustellen. |
Resource Fields Definition Retrieved Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Resource | Fügt der abgerufenen Aktion für die Definition der Ressourcenfelder ein Dynamic hinzu. |
Resource Retrieved Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Resource | Legt die Resource auf die Aktion zum Abrufen der Ressource fest, um Werte für die dynamischen Ressourcenfelder oder benutzerdefinierten Ressourcenfelder bereitzustellen. |
Resource Type
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Resource | Legt die ID der Workflow-Ressourcendefinition fest. |
Return Element Error Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Return | Legt die Umsetzbarkeit des Fehlers fest. Ein Fehler sollte umsetzbar sein, wenn er durch eine Neukonfiguration des Schritts behoben werden kann. |
set | Return | Legt fest, dass das Fehlerprotokoll im Aktivitätsfeed des Workflows für den Endnutzer angezeigt wird. |
set | Return | Legt fest, ob ein Fehler wiederholt werden kann. Der Ablauf wird nach dem ersten Versuch beendet, wenn ein Fehler nicht wiederholt werden kann. |
Return Output Variables Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Return | Fügt variable Daten hinzu, die nach dem Variablennamen indexiert werden. Ein Wert wird überschrieben, wenn der Schlüssel bereits vorhanden ist. |
set | Return | Legt das Protokoll der ausgeführten Workflow-Aktion für den Endnutzer im Aktivitätsfeed des Workflows fest. |
set | Return | Legt die Zuordnung der Variablendaten fest, die nach Variablennamen indexiert werden. Ein Wert wird überschrieben, wenn der Schlüssel bereits vorhanden ist. |
Save Workflow Action
Styled Text
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Styled | Legt das Format des formatierten Texts fest. Auf einen einzelnen formatierten Text können mehrere Formatierungen angewendet werden. |
set | Styled | Legt die Farbe des formatierten Texts fest. |
set | Styled | Legt die Schriftstärke des formatierten Texts fest. |
set | Styled | Legt den Hauptinhalt des formatierten Texts fest. |
Text Format Chip
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Text | Legt den im Chip angezeigten Text fest. |
set | Text | Legt das im Chip angezeigte Symbol fest. |
set | Text | Legt die URL fest, zu der der Nutzer weitergeleitet wird, wenn er auf den Chip klickt. |
Text Format Element
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Text | Legt das Textformatelement als Hyperlink fest. |
set | Text | Legt das Textformatelement als List fest. |
set | Text | Legt das Textformatelement als Styled fest. |
set | Text | Legt das Textformat-Element als Textstring fest. |
set | Text | Legt das Textformatelement als Text fest. |
Text Format Icon
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Text | Legt die Symbol-URL fest. |
set | Text | Legt den Namen des Material-Symbols fest, das in Google Material Icons definiert ist. |
Text Style
Attribute
| Attribut | Typ | Beschreibung |
|---|---|---|
STYLE_UNSPECIFIED | Enum | Es wurde kein Stil angewendet. |
ITALIC | Enum | Kursiver Stil. |
UNDERLINE | Enum | Unterstreichungsstil. |
STRIKETHROUGH | Enum | Durchgestrichener Stil. |
LINE_BREAK | Enum | Zeilenumbruch. |
UPPERCASE | Enum | Großschreibung. |
CODE | Enum | Codestil |
CODE_BLOCK | Enum | Stil für Codeblöcke. |
Time Stamp
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Time | Legt die Nanosekunden des Zeitstempels fest. Sie stellen die Anzahl der Nanosekunden innerhalb der aktuellen Sekunde dar. |
set | Time | Legt die Sekunden des Zeitstempels fest. Er gibt die Anzahl der Sekunden seit der Unix-Epoche(1. Januar 1970, 00:00:00 UTC) an. |
Update Widget
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Update | Fügt für Menüs mit Mehrfachauswahl ein neues Element hinzu, das ausgewählt werden kann. |
Validation Error Severity
Attribute
| Attribut | Typ | Beschreibung |
|---|---|---|
SEVERITY_UNSPECIFIED | Enum | Nicht angegeben |
CRITICAL | Enum | Kritisch: Der Fehler ist kritisch und muss vor der Veröffentlichung behoben werden. |
WARNING | Enum | Warnung: Der Fehler ist nicht kritisch und verhindert die Veröffentlichung nicht. |
Value Metadata
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Value | Fügt dieser Wert-Metadaten optional zulässige Typen hinzu, die für Variablendaten dynamisch umgewandelt werden können. |
add | Value | Fügt den zulässigen Enumerationswerten einer Variablen einen optionalen Stringwert hinzu. Dieses Feld kann nur festgelegt werden, wenn Data auf „String“ gesetzt ist. |
set | Value | Legt den optionalen Standardwert der Variablen fest. Wenn der Variablentyp beispielsweise „boolean“ ist, kann „defaultValue“ auf „true“ oder „false“ festgelegt werden. |
Variable Data
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Variable | Fügt den Variablendaten einen booleschen Wert hinzu. |
add | Variable | Fügt den Variablendaten eine E‑Mail-Adresse hinzu. |
add | Variable | Fügt den Variablendaten einen Gleitkommawert hinzu. |
add | Variable | Fügt den Variablendaten einen Google-Nutzer hinzu. |
add | Variable | Fügt den Variablendaten einen Ganzzahlwert hinzu. |
add | Variable | Fügt den Variablendaten einen Resource-Wert hinzu. |
add | Variable | Fügt den Variablendaten eine Ressourcenreferenz-ID hinzu. |
add | Variable | Fügt den Variablendaten einen Stringwert hinzu. |
add | Variable | Fügt den Variablendaten einen Time-Wert hinzu. |
add | Variable | Fügt den Variablendaten einen Workflow-Wert hinzu. |
Workflow Action
Workflow Text Format
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Workflow | Fügt dem Workflow-Textformat ein Text hinzu. |
Workflow Validation Error Action
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Workflow | Legt den Schweregrad des Validierungsfehlers fest. |