Package google.apps.script.type

Index

AddOnWidgetSet

Die von einem Add‑on verwendete Teilmenge von Widgets.

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-Widgetsatz.
DATE_PICKER Die Datumsauswahl
STYLED_BUTTONS Zu den formatierten Schaltflächen gehören gefüllte und deaktivierte Schaltflächen.
PERSISTENT_FORMS Bei persistenten Formularen bleiben Formularwerte während Aktionen erhalten.
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 Add-ons angewendet wird.

CommonAddOnManifest

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

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 Layoutattribute für 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 Gebietsschema-Informationen von der Host-App übergeben werden sollen.
homepageTrigger

HomepageExtensionPoint

Definiert einen Endpunkt, der in jedem Kontext und auf jedem Host ausgeführt wird. Alle von dieser Funktion generierten Karten sind immer für den Nutzer verfügbar, können aber von kontextbezogenen Inhalten überschattet 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 dienen. Der Erweiterungspunkt kann eine Link-URL zum Öffnen oder ein Endpunkt sein, der als Formulareinsendung ausgeführt werden soll.
openLinkUrlPrefixes

ListValue

Für eine OpenLink-Aktion kann nur eine URL mit dem Schema HTTPS, MAILTO oder TEL verwendet werden. Bei HTTPS-Links muss die URL auch mit einem der in der Zulassungsliste angegebenen Präfixe übereinstimmen. Wird das Schema im Präfix weggelassen, 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 zur Ressourcenerstellung in einer Google Workspace-Anwendung aufruft. Weitere Informationen finden Sie unter Drittanbieterressourcen über das @-Menü erstellen.

Felder
id

string

Erforderlich. Die eindeutige ID zur Unterscheidung dieses Erweiterungspunkts. Die ID darf bis zu 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 für die 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 Map von labelText, die in andere Sprachen lokalisiert werden soll. Formatieren Sie die Sprache gemäß ISO 639 und das Land/die Region gemäß ISO 3166. Trennen Sie die beiden Angaben 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 von 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 für die Ressourcenerstellung angezeigt wird. Wenn kein Wert angegeben ist, wird das Symbol für die Symbolleiste des Add-ons verwendet: logoUrl.

GranularOauthPermissionSupport

Gibt an, ob für das Add-on die detaillierte OAuth-Zustimmung aktiviert ist.

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Standardwert, sollte nicht verwendet werden.
OPT_IN Für das Add‑on ist die detaillierte OAuth-Einwilligung aktiviert.
OPT_OUT Für das Add-on wurde die detaillierte OAuth-Zustimmung deaktiviert.

HomepageExtensionPoint

Gängiges Format zum Deklarieren 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 der Wert auf false gesetzt ist, wird die Startseitenansicht in diesem Kontext deaktiviert.

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

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

HttpAuthorizationHeader

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

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Standardwert, entspricht SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Senden Sie ein ID-Token für das systemspezifische Dienstkonto des 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-Add-on-Endpunkte.

Felder
authorizationHeader

HttpAuthorizationHeader

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

GranularOauthPermissionSupport

Gibt an, ob für das Add-on die detaillierte OAuth-Zustimmung aktiviert ist.

LayoutProperties

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

Felder
primaryColor

string

Die primäre Farbe des Add-ons. Damit wird die Farbe der Symbolleiste festgelegt. Wenn keine Primärfarbe festgelegt ist, wird der Standardwert des Frameworks verwendet.
secondaryColor

string

Die sekundäre Farbe des Add-ons. Damit wird die Farbe von Schaltflächen festgelegt. Wenn die Primärfarbe festgelegt ist, aber keine Sekundärfarbe, ist die Sekundärfarbe dieselbe wie die Primärfarbe. Wenn weder die primäre noch die sekundäre Farbe festgelegt ist, wird der vom Framework bereitgestellte Standardwert verwendet.
useNewMaterialDesign
(deprecated)

bool

Aktiviert das Material Design für Karten.

LinkPreviewExtensionPoint

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer einen Link von einem Drittanbieterdienst oder einem Nicht-Google-Dienst in eine Google Docs-, Google Sheets- oder Google Präsentationen-Datei eingibt oder einfügt.

Felder
labelText

string

Erforderlich. Der Text für einen Beispiel-Smartchip, der Nutzer auffordert, den Link in der Vorschau anzusehen, 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 Map von labelText, die in andere Sprachen lokalisiert werden soll. Formatieren Sie die Sprache gemäß ISO 639 und das Land/die Region gemäß ISO 3166. Trennen Sie die beiden Angaben 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 von labelText.
patterns[]

UriPattern

Erforderlich. Ein Array von URL-Mustern, die die Vorschau von Links durch das Add-on auslösen.
runFunction

string

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

string

Optional. Das Symbol, das im Smart-Chip und auf der Vorschaukarte angezeigt wird. Wenn nichts angegeben ist, wird das Symbol des Add-ons in der Symbolleiste verwendet: logoUrl.

Gängiges Format zum Deklarieren eines Menüelements 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 durch die Aktivierung dieses Erweiterungspunkts ausgeführt wird. Beispiel: „Insert invoice.“ (Füge die Rechnung ein.)
logoUrl

string

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

Wenn nichts anderes festgelegt ist, wird standardmäßig die URL des primären Logos des Add-ons verwendet.

UniversalActionExtensionPoint

Format zum Deklarieren eines Erweiterungspunkts für ein universelles Aktionsmenüelement.

Felder
label

string

Erforderlich. Für den Nutzer sichtbarer Text, der die durch die Aktivierung dieses Erweiterungspunkts ausgeführte Aktion beschreibt, z. B. „Neuen Kontakt hinzufügen“.
Union-Feld action_type. Erforderlich. Der Aktionstyp, der für ein universelles Aktionsmenüelement unterstützt wird. Das kann entweder ein Link zum Öffnen oder ein Endpunkt zum Ausführen sein. 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

Für jedes URL-Muster, das in der Vorschau angezeigt werden soll, ist ein Wert erforderlich. Die Domain des URL-Musters. Das Add-on zeigt eine Vorschau von Links an, die diese Domain in der URL enthalten. Wenn Sie Vorschaulinks für eine bestimmte Subdomain wie subdomain.example.com sehen möchten, geben Sie die Subdomain an. Wenn Sie Links für die gesamte Domain in der Vorschau ansehen möchten, geben Sie ein Platzhalterzeichen mit einem Sternchen (*) als Subdomain an.

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

string

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

Wenn das URL-Hostmuster beispielsweise support.example.com lautet und Sie URLs für Fälle abgleichen möchten, die unter support.example.com/cases/ gehostet werden, geben Sie cases ein.

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