Ressource de fichier manifeste de l'éditeur

La configuration de ressource utilisée pour définir Module complémentaire Google Workspace et le comportement des éditeurs. Les fichiers manifestes des modules complémentaires Google Workspace doivent comporter Tous les composants marqués comme obligatoires s'ils étendent l'éditeur.

Rédacteurs

Configuration du fichier manifeste du module complémentaire Google Workspace pour Extensions Editor. Voir Extension des éditeurs à l'aide des modules complémentaires Google Workspace pour en savoir plus.

Représentation JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
Champs
homepageTrigger

object (HomepageTrigger)

Cette fonction de déclencheur crée le module complémentaire page d'accueil de la l'application hôte. Cela remplace addOns.common.homepageTrigger

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Obligatoire si votre module complémentaire inclut un comportement spécifique à la version actuelle Document éditeur, déclenché lorsque l'utilisateur autorise le champ d'application drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Obligatoire pour les aperçus de liens. Une liste des déclencheurs pour prévisualiser des liens dans un fichier Google Docs, Sheets ou Slides ; Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.

createActionTriggers[]

object (createActionTriggers)

Obligatoire pour la création de ressources tierces. Liste de déclencheurs pour la création de ressources dans un service tiers à partir du menu @. Pour en savoir plus, consultez Créer des ressources tierces avec des chips intelligents.

OnFileScopeGrantedTrigger

Configuration d'un déclencheur contextuel qui s'exécute lorsque le Boîte de dialogue de requête de champ d'application de fichier avec CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); et l'utilisateur accorde drive.file autorisation de niveau d'accès.

Représentation JSON
{
  "runFunction": string
}
Champs
runFunction

string

Nom de la fonction à exécuter si le champ d'application de drive.file est accordé. Si elle est spécifiée, vous devez implémenter cette fonction pour créer et renvoient un tableau de Objets Card à afficher dans l'UI du module complémentaire.

LinkPreviewTriggers

Configuration d'un déclencheur qui se déclenche lorsqu'un utilisateur saisit ou colle un lien depuis un service tiers ou autre que Google dans Docs, Sheets ou Slides.

Pour configurer ce déclencheur pour un module complémentaire Google Workspace, voir Prévisualiser les liens avec des chips intelligents

Représentation JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Champs
labelText

string

Obligatoire. Texte d'un exemple de chip intelligent qui invite les utilisateurs pour prévisualiser le lien, par exemple Example: Support case. Ce texte est statique et s'affiche avant que les utilisateurs n'exécutent le module complémentaire.
localizedLabelText

map (key: string, value: string)

Facultatif. Carte de labelText à localiser dans d'autres langues. Mettre en forme la langue aux normes ISO 639 et aux pays/régions de la ISO 3166, séparés par un trait d'union -. Par exemple, en-US.

Si les paramètres régionaux d'un utilisateur sont présents dans les clés de la carte, l'utilisateur voit les version localisée du labelText.

patterns[]

object (UriPattern)

Obligatoire. Tableau de formats d'URL qui déclenchent le module complémentaire pour prévisualiser les liens.
runFunction

string

Obligatoire. Nom de la fonction à exécuter lorsque l'utilisateur autorise le champ d'application https://www.googleapis.com/auth/workspace.linkpreview. Si elle est spécifiée, vous devez implémenter cette fonction pour accepter un objet d'événement contenant EDITOR_NAME.matchedUrl.url comme argument et renvoyer un seul objet Card qui affiche un aperçu du lien dans l'interface utilisateur du module complémentaire.
logoUrl

string

Facultatif. Icône qui s'affiche dans le chip intelligent et la fiche d'aperçu. Si est omis, le module complémentaire utilise son icône dans la barre d'outils, logoUrl.

UriPattern

Configuration de chaque format d'URL qui déclenche un aperçu du lien.

Représentation JSON
{
  "hostPattern": string,
  "pathPrefix" : string
}
Champs
hostPattern

string

Obligatoire pour chaque format d'URL à prévisualiser. Domaine du format d'URL. Le module complémentaire affiche un aperçu des liens qui contiennent ce domaine dans l'URL. Pour prévisualiser les liens d'un sous-domaine spécifique (subdomain.example.com, par exemple), incluez ce sous-domaine. Pour prévisualiser les liens de l'ensemble du domaine, indiquez un caractère générique avec un astérisque (*) comme sous-domaine.

Par exemple, *.example.com correspond à subdomain.example.com. et another.subdomain.example.com.

pathPrefix

string

Facultatif. Chemin d'accès qui ajoute le domaine de hostPattern.

Par exemple, si le format d'hôte d'URL est support.example.com, utilisez cases pour établir une correspondance avec les URL des demandes hébergées sur support.example.com/cases/.

Pour faire correspondre toutes les URL du domaine du format d'hôte, laissez le champ pathPrefix vide.

CreateActionTriggers

Configuration d'un déclencheur qui se déclenche lorsqu'un utilisateur sélectionne un tiers l'élément de menu d'intégration du menu Google Docs @.

Pour configurer ce déclencheur pour un module complémentaire Google Workspace, voir Créer des ressources tierces avec des chips intelligents

Représentation JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
Champs
id

string

Obligatoire. Identifiant unique permettant de différencier cette extension point d'accès. L'ID peut comporter jusqu'à 64 caractères et doit être au format suivant : [a-zA-Z0-9-]+.
labelText

string

Obligatoire. Le texte qui apparaît dans la partie @ (Create support case, par exemple).
localizedLabelText

map (key: string, value: string)

Facultatif. Carte de labelText à localiser dans d'autres langues. Mettre en forme la langue aux normes ISO 639 et aux pays/régions de la ISO 3166, séparés par un trait d'union -. Par exemple, en-US.

Si les paramètres régionaux d'un utilisateur sont présents dans les clés de la carte, l'utilisateur voit les version localisée du labelText.

runFunction

string

Obligatoire. Nom de la fonction à exécuter lorsqu'un utilisateur sélectionne un point d'extension dans le menu @. La fonction doit renvoyer une fiche de formulaire avec des entrées permettant de créer la ressource tierce.
logoUrl

string

Facultatif. Icône qui s'affiche dans le menu @. Si est omis, le module complémentaire utilise son icône dans la barre d'outils, logoUrl.