REST Resource: projects.deployments

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

string

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

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.

object (AddOns)

Die Konfiguration des Google Workspace-Add-ons.

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.

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

object (CommonAddOnManifest)

Konfiguration, die für alle Google Workspace-Add-ons gleich ist.

object (GmailAddOnManifest)

Konfiguration des Gmail-Add-ons.

object (DriveAddOnManifest)

Konfiguration des Drive-Add-ons.

object (CalendarAddOnManifest)

Konfiguration des Kalender-Add-ons.

object (DocsAddOnManifest)

Konfiguration des Docs-Add-ons.

object (SheetsAddOnManifest)

Konfiguration des Tabellen-Add-ons.

object (SlidesAddOnManifest)

Konfiguration des Präsentationen-Add-ons.

object (HttpOptions)

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

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

Erforderlich. Der Anzeigename des Add-ons.

string

Erforderlich. Die URL für das Logobild, das in der Add-on-Symbolleiste angezeigt wird.

object (LayoutProperties)

Allgemeine Layouteigenschaften für die Add-on-Karten

object (AddOnWidgetSet)

Die im Add-on verwendeten Widgets. Wenn dieses Feld nicht angegeben ist, wird der Standardsatz verwendet.

boolean

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

object (HomepageExtensionPoint)

Definiert einen Endpunkt, der in jedem Kontext und auf jedem Host ausgeführt wird. 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.

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.

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.

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

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.

string

Die sekundäre Farbe des Add-ons. Damit wird die Farbe der Schaltflächen festgelegt. Wenn die Hauptfarbe festgelegt ist, aber keine Sekundärfarbe, 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.

boolean

Aktiviert Material Design für Karten.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

Die Liste der in einem Add-on verwendeten Widgets.

{
  "runFunction": string,
  "enabled": boolean
}

string

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

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.

{
  "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.
}

string

Erforderlich. Für den Nutzer sichtbarer Text, der die Aktion beschreibt, die beim Aktivieren dieses Erweiterungspunkts ausgeführt wird, z. B. „Neuen Kontakt hinzufügen“.

string

URL, die von UniversalAction geöffnet werden soll.

string

Endpunkt, der von UniversalAction ausgeführt werden soll.

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

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 dadurch die Konfiguration von addons.common.homepageTrigger überschrieben.

object (ContextualTrigger)

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

object (UniversalAction)

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

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.

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.

{
  "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.
}

string

Erforderlich. Der Name des Endpunkts, der aufgerufen werden soll, wenn eine Nachricht mit dem Trigger übereinstimmt.

object (UnconditionalTrigger)

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

{
  "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.
}

string

Erforderlich. Für den Nutzer sichtbarer Text zur Beschreibung der Aktion, z. B. „Neuen Kontakt hinzufügen“.

string

Ein Link, der in Gmail geöffnet wird, wenn der Nutzer die Aktion auslöst.

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

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.

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

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

string

Erforderlich. Für Nutzer sichtbarer Text, der die Aktion beschreibt, die beim Aktivieren dieses Erweiterungspunkts durchgeführt wurde. z. B. „Rechnung einfügen“.

string

Die URL für das Logobild, das in der Add-on-Symbolleiste angezeigt wird.

Wenn nichts anderes festgelegt ist, wird standardmäßig die primäre Logo-URL des Add-ons verwendet.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

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

{
  "runFunction": string
}

string

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

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

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.

object (ConferenceSolution)

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

string

Ein auszuführender Endpunkt, der eine URL zur Einstellungsseite des Add-ons erstellt.

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

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.

enum (EventAccess)

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

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

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

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.

string

Erforderlich. Der Anzeigename der Konferenzlösung.

string

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

{
  "runFunction": string
}

string

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

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

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

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

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.

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.

{
  "runFunction": string
}

string

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

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

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.

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

object (UriPattern)

Erforderlich. Ein Array von URL-Mustern, die das Add-on zur Vorschau von Links auslösen.

string

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

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.

{
  "hostPattern": string,
  "pathPrefix": string
}

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.

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.

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

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.

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.

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

string

Erforderlich. Endpunkt, der ausgeführt wird, wenn ein Workflow zur Ressourcenerstellung zum Erstellen einer Verknüpfung ausgelöst wird.

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.

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

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

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

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.

{
  "runFunction": string
}

string

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

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

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

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

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.

{
  "runFunction": string
}

string

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

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

Konfiguration für das im Autorisierungsheader HTTP gesendete Token.