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 Deployment-Ressource. Beispiel: projects/123/deployments/my_deployment.
oauthScopes[]

string

Die Liste der Google-OAuth-Bereiche, für die die Einwilligung des Endnutzers eingeholt werden muss, 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)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "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 von Gmail-Add-ons
drive

object (DriveAddOnManifest)

Konfiguration von Drive-Add‑ons.
calendar

object (CalendarAddOnManifest)

Konfiguration des Kalender-Add-ons
docs

object (DocsAddOnManifest)

Konfiguration von Docs-Add‑ons.
meet

object (MeetAddOnManifest)

Konfiguration des Meet-Add‑ons.
sheets

object (SheetsAddOnManifest)

Konfiguration von Sheets-Add‑ons.
slides

object (SlidesAddOnManifest)

Konfiguration des Präsentationen-Add‑ons
httpOptions

object (HttpOptions)

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

CommonAddOnManifest

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

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 Layoutattribute 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 Gebietsschema-Informationen 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 immer für den Nutzer verfügbar, können aber von kontextbezogenen Inhalten überschattet 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 dienen. Der Erweiterungspunkt kann eine Link-URL zum Öffnen oder ein Endpunkt sein, der als Formulareinsendung ausgeführt werden soll.
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 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.

LayoutProperties

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

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

boolean

Aktiviert das Material Design für Karten.

AddOnWidgetSet

Die von einem Add‑on verwendete Teilmenge von Widgets.

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

HomepageExtensionPoint

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

UniversalActionExtensionPoint

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

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

GmailAddOnManifest

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

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 sind immer für den Nutzer verfügbar, können aber von kontextbezogenen Inhalten überschattet werden, wenn dieses Add-on gezieltere Trigger deklariert.

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

object (ContextualTrigger)

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

object (UniversalAction)

Definiert eine Reihe von universellen 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 Compose-Zeit-Trigger für ein Compose-Zeit-Add-on. Dieser Trigger bewirkt, dass ein Add-on aktiv wird, wenn der Nutzer eine E-Mail verfasst. Alle Add-ons für die Erstellungszeit müssen den Bereich gmail.addons.current.action.compose haben, auch wenn der Entwurf dadurch nicht bearbeitet wird.
authorizationCheckFunction

string

Der Name eines Endpunkts, der durch Abfragen der Drittanbieter-APIs überprüft, ob das Add‑on alle erforderlichen Drittanbieter-Autorisierungen hat. Wenn der Test 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 gewährleisten.

ContextualTrigger

Definiert einen Trigger, der ausgelöst wird, wenn die geöffnete E‑Mail bestimmte Kriterien 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 dem Trigger entspricht.
Union-Feld trigger. Der Typ des Triggers 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)

Unbedingte Trigger werden ausgeführt, wenn eine E-Mail 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 Menü der Add‑on-Symbolleiste 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, 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 verfasst.

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

object (MenuItemExtensionPoint)

Definiert die Reihe von Aktionen für ein Compose-Add-on. Das sind Aktionen, die Nutzer in einem Add-on für die Erstellungszeit 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, das die Ebene des Datenzugriffs definiert, die für den Compose-Trigger erforderlich ist.

Enums
UNSPECIFIED Standardwert, wenn für „draftaccess“ nichts festgelegt ist.
NONE Der Compose-Trigger kann nicht auf Daten des Entwurfs zugreifen, wenn ein Compose-Add-on ausgelöst wird.
METADATA Gibt dem Compose-Trigger die Berechtigung, auf die Metadaten des Entwurfs zuzugreifen, wenn ein Compose-Add-on ausgelöst wird. Dazu gehört die Empfängerliste, z. B. die Liste der Empfänger und Cc-Empfänger einer Nachricht.

DriveAddOnManifest

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

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

DriveExtensionPoint

Häufig verwendetes 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, mit denen die Darstellung und Ausführung eines Kalender-Add‑ons angepasst werden.

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 sind immer für den Nutzer verfügbar, können aber von kontextbezogenen Inhalten überschattet werden, wenn dieses Add-on gezieltere Trigger deklariert.

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

object (ConferenceSolution)

Definiert die von diesem Add-on bereitgestellten Konferenzlösungen. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.
createSettingsUrlFunction

string

Ein 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ü von Google Kalender auf den Add-on-Anbieter klickt.
currentEventAccess

enum (EventAccess)

Definiert die Zugriffsebene für Daten, wenn ein Event-Add-on ausgelöst wird.

ConferenceSolution

Definiert konferenzbezogene 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 sollten innerhalb eines Add-ons eindeutig für alle Konferenzlösungen zugewiesen werden. Andernfalls wird möglicherweise die falsche Konferenzlösung verwendet, wenn das Add-on ausgelöst wird. Sie können den Anzeigenamen eines Add-ons ändern, die ID sollte jedoch nicht geändert werden.
name

string

Erforderlich. Der Anzeigename der Videokonferenzlö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

Eine Enumeration, die die Ebene des Datenzugriffs definiert, die für Ereignistrigger erforderlich ist.

Enums
UNSPECIFIED Standardwert, wenn nichts für „eventAccess“ festgelegt ist.
METADATA Ereignistrigger erhalten die Berechtigung, auf die Metadaten von Ereignissen zuzugreifen, z. B. auf die Ereignis-ID und die Kalender-ID.
READ Ermöglicht Ereignistriggern den Zugriff auf alle bereitgestellten Ereignisfelder, einschließlich der Metadaten, Teilnehmer und Konferenzdaten.
WRITE Ereignistrigger erhalten Zugriff auf die Metadaten von Ereignissen und können alle Aktionen ausführen, einschließlich des Hinzufügens von Teilnehmern und des Festlegens von Konferenzdaten.
READ_WRITE Ereignistrigger erhalten Zugriff auf alle bereitgestellten Ereignisfelder, einschließlich der Metadaten, Teilnehmer und Konferenzdaten, und können alle Aktionen ausführen.

DocsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

Endpunkt, der ausgeführt werden soll, wenn die Autorisierung für den Dateibereich für dieses Dokument-/Nutzerpaar gewährt wird.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

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

DocsExtensionPoint

Gängiges Format zum Deklarieren der Trigger eines Google 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 Drittanbieterdienst oder einem Nicht-Google-Dienst in eine Google Docs-, Google Sheets- 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, 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 (key: string, value: 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.

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

UriPattern

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

JSON-Darstellung 
{
  "hostPattern": string,
  "pathPrefix": string
}
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.

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.

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

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

MeetAddOnManifest

Manifest für Meet-Add-ons

JSON-Darstellung 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Felder
homepageTrigger

object (HomepageExtensionPoint)

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

object (Web)

Details zu Add-ons, die den Meet-Webclient verbessern.
supportsCollaboration

boolean

Ob das Add-on die Zusammenarbeit oder das Einladen anderer in das Add-on unterstützt.
termsUri

string

Ein Link zu den Nutzungsbedingungen für das Add-on, falls vorhanden.

Web

Details zu Add-ons, die den Meet-Webclient verbessern.

JSON-Darstellung 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
Felder
sidePanelUri
(deprecated)

string

Der URI für das Seitenleisten-iFrame.
sidePanelUrl

string

Die URL für den iFrame der Seitenleiste.
mainStageUri
(deprecated)

string

Der URI für den iFrame der „Hauptbühne“.
supportsScreenSharing

boolean

Gibt an, ob das Add-on die Bildschirmfreigabe auf der Hauptbühne unterstützt.
supportsCollaboration
(deprecated)

boolean

Ob das Add-on die Zusammenarbeit oder das Einladen anderer in das Add-on unterstützt. Dieses Feld wurde eingestellt. Verwenden Sie stattdessen das Feld der obersten Ebene in MeetAddOnManifest.
supportsPopOut

boolean

Gibt an, ob das Add-on die Pop-out-Funktion in einem Browser-Bild-im-Bild-Fenster unterstützt.
hostOrigins[]
(deprecated)

string

Veralteter Legacy-Name. Ursprünge, die dem Attribut „frame-src“ des iFrames mit der Website des Drittanbieters hinzugefügt werden sollen. Verwenden Sie stattdessen „addonorigins“.
addOnOrigins[]

string

Ursprünge, die dem Attribut „frame-src“ des iFrames mit der Website des Drittanbieters hinzugefügt werden sollen.
openState

enum (State)

Der ursprüngliche Status beim Öffnen des Add-ons.
supportsCollaborationHostControls

boolean

Gibt an, ob das Add-on für die Zusammenarbeit Steuerelemente für Organisatoren unterstützt.
logoUrl

string

Die URL des Logos, das für das Add-on angezeigt werden soll. Wenn nichts angegeben ist, wird standardmäßig das Logo im gemeinsamen Abschnitt des Manifests verwendet.
darkModeLogoUrl

string

Eine Version der logourl für den dunklen Modus.
displayFlow
(deprecated)

enum (DisplayFlow)

Der Displayablauf, dem das Add-on beim Start folgt.

Status

Enum zum Angeben des anfänglichen Öffnungsstatus des Add-ons.

Enums
STATE_UNSPECIFIED Der Anfangsstatus wurde für das Add-on nicht angegeben.
SIDE_PANEL_ONLY Das Add‑on wird geöffnet und nur die Seitenleiste ist aktiv.
MAIN_STAGE_ONLY Das Add-on wird geöffnet und nur der Hauptbereich ist aktiv.
SIDE_PANEL_AND_MAIN_STAGE Das Add-on wird geöffnet, wobei sowohl die Seitenleiste als auch der Hauptbereich aktiv sind.

DisplayFlow

Enumeration zur Angabe des Anzeigeflusses, dem das Add-on beim Start folgt

Enums
DISPLAY_FLOW_UNSPECIFIED Der Display-Ablauf wurde nicht angegeben.
FOCUS Das Add-on sollte im Display-Ablauf „Fokus“ gestartet werden.
AUGMENT Das Add-on sollte im Display-Ablauf „Erweitern“ gestartet werden.

SheetsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

Endpunkt, der ausgeführt werden soll, wenn die Autorisierung für den Dateibereich für dieses Dokument-/Nutzerpaar gewährt wird.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

Gängiges Format zum Deklarieren der Trigger eines Google Sheets-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 des Erscheinungsbilds und der Ausführung eines Google-Präsentationen-Add-ons.

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

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

Endpunkt, der ausgeführt werden soll, wenn die Autorisierung für den Dateibereich für dieses Dokument-/Nutzerpaar gewährt wird.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Eine Liste der Erweiterungspunkte 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 Google-Präsentationen-Add-ons.

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 HTTP-Add-on-Endpunkte.

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

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

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

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.

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.

Methoden

create

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

delete

 Löscht das Deployment mit dem angegebenen Namen.

get

 Ruft die Bereitstellung mit dem angegebenen Namen ab.

getInstallStatus

 Ruft den Installationsstatus einer Testbereitstellung ab.

install

 Installiert ein Deployment in Ihrem Konto zum Testen.

list

 Listet alle Deployments in einem bestimmten Projekt auf.

replaceDeployment

 Erstellt oder ersetzt ein Deployment mit dem angegebenen Namen.

uninstall

 Deinstalliert eine Testbereitstellung aus dem Konto des Nutzers.