REST Resource: projects.deployments

Ressource: Deployment

Eine Google Workspace-Add-on-Bereitstellung

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 anhand der Version des Deployments 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 Google Workspace-Add-on-Konfiguration.

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

object (MeetAddOnManifest)

Konfiguration des Meet-Add-ons.
sheets

object (SheetsAddOnManifest)

Konfiguration des 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 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 der Standardsatz verwendet.
useLocaleFromApp

boolean

Gibt an, ob Informationen zur Spracheinstellung 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 durch kontextbezogene Inhalte verdeckt werden, wenn dieses Add-on gezieltere Trigger deklariert.
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 zum Öffnen oder ein Endpunkt zum Ausführen als Formulareinreichung sein.
openLinkUrlPrefixes

array (ListValue format)

Eine OpenLink-Aktion kann nur eine URL mit einem HTTPS-, MAILTO- oder TEL-Schema verwenden. Bei HTTPS-Links muss die URL außerdem mit einem der in der Zulassungsliste angegebenen Präfixe übereinstimmen. Wenn das Präfix das Schema weglässt, wird HTTPS angenommen. HTTP-Links werden automatisch in HTTPS-Links umgeschrieben.

LayoutProperties

Eigenschaften des Kartenlayouts, die von allen Hostanwendungen des Add-ons gemeinsam genutzt werden.

JSON-Darstellung 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Felder
primaryColor

string

Die Primärfarbe 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äre Farbe des Add-ons. Damit wird die Farbe von Schaltflächen festgelegt. Wenn die Hauptfarbe festgelegt ist, aber keine sekundäre Farbe, ist die sekundäre Farbe mit der Hauptfarbe identisch. Wenn weder die Primär- noch die Sekundärfarbe festgelegt ist, wird der vom Framework bereitgestellte Standardwert verwendet.
useNewMaterialDesign
(deprecated)

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 Widgets, die in einem Add-on verwendet werden.

WidgetType

Der Widget-Typ. WIDGET_TYPE_UNSPECIFIED ist das grundlegende Widget-Set.

Enums
WIDGET_TYPE_UNSPECIFIED Der Standard-Widget-Satz.
DATE_PICKER Datumsauswahl
STYLED_BUTTONS Zu den formatierten Schaltflächen gehören Schaltflächen mit Füllung 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 Nachrichten des 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 die Richtlinie auf false festgelegt ist, wird die Startseitenansicht in diesem Kontext deaktiviert.

Wenn keine Angabe gemacht wird, ist der Standardwert true.

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

UniversalActionExtensionPoint

Format zum Deklarieren eines Erweiterungspunkts für einen universellen Aktionsmenüpunkt.

JSON-Darstellung 
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
Felder
label

string

Erforderlich. Für Nutzer sichtbarer Text, der die Aktion beschreibt, die durch Aktivieren dieses Erweiterungspunkts ausgeführt wird, z. B. „Neuen Kontakt hinzufügen“.
Erforderlich. Der Aktionstyp, der für einen universellen Aktionsmenüpunkt unterstützt wird. Das kann entweder ein Link zum Öffnen oder ein Endpunkt zum Ausführen sein. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
runFunction

string

Endpunkt, der von der UniversalAction ausgeführt werden soll.
Ende der sich gegenseitig ausschließenden Felder.

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 durch kontextbezogene Inhalte verdeckt 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 Trigger für ein Add-on, das beim Verfassen von Nachrichten ausgeführt wird. Dies ist der Trigger, der ein Add-on dazu veranlasst, eine Aktion auszuführen, wenn der Nutzer eine E-Mail verfasst. Alle Add-ons für die E-Mail-Erstellung müssen den Bereich gmail.addons.current.action.compose haben, auch wenn sie den Entwurf möglicherweise nicht bearbeiten.
authorizationCheckFunction

string

Der Name eines Endpunkts, der durch Abfragen der Drittanbieter-APIs prüft, ob das Add-on alle erforderlichen Drittanbieter-Autorisierungen hat. 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 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, wird ein bestimmter Endpunkt ausgeführt, in der Regel, um neue Karten zu erstellen und die Benutzeroberfläche zu aktualisieren.

JSON-Darstellung 
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Felder
onTriggerFunction

string

Erforderlich. Der Name des Endpunkts, der aufgerufen werden soll, wenn eine Nachricht mit dem Trigger übereinstimmt.
Der Triggertyp bestimmt die Bedingungen, unter denen das Add-on in Gmail angezeigt wird. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
unconditional

object (UnconditionalTrigger)

Bedingungslose Trigger werden ausgeführt, wenn eine beliebige E-Mail-Nachricht geöffnet wird.
Ende der sich gegenseitig ausschließenden Felder.

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,

  "openLink": string,
  "runFunction": string
}
Felder
text

string

Erforderlich. Für Nutzer sichtbarer Text, der die Aktion beschreibt, z. B. „Neuen Kontakt hinzufügen“.
Der Typ der Aktion bestimmt das Verhalten von Gmail, wenn der Nutzer die Aktion aufruft. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
runFunction

string

Ein Endpunkt, der aufgerufen wird, wenn der Nutzer die Aktion auslöst. Weitere Informationen finden Sie im Leitfaden zu universellen Aktionen.
Ende der sich gegenseitig ausschließenden Felder.

ComposeTrigger

Ein Trigger, der aktiviert wird, wenn der Nutzer eine E‑Mail verfasst.

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

object (MenuItemExtensionPoint)

Definiert die Aktionen für ein Add-on, das beim Verfassen von Nachrichten verwendet wird. Dies sind Aktionen, die Nutzer in einem Add-on für die E-Mail-Erstellung auslösen können.
draftAccess

enum (DraftAccess)

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

DraftAccess

Ein Enum, das die Ebene des Datenzugriffs definiert, die der Erstellungstrigger benötigt.

Enums
UNSPECIFIED Standardwert, wenn für „draftaccess“ nichts festgelegt ist.
NONE Der Trigger für das Verfassen kann nicht auf Daten des Entwurfs zugreifen, wenn ein Add-on für das Verfassen ausgelöst wird.
METADATA Gibt dem Erstellungstrigger die Berechtigung, auf die Metadaten des Entwurfs zuzugreifen, wenn ein Erstellungs-Add-on ausgelöst wird. Dazu gehört die Zielgruppenliste, z. B. die „An“- und „Cc“-Liste eines Nachrichtenentwurfs.

DriveAddOnManifest

Eigenschaften, mit denen Sie das Erscheinungsbild und die Ausführung eines Drive-Add-ons anpassen können.

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

DriveExtensionPoint

Allgemeines 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 Sie das Erscheinungsbild und die Ausführung eines Kalender-Add‑ons anpassen können.

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

object (HomepageExtensionPoint)

Optional. 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 durch kontextbezogene Inhalte verdeckt werden, wenn dieses Add-on gezieltere Trigger deklariert.

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

object (ConferenceSolution)

Optional. 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 Termin zum Ansehen oder Bearbeiten geöffnet wird.
eventUpdateTrigger

object (CalendarExtensionPoint)

Ein Endpunkt, der ausgelöst wird, wenn das offene Ereignis aktualisiert wird.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Optional. Wird ausgelöst, wenn ein Termin für einen Kalender erstellt oder aktualisiert wird, den der Nutzer abonniert hat. Gilt nur für Trigger, die von HTTP endpoints mit CalendarSubscriptionActionMarkup erstellt wurden.

Um rekursive Benachrichtigungsschleifen zu verhindern, unterdrückt die Plattform Änderungsbenachrichtigungen, wenn ein Add-on einen Google Kalender-Termin mithilfe der Calendar API mit Authentifizierungsdaten aus demselben Google Cloud-Projekt ändert, in dem das Add-on bereitgestellt wird. Das selbstständige Auslösen von Calendar API-Aufrufen Ihres eigenen Projekts wird nicht unterstützt.

Nicht zutreffend für Apps Script add-ons und Apps Script installable triggers.
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 des Add-on-Anhangs klickt.
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 jede Konferenzlösung 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

Allgemeines 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, das die Ebene des Datenzugriffs definiert, die Ereignisauslöser erfordern.

Enums
UNSPECIFIED Standardwert, wenn für „eventAccess“ nichts festgelegt ist.
METADATA Ereignistrigger erhalten die Berechtigung, auf die Metadaten von Ereignissen zuzugreifen, z. B. Ereignis-ID und Kalender-ID.
READ Ermöglicht Ereignistriggern den Zugriff auf alle bereitgestellten Ereignisfelder, einschließlich 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 Metadaten, Teilnehmer und Konferenzdaten, und können alle Aktionen ausführen.

DocsAddOnManifest

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

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 von 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 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 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 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, 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. Eine Zuordnung von labeltext, die in andere Sprachen lokalisiert werden soll. Formatieren Sie die Sprache gemäß ISO 639 und das Land bzw. die Region gemäß ISO 3166, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn das Gebietsschema eines Nutzers in den Schlüsseln der Zuordnung vorhanden ist, sieht er die lokalisierte Version des 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 veranlassen, eine Vorschau von Links anzuzeigen.
runFunction

string

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

string

Optional. Das Symbol, das im Smartchip und auf der Vorschaukarte angezeigt wird. Wenn Sie nichts angeben, wird das Symbol der Symbolleiste des Add-ons verwendet, logourl.

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 von Links an, die diese Domain in der URL enthalten. Wenn Sie eine Vorschau von Links für eine bestimmte Subdomain wie subdomain.example.com sehen möchten, geben Sie die Subdomain an. Wenn Sie eine Vorschau der Links für die gesamte Domain sehen 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, geben Sie cases ein, um URLs für Fälle abzugleichen, die unter support.example.com/cases/ gehostet werden.

Wenn alle URLs in der Hostmuster-Domain 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 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 darf maximal 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 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 Zuordnung von labeltext, die in andere Sprachen lokalisiert werden soll. Formatieren Sie die Sprache gemäß ISO 639 und das Land bzw. die Region gemäß ISO 3166, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn das Gebietsschema eines Nutzers in den Schlüsseln der Zuordnung vorhanden ist, sieht er die lokalisierte Version des 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 ausgelöst wird, um einen Link zu erstellen.
logoUrl

string

Optional. Das Symbol, das für den Einstiegspunkt zur Ressourcenerstellung angezeigt wird. Wenn Sie nichts angeben, wird das Symbol für die Symbolleiste des Add-ons (logourl) verwendet.

MeetAddOnManifest

Manifest für Meet-Add-on.

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

boolean

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

string

Ein Link zu den Nutzungsbedingungen für das Add-on, falls diese angezeigt werden sollen.

Web

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

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 den iFrame der Seitenleiste.
sidePanelUrl

string

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

string

Der URI für den iFrame „Hauptphase“.
supportsScreenSharing

boolean

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

boolean

Ob das Add-on die Zusammenarbeit oder das Einladen anderer Personen in das Add-on unterstützt. Dieses Feld ist jetzt veraltet. Verwenden Sie stattdessen das Feld auf oberster Ebene in „MeetAddOnManifest“.
supportsPopOut

boolean

Gibt an, ob das Add-on die Wiedergabe im Bild-im-Bild-Modus des Browsers unterstützt.
hostOrigins[]
(deprecated)

string

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

string

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

enum (State)

Der Anfangszustand, wenn das Add-on geöffnet wird.
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 allgemeinen Bereich des Manifests verwendet.
darkModeLogoUrl

string

Eine Version der Logo-URL im dunklen Modus.
displayFlow
(deprecated)

enum (DisplayFlow)

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

Bundesland

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

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

DisplayFlow

Enum zur Angabe des Anzeigeablaufs, dem das Add-on beim Start folgt

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

SheetsAddOnManifest

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

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

object (LinkPreviewExtensionPoint)

Eine Liste der Erweiterungspunkte für die Vorschau von Links in einem Google Sheets-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, mit denen Sie das Erscheinungsbild und die Ausführung eines Google Präsentationen-Add-ons anpassen können.

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 von Erweiterungspunkten für die Vorschau von Links in einer Google-Präsentation. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

SlidesExtensionPoint

Gängiges Format zum Deklarieren 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 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 Autorisierungsheader HTTP gesendet wird.
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

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

HttpAuthorizationHeader

Autorisierungsheader, der in HTTP-Anfragen des Add-ons 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 (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 Das Add-on ist für die detaillierte OAuth-Zustimmung aktiviert.
OPT_OUT Für das Add-on ist die detaillierte OAuth-Zustimmung deaktiviert.

Methoden

create

 Erstellt ein Deployment mit dem angegebenen Namen und der angegebenen Konfiguration.

delete

 Löscht die Bereitstellung mit dem angegebenen Namen.

get

 Ruft das Deployment mit dem angegebenen Namen ab.

getInstallStatus

 Ruft den Installationsstatus einer Testbereitstellung ab.

install

 Installiert ein Deployment zu Testzwecken in Ihrem Konto.

list

 Listet alle Bereitstellungen in einem bestimmten Projekt auf.

replaceDeployment

 Erstellt oder ersetzt ein Deployment mit dem angegebenen Namen.

uninstall

 Deinstalliert eine Testbereitstellung aus dem Konto des Nutzers.