Package google.apps.script.type

Index

AddOnWidgetSet

Die von einem Add-on verwendete Widget-Teilmenge.

Felder
usedWidgets[]

WidgetType

Liste der in einem Add-on verwendeten Widgets.

WidgetType

Der Widget-Typ. WIDGET_TYPE_UNSPECIFIED ist die Basis-Widget-Gruppe.

Enums
WIDGET_TYPE_UNSPECIFIED Der Standard-Widget-Satz.
DATE_PICKER Die Datumsauswahl.
STYLED_BUTTONS Zu den Schaltflächen gehören gefü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 Add-on-Symbolleiste angezeigt wird.
layoutProperties

LayoutProperties

Allgemeine Layouteigenschaften für die Add-on-Karten
addOnWidgetSet

AddOnWidgetSet

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

bool

Gibt an, ob Informationen zur Sprache und Region aus 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

Definiert eine Liste von Erweiterungspunkten im universellen Aktionsmenü, die 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 auslässt, wird von HTTPS ausgegangen. HTTP-Links werden automatisch in HTTPS-Links umgeschrieben.

CreateActionExtensionPoint

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer den Workflow zur Ressourcenerstellung 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 kann bis zu 64 Zeichen lang sein und muss 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 in ISO 639 und das Land/die Region in ISO 3166, 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 von Ressourcen ausgelöst wird, um einen Link zu erstellen.
logoUrl

string

Optional. Das für den Einstiegspunkt für die Ressourcenerstellung angezeigte Symbol. Wenn keine Angabe gemacht wird, wird das Symbol des Add-ons in der Symbolleiste (logoUrl) im Menü verwendet.

HomepageExtensionPoint

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

Felder
runFunction

string

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

BoolValue

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

Wenn kein Wert festgelegt ist, wird die Standardeinstellung „true“ verwendet.

Wenn die benutzerdefinierte Startseite eines Add-ons deaktiviert ist, wird den 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 Keinen Authentication-Header senden.

HttpOptions

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

Felder
authorizationHeader

HttpAuthorizationHeader

Konfiguration für das im Autorisierungsheader HTTP gesendete Token.

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 Material Design 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 in ISO 639 und das Land/die Region in ISO 3166, 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. Ein Array von URL-Mustern, die das Add-on zur Vorschau von Links auslösen.
runFunction

string

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

string

Optional. Das auf dem Smartchip und der Vorschaukarte angezeigte Symbol. Wenn keine Angabe gemacht wird, wird das Symbol für das Add-on 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 werden soll, wenn dieser Erweiterungspunkt aktiviert wird.
label

string

Erforderlich. Für Nutzer sichtbarer Text, der die Aktion beschreibt, die beim Aktivieren dieses Erweiterungspunkts durchgeführt wurde. z. B. „Rechnung einfügen“.
logoUrl

string

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

Wenn nichts festgelegt ist, wird standardmäßig die primäre Logo-URL 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. Dies kann entweder ein zu öffnender Link oder ein auszuführender Endpunkt sein. Für action_type ist nur einer der folgenden Werte zulässig:
runFunction

string

Endpunkt, der von 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 für 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 sich Vorschaulinks für die gesamte Domain ansehen möchten, geben Sie als Subdomain ein Platzhalterzeichen mit einem Sternchen (*) ein.

*.example.com stimmt beispielsweise mit subdomain.example.com und another.subdomain.example.com überein.
pathPrefix

string

Optional. Der Pfad, der die Domain von hostPattern anhängt.

Wenn das URL-Hostmuster beispielsweise support.example.com lautet, geben Sie cases ein, um URLs für Fälle zu ermitteln, die unter support.example.com/cases/ gehostet werden.

Lassen Sie pathPrefix leer, um alle URLs in der Hostmusterdomain abzugleichen.