Manifestdatei des Editors

Die Ressourcenkonfiguration, mit der die Inhalte und das Verhalten des Google Workspace-Add-ons in den Editoren definiert werden. Wenn Sie den Editor erweitern, müssen bei allen Google Workspace-Add-on-Manifesten alle Komponenten als erforderlich gekennzeichnet sein.

Bearbeiter

Die 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)
      }
    ]
  }
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 Ihr Add-on Verhalten speziell für das aktuelle Editor-Dokument enthält, das ausgelöst wird, wenn der Nutzer den Bereich drive.file autorisiert.

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Erforderlich für die Linkvorschau. Eine Liste der Trigger für die Vorschau von Links in einem Google Docs-Dokument. Weitere Informationen finden Sie im Hilfeartikel Vorschaulinks in Google Docs (Entwicklervorschau).

OnFileScopeGrantedTrigger

Eine Konfiguration für einen kontextabhängigen Trigger, der ausgelöst wird, wenn das Dialogfeld für den Anfragedateibereich mit CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); aufgerufen wird und der Nutzer drive.file die Autorisierung des Bereichs 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 für die Anzeige in der Add-on-UI zu erstellen und zurückzugeben.

LinkVorschau-Trigger

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn ein Nutzer einen Link aus einem Drittanbieter- oder Drittanbieterdienst in ein Google Docs-Dokument eingibt oder einfügt.

Informationen zum Einrichten dieses Triggers für ein Google Workspace-Add-on finden Sie unter Vorschaulinks in Google Docs (Entwicklervorschau).

JSON-Darstellung 
{
  "labelText": string,
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Felder
labelText

string

Erforderlich. Der Text für einen Smartchipbeispiel, in dem Nutzer aufgefordert werden, 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

Optional. Eine Karte von labelText zur Lokalisierung in anderen Sprachen. Formatieren Sie die Sprache gemäß ISO 639 und das Land bzw. 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. Wenn angegeben, müssen Sie diese Funktion implementieren, um ein Ereignisobjekt mit docs.matchedUrl.url als Argument zu akzeptieren und ein einzelnes Card-Objekt zurückzugeben, das eine Linkvorschau in der Add-on-UI anzeigt.
logoUrl

string

Optional. Das Symbol, das auf dem Smartchip angezeigt wird Wenn es nicht angegeben ist, verwendet der Chip das Symbolleistensymbol Ihres Add-ons logoUrl.

Uri-Muster

Die Konfiguration für jedes URL-Muster, das eine Linkvorschau auslöst.

JSON-Darstellung 
{
  "hostPattern": string,
  "pathPrefix" : string
}
Felder
hostPattern

string

Für jedes URL-Muster in der Vorschau erforderlich: Domain des URL-Musters. Das Add-on zeigt Links zu dieser Domain in der URL als Vorschau an. Wenn Sie eine Vorschau der Links für eine bestimmte Subdomain wie subdomain.example.com ansehen möchten, müssen Sie sie einfügen. Wenn Sie Links in der gesamten Domain als Vorschau ansehen möchten, geben Sie ein Platzhalterzeichen mit einem Sternchen (*) als Subdomain an.

Beispiel: *.example.com entspricht subdomain.example.com und another.subdomain.example.com.
pathPrefix

string

Optional. Der Pfad, der die Domain von hostPattern anhängt.

Wenn das URL-Hostmuster z. B. support.example.com ist, verwenden Sie cases, um URLs für Fälle zuzuordnen, die bei support.example.com/cases/ gehostet werden.

Wenn alle URLs in der Hostmusterdomain übereinstimmen sollen, lassen Sie pathPrefix leer.