Package google.apps.script.type

Index

AddOnWidgetSet

Die Widget-Subsets, die von einem Add-on verwendet werden.

Felder
usedWidgets[]

WidgetType

Die Liste der in einem Add-on verwendeten Widgets.

WidgetType

Der Widget-Typ. WIDGET_TYPE_UNSPECIFIED ist das grundlegende Widget-Set.

Enums
WIDGET_TYPE_UNSPECIFIED Der Standard-Widget-Satz.
DATE_PICKER Die Datumsauswahl.
STYLED_BUTTONS Zu den stilisierten Schaltflächen gehören ausgefüllte und deaktivierte Schaltflächen.
PERSISTENT_FORMS Mit persistenten Formularen können Formularwerte während Aktionen beibehalten werden.
UPDATE_SUBJECT_AND_RECIPIENTS Betreff und Empfänger eines Entwurfs aktualisieren
GRID_WIDGET Das Raster-Widget.
ADDON_COMPOSE_UI_ACTION Eine Gmail-Add-on-Aktion, die auf die Benutzeroberfläche zum Verfassen von E-Mails des Add-ons angewendet wird.

CommonAddOnManifest

Add-on-Konfiguration, die für alle Add-on-Hostanwendungen freigegeben wird.

Felder
name

string

Erforderlich. Der Anzeigename des Add-ons.
logoUrl

string

Erforderlich. Die URL für das Logobild, das in der Symbolleiste des Add-ons angezeigt wird.
layoutProperties

LayoutProperties

Gängige Layouteigenschaften für Add-on-Karten.
addOnWidgetSet

AddOnWidgetSet

Die im Add-on verwendeten Widgets. Wenn dieses Feld nicht angegeben ist, wird die Standardgruppe verwendet.
useLocaleFromApp

bool

Gibt an, ob Informationen zur Sprache und Region von der Host-App übergeben werden sollen.
homepageTrigger

HomepageExtensionPoint

Definiert einen Endpunkt, der in jedem Kontext und auf jedem Host ausgeführt wird. Alle Karten, die mit dieser Funktion generiert werden, sind für den Nutzer immer verfügbar, können aber von kontextbezogenen Inhalten verdeckt werden, wenn dieses Add-on gezieltere Trigger deklariert.
universalActions[]

UniversalActionExtensionPoint

Hier wird eine Liste von Erweiterungspunkten im universellen Aktionsmenü definiert, das als Einstellungsmenü für das Add-on dient. Der Erweiterungspunkt kann eine Link-URL zum Öffnen oder ein Endpunkt sein, der als Formulareinreichung ausgeführt wird.
openLinkUrlPrefixes

ListValue

Für eine OpenLink-Aktion kann nur eine URL mit einem HTTPS-, MAILTO- oder TEL-Schema verwendet werden. Bei HTTPS-Links muss die URL außerdem mit einem der in der Zulassungsliste angegebenen Präfixe übereinstimmen. Wenn das Präfix das Schema nicht enthält, wird HTTPS angenommen. HTTP-Links werden automatisch in HTTPS-Links umgeschrieben.

CreateActionExtensionPoint

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer den Workflow zum Erstellen von Ressourcen in einer Google Workspace-Anwendung aufruft. Weitere Informationen finden Sie unter Drittanbieterressourcen über das Dreipunkt-Menü erstellen.

Felder
id

string

Erforderlich. Die eindeutige ID, um diesen Erweiterungspunkt zu unterscheiden. Die ID darf maximal 64 Zeichen lang sein und sollte das Format [a-zA-Z0-9-]+ haben.
labelText

string

Erforderlich. Der Text, der neben einem Symbol für den Einstiegspunkt zur Ressourcenerstellung angezeigt wird, z. B. Create support case. Dieser Text ist statisch und wird angezeigt, bevor Nutzer das Add-on ausführen.
localizedLabelText

map<string, string>

Optional. Eine Karte von labelText, die in andere Sprachen lokalisiert werden soll. Formatieren Sie die Sprache im ISO 639-Format und das Land/die Region im ISO 3166-Format, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn das Gebietsschema eines Nutzers in den Schlüsseln der Karte enthalten ist, sieht der Nutzer die lokalisierte Version der labelText.
runFunction

string

Erforderlich. Endpunkt, der ausgeführt wird, wenn ein Workflow zum Erstellen einer Ressource ausgelöst wird, um einen Link zu erstellen.
logoUrl

string

Optional. Das Symbol, das für den Einstiegspunkt zur Ressourcenerstellung angezeigt wird. Wenn Sie das Feld leer lassen, wird im Menü das Symbol für die Symbolleiste des Add-ons logoUrl verwendet.

HomepageExtensionPoint

Gängiges Format für die Deklaration der Startseitenansicht eines Add-ons.

Felder
runFunction

string

Erforderlich. Der Endpunkt, der ausgeführt wird, wenn dieser Erweiterungspunkt aktiviert ist.
enabled

BoolValue

Optional. Wenn dieser Wert auf false festgelegt ist, wird die Startseitenansicht in diesem Kontext deaktiviert.

Wenn dieser Wert nicht festgelegt ist, wird standardmäßig true verwendet.

Wenn die benutzerdefinierte Startseitenansicht eines Add-ons deaktiviert ist, wird Nutzern stattdessen eine allgemeine Übersichtskarte angezeigt.

HttpAuthorizationHeader

Autorisierungsheader, der in Add-on-HTTP-Anfragen gesendet wird.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Standardwert, entspricht SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Senden Sie ein ID-Token für das Systemdienstkonto des projektspezifischen Google Workspace-Add-ons (Standard).
USER_ID_TOKEN Senden Sie ein ID-Token für den Endnutzer.
NONE Senden Sie keinen Authentifizierungsheader.

HttpOptions

Optionen zum Senden von Anfragen an HTTP-Endpunkte von Add-ons.

Felder
authorizationHeader

HttpAuthorizationHeader

Konfiguration für das Token, das im HTTP-Autorisierungsheader gesendet wird.

LayoutProperties

Kartenlayout-Eigenschaften, die für alle Add-on-Hostanwendungen freigegeben sind.

Felder
primaryColor

string

Die Hauptfarbe des Add-ons. Damit wird die Farbe der Symbolleiste festgelegt. Wenn keine primäre Farbe festgelegt ist, wird der vom Framework bereitgestellte Standardwert verwendet.
secondaryColor

string

Die sekundäre Farbe des Add-ons. Hiermit wird die Farbe der Schaltflächen festgelegt. Wenn die Primärfarbe festgelegt ist, aber keine Sekundärfarbe, ist die Sekundärfarbe mit der Primärfarbe identisch. Wenn weder die primäre noch die sekundäre Farbe festgelegt ist, wird der vom Framework bereitgestellte Standardwert verwendet.
useNewMaterialDesign

bool

Aktiviert das Materialdesign für Karten.

LinkPreviewExtensionPoint

Die Konfiguration eines Triggers, der ausgelöst wird, wenn ein Nutzer einen Link von einem Drittanbieter oder einem anderen Dienst in eine Google Docs-, Google Tabellen- oder Google Präsentationen-Datei eingibt oder einfügt.

Felder
labelText

string

Erforderlich. Der Text für einen Beispiel-Smartchip, der Nutzer auffordert, eine Vorschau des Links aufzurufen, z. B. Example: Support case. Dieser Text ist statisch und wird angezeigt, bevor Nutzer das Add-on ausführen.
localizedLabelText

map<string, string>

Optional. Eine Karte von labelText, die in andere Sprachen lokalisiert werden soll. Formatieren Sie die Sprache im ISO 639-Format und das Land/die Region im ISO 3166-Format, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn das Gebietsschema eines Nutzers in den Schlüsseln der Karte enthalten ist, sieht der Nutzer die lokalisierte Version der labelText.
patterns[]

UriPattern

Erforderlich. Eine Reihe von URL-Mustern, die das Add-on zum Anzeigen von Linkvorschauen auslösen.
runFunction

string

Erforderlich. Endpunkt, der ausgeführt wird, wenn eine Linkvorschau ausgelöst wird.
logoUrl

string

Optional. Das Symbol, das im Smartchip und auf der Vorschaukarte angezeigt wird. Wenn Sie das Feld leer lassen, wird das Symbol des Add-ons in der Symbolleiste (logoUrl) verwendet.

Gängiges Format für die Deklaration eines Menüpunkts oder einer Schaltfläche, die in einer Host-App angezeigt wird.

Felder
runFunction

string

Erforderlich. Der Endpunkt, der ausgeführt wird, wenn dieser Erweiterungspunkt aktiviert ist.
label

string

Erforderlich. Für Nutzer sichtbarer Text, der die Aktion beschreibt, die durch die Aktivierung dieses Erweiterungspunkts ausgeführt wird. Beispiel: „Rechnung einfügen“
logoUrl

string

Die URL für das Logobild, das in der Symbolleiste des Add-ons angezeigt wird.

Ist nichts festgelegt, wird standardmäßig die URL des Hauptlogos des Add-ons verwendet.

UniversalActionExtensionPoint

Format für die Deklaration eines Erweiterungspunkts für universelle Menüelemente für Aktionen.

Felder
label

string

Erforderlich. Für Nutzer sichtbarer Text, der die Aktion beschreibt, die durch das Aktivieren dieses Erweiterungspunkts ausgeführt wird, z. B. „Neuen Kontakt hinzufügen“.
Union-Feld action_type. Erforderlich. Der Aktionstyp, der für ein universelles Menüelement unterstützt wird. Es kann sich dabei um einen Link zum Öffnen oder einen Endpunkt zum Ausführen handeln. Für action_type ist nur einer der folgenden Werte zulässig:
runFunction

string

Endpunkt, der von der UniversalAction ausgeführt werden soll.

UriPattern

Die Konfiguration für jedes URL-Muster, das eine Linkvorschau auslöst.

Felder
hostPattern

string

Erforderlich für die Vorschau jedes URL-Musters. Die Domain des URL-Musters. Das Add-on zeigt eine Vorschau von Links an, die diese Domain in der URL enthalten. Wenn Sie eine Vorschau für Links für eine bestimmte Subdomain wie subdomain.example.com sehen möchten, geben Sie die Subdomain an. Wenn Sie eine Vorschau der Links für die gesamte Domain anzeigen lassen möchten, geben Sie als Subdomain ein Platzhalterzeichen mit einem Sternchen (*) an.

Beispielsweise führt *.example.com zu Übereinstimmungen mit subdomain.example.com und another.subdomain.example.com.
pathPrefix

string

Optional. Der Pfad, an den die Domain der hostPattern angehängt wird.

Wenn das URL-Hostmuster beispielsweise support.example.com ist, geben Sie cases ein, um URLs für Fälle abzugleichen, die auf support.example.com/cases/ gehostet werden.

Wenn alle URLs in der Domain des Hostmusters abgeglichen werden sollen, lassen Sie pathPrefix leer.