Ressource du fichier manifeste de l'éditeur

Configuration des ressources utilisée pour définir le contenu et le comportement du module complémentaire Google Workspace dans les éditeurs. Les fichiers manifestes des modules complémentaires Google Workspace doivent comporter tous les composants marqués comme obligatoires s'ils étendent l'éditeur.

Éditeurs

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

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

object (HomepageTrigger)

Cette fonction de déclencheur crée la page d'accueil du module complémentaire dans l'application hôte. Cela 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 des 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 (preview développeur).

Déclencheur OnFileScopeGrantedTrigger

Configuration d'un déclencheur contextuel qui se déclenche lorsque la boîte de dialogue de champ d'application de la requête à l'aide de CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); et de 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 d'un service tiers ou non Google dans un document Google Docs.

Pour configurer ce déclencheur pour un module complémentaire Google Workspace, consultez Prévisualiser les liens dans Google Docs (preview développeur).

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

string

Obligatoire. Texte d'un exemple de chip intelligent qui invite les utilisateurs à 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. Utilisez le format ISO 639 et le pays/la région au format ISO 3166, en les séparant 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 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/workspace.linkpreview. 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 objet Card unique 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. En cas d'omission, le chip 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 d'un lien.

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

string

Obligatoire pour chaque format d'URL à prévisualiser. Domaine du format d'URL. Liens d'aperçu du module complémentaire 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 avec un astérisque (*) comme sous-domaine.

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

pathPrefix

string

Facultatif. Chemin qui ajoute le domaine de hostPattern.

Par exemple, si le format d'hôte d'URL est support.example.com, utilisez cases pour correspondre aux URL des cas hébergés sur support.example.com/cases/.

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