Editor-Manifestressource

Die Ressourcenkonfiguration, mit der der Inhalt 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

Manifestkonfiguration des Google Workspace-Add-ons für Editor-Erweiterungen 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)

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

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

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

linkPreviewTriggers[]

object (LinkPreviewTriggers)

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

createActionTriggers[]

object (createActionTriggers)

Erforderlich für die Erstellung von Drittanbieter-Ressourcen. 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 Umfang der Anfragedatei mit CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); verwendet wird und der Nutzer die Autorisierung für den Bereich 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 wurde. Wenn angegeben, müssen Sie diese Funktion implementieren, um ein Array von Card-Objekten zur Anzeige in der Add-on-UI zu erstellen und zurückzugeben.

LinkPreviewTriggers

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer einen Link von einem Drittanbieter- oder Nicht-Google-Dienst eingibt oder in eine Datei in Google Docs, Google Tabellen oder Google Präsentationen eingibt.

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, 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 Karte von labelText zur Lokalisierung in andere Sprachen. 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 vorhanden ist, sieht der Nutzer die lokalisierte Version von labelText.

patterns[]

object (UriPattern)

Erforderlich. Ein Array mit URL-Mustern, die das Add-on für die 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. Falls angegeben, müssen Sie diese Funktion implementieren, um ein Ereignisobjekt zu akzeptieren, das EDITOR_NAME.matchedUrl.url als Argument enthält, und ein einzelnes Card-Objekt zurückzugeben, das eine Linkvorschau in der Add-on-Benutzeroberfläche anzeigt.
logoUrl

string

Optional. Das Symbol, das auf dem Smartchip und der Vorschaukarte angezeigt wird. Wenn keine Angabe gemacht wird, verwendet das Add-on das Symbol in der Symbolleiste: 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 die Vorschau. Die Domain des URL-Musters. Das Add-on zeigt eine Vorschau der Links an, die diese Domain in der URL enthalten. Geben Sie die Subdomain an, um Vorschaulinks für eine bestimmte Subdomain wie subdomain.example.com aufzurufen. Wenn Sie Vorschaulinks für die gesamte Domain anzeigen lassen möchten, geben Sie ein Platzhalterzeichen mit einem Sternchen (*) als Subdomain ein.

Beispiel: *.example.com stimmt 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 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 übereinstimmen sollen, lassen Sie pathPrefix leer.

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 eines Drittanbieters auswählt.

Informationen zum Einrichten dieses Triggers für ein Google Workspace-Add-on finden Sie unter Drittanbieterressourcen 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 im @-Menü, z. B. Create support case.
localizedLabelText

map (key: string, value: string)

Optional. Eine Karte von labelText zur Lokalisierung in andere Sprachen. 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 vorhanden ist, sieht der Nutzer die lokalisierte Version von labelText.

runFunction

string

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

string

Optional. Das Symbol, das im @-Menü angezeigt wird. Wenn keine Angabe gemacht wird, verwendet das Add-on das Symbol in der Symbolleiste: logoUrl.