Ressource du fichier manifeste de l'éditeur

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Configuration de ressources utilisée pour définir le contenu et le comportement des modules complémentaires au sein des éditeurs. Les fichiers manifestes des modules complémentaires doivent comporter tous les composants marqués comme Required (Obligatoires) s'ils étendent l'éditeur.

Éditeurs

Configuration du fichier manifeste du module complémentaire pour les extensions Editor. Pour en savoir plus, consultez Extension des éditeurs avec des modules complémentaires.

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

object (HomepageTrigger)

Cette fonction de déclenchement crée la page d'accueil du module complémentaire dans l'application hôte. Elle remplace addOns.common.homepageTrigger.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Obligatoire si votre module complémentaire inclut un comportement spécifique au document Editor actuel, déclenché lorsque l'utilisateur autorise le champ d'application drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Obligatoire pour les aperçus de liens. Liste de déclencheurs pour prévisualiser les liens dans un document Google Docs. Pour en savoir plus, consultez Prévisualiser les liens dans Google Docs (aperçu pour les développeurs).

Déclencheur OnFileScopeGranted

Configuration d'un déclencheur contextuel qui se déclenche lorsque le module complémentaire affiche la boîte de dialogue de champ d'application de la requête à l'aide de CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); et que l'utilisateur accorde l'autorisation de champ d'application drive.file.

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

string

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

LinkPreviewTriggers

Configuration d'un déclencheur qui se déclenche lorsqu'un utilisateur saisit ou colle un lien provenant d'un service tiers ou autre que Google dans un document Google Docs.

Pour configurer ce déclencheur pour un module complémentaire Google Workspace, consultez Liens d'aperçu dans Google Docs (aperçu pour les développeurs).

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

string

Obligatoire. Exemple de texte d'un chip intelligent qui invite l'utilisateur à 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

Facultatif. Carte de labelText à localiser dans d'autres langues. Mettez en forme la langue au format ISO 639 et le pays/la région en ISO 3166, en les séparant par un trait d'union -. Par exemple, en-US.

Si les paramètres régionaux de l'utilisateur sont présents dans les clés de la carte, il voit la version localisée de 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/documents.readonly. Si elle est spécifiée, vous devez implémenter cette fonction pour accepter un objet d'événement contenant docs.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 l'icône intelligente. En cas d'omission, la puce utilise l'icône de la barre d'outils de votre module complémentaire, logoUrl.

Modèle d'URI

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 prévisualiser chaque format d'URL. Domaine du format d'URL. Les liens vers les aperçus des modules complémentaires contenant ce domaine dans l'URL. Pour prévisualiser les liens d'un sous-domaine spécifique, comme subdomain.example.com, incluez le sous-domaine. Pour prévisualiser les liens pour l'ensemble du domaine, spécifiez un caractère générique suivi d'un astérisque (*).

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 de l'URL est support.example.com, utilisez cases pour faire correspondre les URL des cas hébergés à support.example.com/cases/.

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