Editor-Manifestressource

Die Ressourcenkonfiguration, mit der die Inhalte und das Verhalten des Google Workspace-Add-ons in den Editoren definiert werden. In Manifesten von 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 Editorerweiterungen. 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 Host-App erstellt. Dadurch wird addOns.common.homepageTrigger überschrieben.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Erforderlich, wenn Ihr Add-on ein spezifisches Verhalten für das aktuelle Editordokument enthält, das ausgelöst wird, 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 Sheets- oder Google Präsentationen-Datei. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

createActionTriggers[]

object (createActionTriggers)

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

OnFileScopeGrantedTrigger

Eine Konfiguration für einen kontextbezogenen Trigger, der ausgelöst wird, wenn das Dialogfeld zum Anfordern des Dateibereichs mit CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); geöffnet 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 wird. Wenn 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.

LinkPreviewTriggers

Die Konfiguration eines Triggers, der ausgelöst wird, wenn ein Nutzer einen Link von einem Drittanbieter oder einem anderen Dienst in eine Google Docs-, Google Tabellen- oder Google Präsentationen-Datei eingibt oder einfügt.

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

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, die in andere Sprachen lokalisiert werden soll. Formatieren Sie die Sprache im ISO 639-Format und das Land/die Region im ISO 3166-Format, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn das Gebietsschema eines Nutzers in den Schlüsseln der Karte enthalten ist, sieht der Nutzer die lokalisierte Version der labelText.

patterns[]

object (UriPattern)

Erforderlich. Eine Reihe von URL-Mustern, die das Add-on zum Anzeigen von Linkvorschauen auslösen.
runFunction

string

Erforderlich. Der Name der Funktion, die ausgeführt wird, wenn der Nutzer den Umfang https://www.googleapis.com/auth/workspace.linkpreview autorisiert. Wenn angegeben, müssen Sie diese Funktion implementieren, um ein Ereignisobjekt mit EDITOR_NAME.matchedUrl.url als Argument anzunehmen und ein einzelnes Card-Objekt zurückzugeben, das eine Linkvorschau in der Add-on-Benutzeroberfläche anzeigt.
logoUrl

string

Optional. Das Symbol, das im Smartchip und auf der Vorschaukarte angezeigt wird. Wenn das Feld leer bleibt, wird das Symbol des Add-ons in der Symbolleiste (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 die Vorschau jedes URL-Musters.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 für 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 anzeigen lassen möchten, geben Sie als Subdomain ein Platzhalterzeichen mit einem Sternchen (*) an.

Beispiel: *.example.com führt zu Übereinstimmungen mit subdomain.example.com und another.subdomain.example.com.

pathPrefix

string

Optional. Der Pfad, an den die Domain der hostPattern angehängt wird.

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.

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

CreateActionTriggers

Die Konfiguration eines Triggers, der ausgelöst wird, wenn ein Nutzer im Dreistrich-Menü von Google Docs einen Menüpunkt für eine Drittanbieterintegration 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, um diesen Erweiterungspunkt zu unterscheiden. Die ID darf maximal 64 Zeichen lang sein und sollte 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 im ISO 639-Format und das Land/die Region im ISO 3166-Format, getrennt durch einen Bindestrich -. Zum Beispiel: en-US.

Wenn das Gebietsschema eines Nutzers in den Schlüsseln der Karte enthalten ist, sieht der Nutzer die lokalisierte Version der labelText.

runFunction

string

Erforderlich. Der Name der Funktion, die ausgeführt wird, 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 Symbol, das im @-Menü angezeigt wird. Wenn das Feld leer bleibt, wird das Symbol des Add-ons in der Symbolleiste (logoUrl) verwendet.