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 über einen aktuellen Wert verfügt, bevor er fortfahren kann.

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 gleich ist.
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 Präsentationen-Add-ons.
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 Add-on-Symbolleiste 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 der Standardsatz 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 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.
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 sein, die geöffnet werden soll, oder ein Endpunkt, der als Formular gesendet werden soll.
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 auslässt, wird von HTTPS ausgegangen. HTTP-Links werden automatisch in HTTPS-Links umgeschrieben.

LayoutProperties

Kartenlayouteigenschaften, die von allen Add-on-Host-Anwendungen gemeinsam genutzt werden.

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 Hauptfarbe festgelegt, aber keine Sekundärfarbe festgelegt wurde, ist die Sekundärfarbe mit der Hauptfarbe 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 von einem Add-on verwendete Widget-Teilmenge.

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 die Basis-Widget-Gruppe.

Enums
WIDGET_TYPE_UNSPECIFIED Das festgelegte Standard-Widget.
DATE_PICKER 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 für die UI zum Schreiben von Add-ons gilt.

HomepageExtensionPoint

Gängiges Format zum Deklarieren der Startseite 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.

Wird kein Wert festgelegt, ist die Standardeinstellung true.

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 den Nutzer sichtbarer Text, der die beim Aktivieren dieses Erweiterungspunkts durchgeführte Aktion beschreibt, z. B. „Neuen Kontakt hinzufügen“.
Union-Feld action_type. Erforderlich. Der bei einem universellen Aktionsmenü unterstützten Aktionstyp. 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.

GmailAddOnManifest

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

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

object (HomepageExtensionPoint)

Definiert einen Endpunkt, 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)

Definiert die Bedingungen, die das Add-on auslösen.
universalActions[]

object (UniversalAction)

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

object (ComposeTrigger)

Definiert den Trigger zur Erstellungszeit für ein Add-on zur Erstellungszeit. Das ist der Trigger, durch den ein Add-on Aktionen ausführt, wenn der Nutzer eine E-Mail schreibt. 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, mit dem durch Prüfen der Drittanbieter-APIs bestätigt wird, dass das Add-on alle erforderlichen Drittanbieterautorisierungen hat. Wenn die Prüfung fehlschlägt, sollte die Funktion eine Ausnahme auslösen, um den Autorisierungsvorgang zu initiieren. Diese Funktion wird vor jedem Aufruf des Add-ons aufgerufen, um eine reibungslose Nutzung zu gewährleisten.

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, führt er einen bestimmten Endpunkt aus, normalerweise um neue Karten zu erstellen und die UI 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 beliebige 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 den Nutzer sichtbarer Text zur Beschreibung der Aktion, 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 Add-on zur Erstellungszeit auslösen können.
draftAccess

enum (DraftAccess)

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

DraftAccess

Ein Enum-Wert, der die Datenzugriffsebene definiert, die der Erstellungstrigger erfordert.

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 Erstellungs-Trigger die Berechtigung, auf die Metadaten des Entwurfs zuzugreifen, wenn ein Editor-Add-on 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 zum Anpassen der Darstellung und Ausführung eines Drive-Add-ons.

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

object (HomepageExtensionPoint)

Falls vorhanden, wird damit die Konfiguration von 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 nicht mit einem deklarierten kontextbezogenen Trigger übereinstimmen. Alle von 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 dadurch die Konfiguration von addons.common.homepageTrigger überschrieben.
conferenceSolution[]

object (ConferenceSolution)

Definiert die von diesem Add-on bereitgestellten Konferenzlösungen.
createSettingsUrlFunction

string

Ein auszuführender Endpunkt, der eine URL zur Einstellungsseite 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ü „Kalender“ auf den Anbieter des Add-on-Anhangs klickt.
currentEventAccess

enum (EventAccess)

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

ConferenceSolution

Definiert auf Konferenzen bezogene Werte.

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

string

Erforderlich. Der aufzurufende Endpunkt, wenn Konferenzdaten erstellt werden sollen.
id

string

Erforderlich. IDs sollten innerhalb eines Add-ons für alle Konferenzlösungen eindeutig 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 zum Deklarieren der Trigger eines Kalender-Add-ons.

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 Ressourcen von Drittanbietern in Google Workspace-Anwendungen. Weitere Informationen finden Sie unter Ressourcen von Drittanbietern über das @-Menü erstellen.

DocsExtensionPoint

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

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

string

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

LinkPreviewExtensionPoint

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer einen Link von einem Drittanbieter- oder Drittanbieterdienst eingibt oder in eine Google Docs-, Google Tabellen- oder Google Präsentationen-Datei 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 dazu auffordert, eine Vorschau des Links anzuzeigen, 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 die Sprache eines Nutzers in den Schlüsseln der Karte enthalten ist, sieht der Nutzer die lokalisierte Version von labeltext.

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

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

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 für 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 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.

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.

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 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 (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 die Sprache eines Nutzers in den Schlüsseln der Karte enthalten ist, sieht der Nutzer die lokalisierte Version von 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 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 keine Angabe gemacht wird, wird das Symbol des Add-ons in der Symbolleiste (logourl) im 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 Tabellen-Dokument. Weitere Informationen finden Sie im Hilfeartikel Vorschaulinks mit Smartchips.

SheetsExtensionPoint

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

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

string

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

SlidesAddOnManifest

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

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 im Hilfeartikel 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 in HTTP-Anfragen des Add-ons 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 Authentication-Header senden.

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

 Installiert eine Bereitstellung zum Testen in Ihrem Konto.

list

 Listet alle Bereitstellungen in einem bestimmten Projekt auf.

replaceDeployment

 Erstellt oder ersetzt eine Bereitstellung mit dem angegebenen Namen.

uninstall

 Eine Testbereitstellung wird aus dem Nutzerkonto deinstalliert.