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 eine Einwilligung vom Endnutzer angefordert werden soll, bevor ein Add-on-Endpunkt ausgeführt wird.

addOns

object (AddOns)

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

Konfiguration eines Google Workspace-Add-ons.

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 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 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 Sprachinformationen 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 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[]

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

array (ListValue format)

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.

LayoutProperties

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

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ä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

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

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.

HomepageExtensionPoint

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

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

string

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

enabled

boolean

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.

UniversalActionExtensionPoint

Format für die Deklaration eines Erweiterungspunkts für universelle Aktionsmenüelemente.

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

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)

Definiert einen Endpunkt, der in Kontexten ausgeführt wird, die keinem deklarierten kontextbezogenen Trigger entsprechen. 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.

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

contextualTriggers[]

object (ContextualTrigger)

Definiert die Gruppe von 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 Symbolleistenmenü des Add-ons universelle Aktionen aus.

composeTrigger

object (ComposeTrigger)

Definiert den Erstellungszeit-Trigger für ein Add-on zur Erstellungszeit. Das ist der Auslöser, der ein Add-on beim Verfassen einer E-Mail veranlasst. Alle Add-ons für die Erstellungszeit müssen den Geltungsbereich gmail.addons.current.action.compose haben, auch wenn der Entwurf dadurch möglicherweise nicht bearbeitet wird.

authorizationCheckFunction

string

Der Name eines Endpunkts, der durch Prüfen der Drittanbieter-APIs prüft, ob das Add-on alle erforderlichen Drittanbieterautorisierungen hat. Wenn der Test fehlschlägt, sollte die Funktion eine Ausnahme auslösen, um den Autorisierungsvorgang zu starten. Diese Funktion wird vor jedem Aufruf des Add-ons aufgerufen, um für eine reibungslose User Experience zu sorgen.

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, in der Regel, 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, die in Gmail verwendet werden, um das Add-on anzuzeigen. 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 E-Mail-Nachricht geöffnet wird.

UniversalAction

Eine Aktion, die unabhängig vom Nachrichtenkontext immer im Symbolleistenmenü des Add-ons verfügbar ist.

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 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 verfasst.

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

object (MenuItemExtensionPoint)

Definiert die Reihe von Aktionen für ein Add-on zum Zeitpunkt der Erstellung. Das sind Aktionen, die Nutzer bei einem Add-on beim Verfassen einer Nachricht auslösen können.

draftAccess

enum (DraftAccess)

Definiert die Ebene des Datenzugriffs, wenn ein Add-on für die Erstellungszeit ausgelöst wird.

DraftAccess

Ein Enum-Wert, der die Datenzugriffsebene definiert, die der Erstellungstrigger benötigt.

Enums
UNSPECIFIED Standardwert, wenn für draftaccess nichts festgelegt ist.
NONE Wenn ein Editor-Add-on ausgelöst wird, kann mit dem Trigger zum Schreiben nicht auf Daten des Entwurfs zugegriffen werden.
METADATA Gewährt dem Trigger zum Verfassen der Nachricht die Berechtigung, auf die Metadaten des Entwurfs zuzugreifen, wenn ein Add-on zum Schreiben ausgelöst wird. Dazu gehört auch die Zielgruppenliste, z. B. die Empfänger- und Cc-Listen eines Nachrichtenentwurfs.

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 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 von „Meine Ablage“.

DriveExtensionPoint

Häufiges Format für die Deklaration 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 ist.

CalendarAddOnManifest

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

JSON-Darstellung
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "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 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.

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

conferenceSolution[]

object (ConferenceSolution)

Definiert Konferenzlösungen, die von diesem Add-on bereitgestellt werden.

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.

currentEventAccess

enum (EventAccess)

Definiert die Ebene des Datenzugriffs, wenn ein Ereignis-Add-on ausgelöst wird.

ConferenceSolution

Definiert konferenzbezogene Werte.

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 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 aber 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

Häufiges Format für die Deklaration 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 ist.

EventAccess

Ein Enum, das die Ebene der Datenzugriffsereignisse definiert, die für Trigger erforderlich sind.

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

DocsAddOnManifest

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

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 Autorisierung für den Dateibereich für dieses Dokument/Nutzer-Paar gewährt wird.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

createActionTriggers[]

object (CreateActionExtensionPoint)

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

DocsExtensionPoint

Häufiges Format für die Deklaration 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 ist.

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.

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

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

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, 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.

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 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 (key: string, value: 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.

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

SheetsAddOnManifest

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

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 Autorisierung für den Dateibereich für dieses Dokument/Nutzer-Paar gewährt wird.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

Häufiges Format zum Deklarieren der Trigger eines Tabellen-Add-ons.

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

string

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

SlidesAddOnManifest

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

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 Autorisierung für den Dateibereich für dieses Dokument/Nutzer-Paar gewährt wird.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SlidesExtensionPoint

Häufiges Format für die Deklaration der Trigger eines Präsentationen-Add-ons.

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

string

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

HttpOptions

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

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

enum (HttpAuthorizationHeader)

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

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.

Methoden

create

Erstellt ein Deployment 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 zum Testen eine Bereitstellung in Ihrem Konto.

list

Listet alle Bereitstellungen in einem bestimmten Projekt auf.

replaceDeployment

Erstellt oder ersetzt eine Bereitstellung mit dem angegebenen Namen.

uninstall

Deinstalliert eine Testbereitstellung aus dem Konto des Nutzers.