Package google.apps.script.type

Index

AddOnWidgetSet

Die von einem Add-on verwendete Widget-Teilmenge.

Felder
usedWidgets[]

WidgetType

Die Liste der in einem Add-on verwendeten Widgets.

WidgetType

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

Enums
WIDGET_TYPE_UNSPECIFIED Das festgelegte Standard-Widget.
DATE_PICKER Die Datumsauswahl
STYLED_BUTTONS Schaltflächen mit benutzerdefinierten Stilen umfassen ausgefüllte und deaktivierte Schaltflächen.
PERSISTENT_FORMS Persistente Formulare ermöglichen das Speichern von Formularwerten während Aktionen.
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 für die Benutzeroberfläche zum Schreiben von Add-ons gilt.

CommonAddOnManifest

Add-on-Konfiguration, die von allen Add-on-Hostanwendungen gemeinsam genutzt 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 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 Sprachinformationen 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 für den Nutzer immer verfügbar, werden aber möglicherweise durch kontextbezogene Inhalte überlagert, wenn in diesem Add-on gezieltere Trigger deklariert werden.
universalActions[]

UniversalActionExtensionPoint

Definiert eine Liste von Erweiterungspunkten im universellen Aktionsmenü, das als Einstellungsmenü für das Add-on dient. Der Erweiterungspunkt kann eine Link-URL sein, die geöffnet werden soll, oder ein Endpunkt, um ein Formular zu senden.
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 Präfixe übereinstimmen, die in der Zulassungsliste angegeben sind. Wenn das Präfix das Schema auslässt, wird HTTPS angenommen. HTTP-Links werden automatisch in HTTPS-Links umgewandelt.

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 Ressourcen von Drittanbietern über das @-Menü erstellen.

Felder
id

string

Erforderlich. Die eindeutige ID zur Unterscheidung dieses Erweiterungspunkts. Die ID kann bis zu 64 Zeichen umfassen und muss 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. Karte von labelText zur Lokalisierung in andere Sprachen. Formatiere die Sprache in ISO 639 und das Land/die Region in ISO 3166, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn die Sprache eines Nutzers in den Schlüsseln der Karte vorhanden ist, sieht der Nutzer die lokalisierte Version von labelText.
runFunction

string

Erforderlich. Endpunkt, der ausgeführt werden soll, wenn ein Workflow zur Ressourcenerstellung zum Erstellen einer Verknüpfung ausgelöst wird.
logoUrl

string

Optional. Das angezeigte Symbol für den Einstiegspunkt für die Ressourcenerstellung. Wenn Sie diese Option nicht angeben, wird im Menü das Symbol in der Symbolleiste des Add-ons verwendet: logoUrl.

HomepageExtensionPoint

Übliches Format für die Anzeige der Startseite von Add-ons.

Felder
runFunction

string

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

BoolValue

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

Wenn kein Wert festgelegt wird, wird der Standardwert true verwendet.

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

HttpAuthorizationHeader

In HTTP-Add-on-Anfragen wurde ein Autorisierungsheader gesendet.

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 (Standardeinstellung).
USER_ID_TOKEN Senden Sie ein ID-Token für den Endnutzer.
NONE Keinen Authentifizierungs-Header senden.

HttpOptions

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

Felder
authorizationHeader

HttpAuthorizationHeader

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

LayoutProperties

Eigenschaften des Kartenlayouts, die für alle Add-on-Hostanwendungen gelten.

Felder
primaryColor

string

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

string

Die Sekundärfarbe des Add-ons. Sie legt die Farbe von Schaltflächen fest. Wenn die Hauptfarbe festgelegt, aber keine sekundäre Farbe festgelegt ist, entspricht die sekundäre Farbe der Hauptfarbe. Wenn weder eine primäre noch eine sekundäre Farbe festgelegt ist, wird der vom Framework bereitgestellte Standardwert verwendet.
useNewMaterialDesign

bool

Aktiviert Material Design für Karten.

LinkPreviewExtensionPoint

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

Felder
labelText

string

Erforderlich. Text für einen Beispiel-Smartchip, der Nutzer auffordert, sich eine Vorschau des Links 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. Karte von labelText zur Lokalisierung in andere Sprachen. Formatiere die Sprache in ISO 639 und das Land/die Region in ISO 3166, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn die Sprache eines Nutzers in den Schlüsseln der Karte vorhanden ist, sieht der Nutzer die lokalisierte Version von labelText.
patterns[]

UriPattern

Erforderlich. Ein Array mit URL-Mustern, die das Add-on auslösen, um Vorschaulinks anzuzeigen.
runFunction

string

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

string

Optional. Das Symbol, das auf dem Smartchip und der Vorschaukarte angezeigt wird. Wenn Sie diese Option nicht angeben, wird für das Add-on das Symbolleistensymbol logoUrl verwendet.

Häufiges 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 ist.
label

string

Erforderlich. Für den 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 Add-on-Symbolleiste 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 Aktionsmenüelemente.

Felder
label

string

Erforderlich. Für den Nutzer sichtbarer Text, der die Aktion beschreibt, die durch die Aktivierung dieses Erweiterungspunkts ausgeführt wird, z. B. „Neuen Kontakt hinzufügen“.
Union-Feld action_type. Erforderlich. Der Aktionstyp, der von einem Element des universellen Aktionsmenüs unterstützt wird Es 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 jedes URL-Muster, für das eine Vorschau angezeigt werden soll. Die Domain des URL-Musters. Das Add-on zeigt eine Vorschau der Links an, die diese Domain in der URL enthalten. Um Links für eine bestimmte Subdomain, z. B. subdomain.example.com, in der Vorschau anzuzeigen, fügen Sie die Subdomain hinzu. Wenn Sie Vorschaulinks für die gesamte Domain sehen möchten, geben Sie ein Platzhalterzeichen mit einem Sternchen (*) als Subdomain an.

Beispiel: *.example.com stimmt 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 abzugleichen, die unter support.example.com/cases/ gehostet werden.

Wenn alle URLs in der Domain des Hostmusters übereinstimmen sollen, lassen Sie pathPrefix leer.