REST Resource: projects.deployments

Ressource: Bereitstellung

Bereitstellung eines Google Workspace-Add-ons

JSON-Darstellung 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Felder
name

string

Der Name der Bereitstellungsressource. Beispiel: projects/123/deployments/my_deployment.
oauthScopes[]

string

Die Liste der Google-OAuth-Bereiche, für die die Einwilligung vom Endnutzer angefordert werden soll, bevor ein Add-on-Endpunkt ausgeführt wird.
addOns

object (AddOns)

Die Konfiguration des Google Workspace-Add-ons.
etag

string

Dieser Wert wird vom Server basierend auf der Version der Bereitstellung im Speicher berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren einen aktuellen Wert hat.

AddOns

Eine Konfiguration für ein Google Workspace-Add-on.

JSON-Darstellung 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Felder
common

object (CommonAddOnManifest)

Konfiguration, die für alle Google Workspace-Add-ons gilt.
gmail

object (GmailAddOnManifest)

Konfiguration des Gmail-Add-ons.
drive

object (DriveAddOnManifest)

Konfiguration des Drive-Add-ons
calendar

object (CalendarAddOnManifest)

Konfiguration des Kalender-Add-ons
docs

object (DocsAddOnManifest)

Konfiguration des Docs-Add-ons.
sheets

object (SheetsAddOnManifest)

Konfiguration des Tabellen-Add-ons.
slides

object (SlidesAddOnManifest)

Konfiguration des Add-ons für Google Präsentationen
httpOptions

object (HttpOptions)

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

CommonAddOnManifest

Add-on-Konfiguration, die von allen Add-on-Hostanwendungen gemeinsam genutzt wird.

JSON-Darstellung 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
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

object (LayoutProperties)

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

object (AddOnWidgetSet)

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

boolean

Gibt an, ob Gebietsschemainformationen von der Host-App übergeben werden sollen.
homepageTrigger

object (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[]

object (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

array (ListValue format)

Für eine OpenLink-Aktion kann nur eine URL mit einem HTTPS-, MAILTO- oder TEL-Schema verwendet werden. Bei HTTPS-Links muss auch die URL 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.

LayoutProperties

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

JSON-Darstellung 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
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. Damit 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

boolean

Aktiviert Material Design für Karten.

AddOnWidgetSet

Die Widget-Untergruppe, die von einem Add-on verwendet wird.

JSON-Darstellung 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Felder
usedWidgets[]

enum (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 Das festgelegte Standard-Widget.
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.

HomepageExtensionPoint

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

JSON-Darstellung 
{
  "runFunction": string,
  "enabled": boolean
}
Felder
runFunction

string

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

boolean

Optional. Durch die Einstellung false wird die Startseitenansicht in diesem Kontext deaktiviert.

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

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

UniversalActionExtensionPoint

Format zum Deklarieren eines universellen Aktionsmenü-Erweiterungspunkts.

JSON-Darstellung 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
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.

GmailAddOnManifest

Eigenschaften, mit denen das Aussehen und die Ausführung eines Gmail-Add-ons angepasst werden kann.

JSON-Darstellung 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Felder
homepageTrigger

object (HomepageExtensionPoint)

Hiermit wird ein Endpunkt definiert, der in Kontexten ausgeführt wird, die nicht mit einem deklarierten kontextbezogenen Trigger übereinstimmen. Alle von dieser Funktion generierten Karten stehen dem Nutzer immer zur Verfügung, können jedoch durch kontextbezogenen Inhalt überlagert werden, wenn dieses Add-on gezieltere Trigger deklariert.

Falls vorhanden, wird damit die Konfiguration von addons.common.homepageTrigger überschrieben.
contextualTriggers[]

object (ContextualTrigger)

Hier werden die Bedingungen definiert, die das Add-on auslösen.
universalActions[]

object (UniversalAction)

Definiert eine Reihe universeller Aktionen für das Add-on. Der Nutzer löst universelle Aktionen über das Menü der Add-on-Symbolleiste aus.
composeTrigger

object (ComposeTrigger)

Definiert den Trigger zur Erstellungszeit für ein Add-on zur Erstellungszeit. Dieser Trigger bewirkt, dass ein Add-on eine Aktion ausführt, wenn der Nutzer eine E-Mail verfasst. Alle Add-ons zur Erstellungszeit müssen den Bereich gmail.addons.current.action.compose haben, auch wenn der Entwurf dadurch möglicherweise nicht bearbeitet wird.
authorizationCheckFunction

string

Der Name eines Endpunkts, der überprüft, ob das Add-on alle erforderlichen Autorisierungen von Drittanbietern hat, indem die APIs der Drittanbieter geprüft werden. Wenn die Prüfung fehlschlägt, sollte die Funktion eine Ausnahme auslösen, um den Autorisierungsablauf zu starten. Diese Funktion wird vor jedem Aufruf des Add-ons aufgerufen, um eine reibungslose Nutzererfahrung zu ermöglichen.

ContextualTrigger

Definiert einen Trigger, der ausgelöst wird, wenn die geöffnete E-Mail ein bestimmtes Kriterium erfüllt. Wenn der Trigger ausgelöst wird, wird ein bestimmter Endpunkt ausgeführt, in der Regel, um neue Karten zu erstellen und die Benutzeroberfläche zu aktualisieren.

JSON-Darstellung 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
Felder
onTriggerFunction

string

Erforderlich. Der Name des Endpunkts, der aufgerufen werden soll, wenn eine Nachricht mit dem Trigger übereinstimmt.
Union-Feld trigger. Der Triggertyp bestimmt die Bedingungen, unter denen das Add-on in Gmail angezeigt wird. Für trigger ist nur einer der folgenden Werte zulässig:
unconditional

object (UnconditionalTrigger)

Bedingungslose Trigger werden ausgeführt, wenn eine E-Mail-Nachricht geöffnet wird.

UnconditionalTrigger

Dieser Typ hat keine Felder.

Ein Trigger, der ausgelöst wird, wenn eine beliebige E-Mail-Nachricht geöffnet wird.

UniversalAction

Diese Aktion ist unabhängig vom Nachrichtenkontext immer in der Symbolleiste des Add-ons verfügbar.

JSON-Darstellung 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Felder
text

string

Erforderlich. Für Nutzer sichtbarer Text, der die Aktion beschreibt, z. B. „Neuen Kontakt hinzufügen“
Union-Feld action_type. Der Typ der Aktion bestimmt das Verhalten von Gmail, wenn der Nutzer die Aktion aufruft. Für action_type ist nur einer der folgenden Werte zulässig:
runFunction

string

Ein Endpunkt, der aufgerufen wird, wenn der Nutzer die Aktion auslöst. Weitere Informationen finden Sie im Leitfaden zu universellen Aktionen.

ComposeTrigger

Ein Trigger, der aktiviert wird, wenn ein Nutzer eine E-Mail schreibt.

JSON-Darstellung 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Felder
actions[]

object (MenuItemExtensionPoint)

Definiert die Aktionen für ein Add-on zur Erstellungszeit. Das sind Aktionen, die Nutzer für ein Editorzeit-Add-on auslösen können.
draftAccess

enum (DraftAccess)

Definiert die Zugriffsebene für den Datenzugriff, wenn ein Add-on zur Erstellungszeit ausgelöst wird.

DraftAccess

Ein Enum, das die Datenzugriffsebene definiert, die für den Zusammenstellungstrigger erforderlich ist.

Enums
UNSPECIFIED Standardwert, wenn nichts für den Zugriff auf den Entwurf festgelegt ist.
NONE Der Trigger „Schreiben“ kann nicht auf Daten des Entwurfs zugreifen, wenn das entsprechende Add-on ausgelöst wird.
METADATA Gewährt dem Trigger für die Erstellung die Berechtigung, auf die Metadaten des Entwurfs zuzugreifen, wenn ein Add-on für die Erstellung ausgelöst wird. Das gilt auch für die Zielgruppenliste, z. B. für die Empfänger- und Cc-Listen in einem Nachrichtenentwurf.

DriveAddOnManifest

Eigenschaften, mit denen das Aussehen und die Ausführung eines Drive-Add-ons angepasst werden kann.

JSON-Darstellung 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Felder
homepageTrigger

object (HomepageExtensionPoint)

Falls vorhanden, wird die Konfiguration aus addons.common.homepageTrigger überschrieben.
onItemsSelectedTrigger

object (DriveExtensionPoint)

Entspricht dem Verhalten, das ausgeführt wird, wenn Elemente in der entsprechenden Drive-Ansicht ausgewählt werden, z. B. die Dokumentliste „Meine Ablage“.

DriveExtensionPoint

Gängiges Format zum Deklarieren der Trigger eines Drive-Add-ons.

JSON-Darstellung 
{
  "runFunction": string
}
Felder
runFunction

string

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

CalendarAddOnManifest

Eigenschaften zum Anpassen der Darstellung und Ausführung eines Kalender-Add-ons.

JSON-Darstellung 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Felder
homepageTrigger

object (HomepageExtensionPoint)

Definiert einen Endpunkt, der in Kontexten ausgeführt wird, die keinem deklarierten kontextbezogenen Trigger entsprechen. Alle mit dieser Funktion generierten Karten stehen dem Nutzer immer zur Verfügung. Sie können jedoch von kontextbezogenen Inhalten überlagert werden, wenn dieses Add-on gezieltere Trigger deklariert.

Falls vorhanden, wird damit die Konfiguration von addons.common.homepageTrigger überschrieben.
conferenceSolution[]

object (ConferenceSolution)

Hier werden die Konferenzlösungen dieses Add-ons definiert. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.
createSettingsUrlFunction

string

Ein Endpunkt, der eine URL zur Seite mit den Einstellungen des Add-ons erstellt.
eventOpenTrigger

object (CalendarExtensionPoint)

Ein Endpunkt, der ausgelöst wird, wenn ein Ereignis zum Ansehen oder Bearbeiten geöffnet wird.
eventUpdateTrigger

object (CalendarExtensionPoint)

Ein Endpunkt, der ausgelöst wird, wenn das Ereignis „open“ aktualisiert wird.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Eine Konfiguration für einen kontextbezogenen Trigger, der ausgelöst wird, wenn der Nutzer im Drop-down-Menü von Google Kalender auf den Anbieter von Add-on-Anhängen klickt.
currentEventAccess

enum (EventAccess)

Hier wird die Datenzugriffsebene festgelegt, wenn ein Ereignis-Add-on ausgelöst wird.

ConferenceSolution

Definiert auf Konferenzen bezogene Werte. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.

JSON-Darstellung 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Felder
onCreateFunction

string

Erforderlich. Der Endpunkt, der aufgerufen werden soll, wenn Konferenzdaten erstellt werden sollen.
id

string

Erforderlich. IDs müssen innerhalb eines Add-ons eindeutig für Konferenzlösungen zugewiesen werden. Andernfalls wird beim Auslösen des Add-ons möglicherweise die falsche Konferenzlösung verwendet. Sie können zwar den Anzeigenamen eines Add-ons ändern, die ID sollte jedoch nicht geändert werden.
name

string

Erforderlich. Der Anzeigename der Konferenzlösung.
logoUrl

string

Erforderlich. Die URL für das Logobild der Konferenzlösung.

CalendarExtensionPoint

Gängiges Format für die Deklaration von Auslösern für ein Kalender-Add-on.

JSON-Darstellung 
{
  "runFunction": string
}
Felder
runFunction

string

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

EventAccess

Ein Enum-Wert, der die Ebene der Datenzugriffsereignistrigger definiert, die erforderlich sind.

Enums
UNSPECIFIED Standardwert, wenn für „eventAccess“ nichts festgelegt ist.
METADATA Gewährt Ereignis-Triggern die Berechtigung, auf die Metadaten von Terminen zuzugreifen, z. B. Termin-ID und Kalender-ID.
READ Gewährt Ereignistriggern Zugriff auf alle bereitgestellten Ereignisfelder, einschließlich Metadaten, Teilnehmern und Konferenzdaten.
WRITE Gewährt Ereignistriggern Zugriff auf die Metadaten von Ereignissen und die Möglichkeit, alle Aktionen auszuführen, einschließlich des Hinzufügens von Teilnehmern und Festlegen von Konferenzdaten.
READ_WRITE Gewährt Ereignistriggern Zugriff auf alle bereitgestellten Ereignisfelder, einschließlich der Metadaten, Teilnehmer und Konferenzdaten, sowie die Möglichkeit, alle Aktionen auszuführen.

DocsAddOnManifest

Eigenschaften zum Anpassen der Darstellung und Ausführung eines Add-ons für Google Docs.

JSON-Darstellung 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Felder
homepageTrigger

object (HomepageExtensionPoint)

Falls vorhanden, wird damit die Konfiguration von addons.common.homepageTrigger überschrieben.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Endpunkt, der ausgeführt werden soll, wenn die Dateibereichsautorisierung für dieses Dokument/Nutzer-Paar gewährt wird.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Eine Liste von Erweiterungspunkten für die Vorschau von Links in einem Google Docs-Dokument. Weitere Informationen finden Sie im Hilfeartikel Vorschaulinks mit Smartchips.
createActionTriggers[]

object (CreateActionExtensionPoint)

Eine Liste von Erweiterungspunkten zum Erstellen von Drittanbieterressourcen in Google Workspace-Anwendungen. Weitere Informationen finden Sie unter Ressourcen von Drittanbietern über das @-Menü erstellen.

DocsExtensionPoint

Gängiges Format für die Deklaration von Auslösern für ein Docs-Add-on.

JSON-Darstellung 
{
  "runFunction": string
}
Felder
runFunction

string

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

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.

JSON-Darstellung 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
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 (key: string, value: 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.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
patterns[]

object (UriPattern)

Erforderlich. Eine Reihe von URL-Mustern, die das Add-on zum Anzeigen von Linkvorschauen 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 Sie das Feld leer lassen, wird das Symbol des Add-ons in der Symbolleiste (logourl) verwendet.

UriPattern

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

JSON-Darstellung 
{
  "hostPattern": string,
  "pathPrefix": string
}
Felder
hostPattern

string

Erforderlich für jedes URL-Muster, das in der Vorschau angezeigt werden soll. Die Domain des URL-Musters. Das Add-on zeigt eine Vorschau von Links an, die diese Domain in der URL enthalten. Geben Sie auch die Subdomain an, um Vorschaulinks für eine bestimmte Subdomain wie subdomain.example.com anzuzeigen. 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.

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

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.

JSON-Darstellung 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
Felder
id

string

Erforderlich. Die eindeutige ID zur Unterscheidung dieses Erweiterungspunkts. 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 (key: string, value: 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.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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 Symbol, das für den Einstiegspunkt zur Ressourcenerstellung angezeigt wird. Wenn Sie das Feld auslassen, wird das Symbol logourl der Symbolleiste des Add-ons für das Menü verwendet.

SheetsAddOnManifest

Eigenschaften zum Anpassen der Darstellung und Ausführung eines Google Tabellen-Add-ons.

JSON-Darstellung 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Felder
homepageTrigger

object (HomepageExtensionPoint)

Falls vorhanden, wird damit die Konfiguration von addons.common.homepageTrigger überschrieben.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Endpunkt, der ausgeführt werden soll, wenn die Dateibereichsautorisierung für dieses Dokument/Nutzer-Paar gewährt wird.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Eine Liste von Erweiterungspunkten für die Vorschau von Links in einem Google Tabellendokument. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

SheetsExtensionPoint

Gängiges Format für die Deklaration von Triggern für ein Google Tabellen-Add-on.

JSON-Darstellung 
{
  "runFunction": string
}
Felder
runFunction

string

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

SlidesAddOnManifest

Eigenschaften, mit denen das Erscheinungsbild und die Ausführung eines Google Präsentationen-Add-ons angepasst werden kann.

JSON-Darstellung 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Felder
homepageTrigger

object (HomepageExtensionPoint)

Falls vorhanden, wird damit die Konfiguration von addons.common.homepageTrigger überschrieben.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Endpunkt, der ausgeführt werden soll, wenn die Dateibereichsautorisierung für dieses Dokument/Nutzer-Paar gewährt wird.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Eine Liste von Erweiterungspunkten für die Vorschau von Links in einem Google Präsentationen-Dokument. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

SlidesExtensionPoint

Gängiges Format zum Deklarieren der Trigger eines Add-ons für Google Präsentationen.

JSON-Darstellung 
{
  "runFunction": string
}
Felder
runFunction

string

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

HttpOptions

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

JSON-Darstellung 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
Felder
authorizationHeader

enum (HttpAuthorizationHeader)

Konfiguration für das im Autorisierungsheader HTTP gesendete Token.

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

Methoden

create

 Erstellt eine Bereitstellung mit dem angegebenen Namen und der angegebenen Konfiguration.

delete

 Löscht die Bereitstellung mit dem angegebenen Namen.

get

 Ruft die Bereitstellung mit dem angegebenen Namen ab.

getInstallStatus

 Ruft den Installationsstatus einer Testbereitstellung ab.

install

 Hiermit wird eine Bereitstellung zum Testen in Ihrem Konto installiert.

list

 Listet alle Bereitstellungen in einem bestimmten Projekt auf.

replaceDeployment

 Erstellt oder ersetzt eine Bereitstellung mit dem angegebenen Namen.

uninstall

 Eine Testimplementierung wird aus dem Konto des Nutzers deinstalliert.