Editor-Manifestressource

Die Ressourcenkonfiguration, die verwendet wird, um Inhalt und Verhalten von Google Workspace-Add-ons in den Editoren zu definieren. Google Workspace-Add‑on-Manifeste müssen alle Komponenten enthalten, die als Erforderlich gekennzeichnet sind, wenn sie den Editor erweitern.

Bearbeiter

Die Google Workspace-Add‑on-Manifestkonfiguration für Editorextensions. Weitere Informationen finden Sie unter Editoren mit Google Workspace-Add-ons erweitern.

JSON-Darstellung
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
Felder
homepageTrigger

object (HomepageTrigger)

Mit dieser Triggerfunktion wird die Startseite des Add-ons in der Hostanwendung erstellt. Dadurch wird addOns.common.homepageTrigger überschrieben.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Erforderlich, wenn Ihr Add-on ein Verhalten enthält, das spezifisch für das aktuelle Editor-Dokument ist und ausgelöst wird, wenn der Nutzer den drive.file -Bereich autorisiert.

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Für Linkvorschauen erforderlich. Eine Liste der Trigger für die Vorschau von Links in einer Google Docs-, Google Sheets- oder Google Präsentationen-Datei. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

createActionTriggers[]

object (createActionTriggers)

Für die Erstellung von Drittanbieterressourcen erforderlich. Eine Liste der Trigger zum Erstellen von Ressourcen in einem Drittanbieterdienst über das @-Menü. Weitere Informationen finden Sie unter Drittanbieterressourcen mit Smartchips erstellen.

OnFileScopeGrantedTrigger

Eine Konfiguration für einen kontextbezogenen Trigger, der ausgelöst wird, wenn das Dialogfeld für den Dateibereich mit CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); aufgerufen wird und der Nutzer die Autorisierung für den Bereich drive.file erteilt.

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

string

Der Name der Funktion, die ausgeführt werden soll, wenn der Bereich drive.file gewährt wird. Falls angegeben, müssen Sie diese Funktion implementieren, um ein Array von Card-Objekten zu erstellen und zurückzugeben, die in der Add-on-Benutzeroberfläche angezeigt werden sollen.

LinkPreviewTriggers

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 Datei in Google Docs, Google Sheets oder Google Präsentationen eingibt oder einfügt.

Informationen zum Einrichten dieses Triggers für ein Google Workspace-Add-on finden Sie unter Vorschaulinks mit Smartchips.

JSON-Darstellung
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
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 vorhanden ist, sieht er die lokalisierte Version von labelText.

patterns[]

object (UriPattern)

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

string

Erforderlich. Der Name der Funktion, die ausgeführt werden soll, wenn der Nutzer den https://www.googleapis.com/auth/workspace.linkpreview-Bereich autorisiert. Falls angegeben, müssen Sie diese Funktion implementieren, um ein Ereignisobjekt mit EDITOR_NAME.matchedUrl.url als Argument zu akzeptieren und ein einzelnes Card-Objekt zurückzugeben, in dem eine Linkvorschau in der Add-on-Benutzeroberfläche angezeigt 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 jede URL-Muster-Vorschau 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 eine Vorschau von Links für die gesamte Domain aufrufen 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, verwenden Sie cases, um URLs für Fälle abzugleichen, die unter support.example.com/cases/ gehostet werden.

Wenn alle URLs in der Domain des Hostmusters abgeglichen werden sollen, lassen Sie pathPrefix leer.

CreateActionTriggers

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer ein Menüelement für die Drittanbieterintegration aus dem @-Menü von Google Docs auswählt.

Informationen zum Einrichten dieses Triggers für ein Google Workspace-Add‑on finden Sie unter Drittanbieterressourcen mit Smart Chips 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 muss das Format [a-zA-Z0-9-]+. haben.
labelText

string

Erforderlich. Der Text, der im @-Menü angezeigt wird, z. B. Create support case.
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 vorhanden ist, sieht er die lokalisierte Version von labelText.

runFunction

string

Erforderlich. Der Name der Funktion, die ausgeführt werden soll, wenn ein Nutzer einen Erweiterungspunkt über das @-Menü auswählt. Die Funktion sollte eine Formular-Karte mit Eingaben zum Erstellen der Drittanbieterressource zurückgeben.
logoUrl

string

Optional. Das Symbol, das im @-Menü angezeigt wird. Wenn nichts angegeben ist, wird das Symbol des Add-ons in der Symbolleiste verwendet: logoUrl.