Editor-Manifestressource

Die Ressourcenkonfiguration, mit der Inhalte und das Verhalten des Google Workspace-Add-ons in den Editoren definiert werden. In den Manifesten des Google Workspace-Add-ons müssen alle Komponenten als Erforderlich gekennzeichnet sein, wenn sie den Editor erweitern.

Bearbeiter

Die Manifestkonfiguration des Google Workspace-Add-ons für Editor-Erweiterungen. Weitere Informationen finden Sie unter Bearbeiter mit Google Workspace-Add-ons erweitern.

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

object (HomepageTrigger)

Diese Triggerfunktion erstellt die Add-on-Startseite in der Host-App. Dadurch wird addOns.common.homepageTrigger überschrieben.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Erforderlich, wenn das Add-on ein Verhalten aufweist, das für das aktuelle Editordokument spezifisch ist; wird ausgelöst, wenn der Nutzer den Bereich drive.file autorisiert.

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Erforderlich für Linkvorschauen. Eine Liste von Triggern für die Vorschau von Links in einer Google Docs-, Google Tabellen- oder Google Präsentationen-Datei. Weitere Informationen finden Sie im Hilfeartikel Vorschaulinks mit Smartchips.

createActionTriggers[]

object (createActionTriggers)

Erforderlich für das Erstellen von Drittanbieter-Ressourcen. Eine Liste von Triggern zum Erstellen von Ressourcen in einem Drittanbieterdienst über das @-Menü. Weitere Informationen finden Sie im Hilfeartikel Ressourcen von Drittanbietern mit Smartchips erstellen.

OnFileScopeGrantedTrigger

Eine Konfiguration für einen kontextbezogenen Trigger, der ausgelöst wird, wenn das Dialogfeld für den Zugriffsbereich der Anfrage mit CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); verwendet wird und der Nutzer die Bereichsautorisierung drive.file gewährt.

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

string

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

LinkPreviewTriggers

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 dort 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 zur Vorschau des Links auffordert, 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 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 er die lokalisierte Version von labelText.

patterns[]

object (UriPattern)

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

string

Erforderlich. Der Name der Funktion, die ausgeführt werden soll, wenn der Nutzer den Bereich https://www.googleapis.com/auth/workspace.linkpreview autorisiert. Wenn Sie diese Funktion angeben, müssen Sie sie so implementieren, dass ein Ereignisobjekt mit EDITOR_NAME.matchedUrl.url als Argument akzeptiert und ein einzelnes Card-Objekt zurückgegeben wird, das eine Linkvorschau in der Add-on-UI anzeigt.
logoUrl

string

Optional. Das auf dem Smartchip und der Vorschaukarte angezeigte Symbol. Wenn keine Angabe gemacht wird, 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 die Vorschau. 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.

Beispielsweise stimmt *.example.com 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 ist, verwenden Sie cases, um URLs für Fälle abzugleichen, die unter support.example.com/cases/ gehostet werden.

Lassen Sie pathPrefix leer, um alle URLs in der Hostmusterdomain abzugleichen.

CreateActionTriggers

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer im @-Menü von Google Docs einen Menüpunkt für die Integration von Drittanbietern auswählt.

Informationen zum Einrichten dieses Triggers für ein Google Workspace-Add-on finden Sie unter Ressourcen von Drittanbietern mit Smartchips 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 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 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 er die lokalisierte Version von labelText.

runFunction

string

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

string

Optional. Das im @-Menü angezeigte Symbol. Wenn keine Angabe gemacht wird, wird für das Add-on das Symbolleistensymbol logoUrl verwendet.