Ressource de 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. Tous les composants du fichier manifeste du module complémentaire 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 de l'éditeur. Pour en savoir plus, consultez Étendre les éditeurs à l'aide des modules complémentaires Google Workspace.

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 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 de liens. Liste de déclencheurs permettant de 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 permettant de créer des 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 la boîte de dialogue "Demander le champ d'application du fichier" à 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 niveau d'accès drive.file est accordé. Si spécifié, vous devez mettre en œuvre 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 s'active lorsqu'un utilisateur saisit ou colle un lien à partir d'un service tiers ou autre que Google dans un fichier Docs, Sheets ou Slides.

Pour configurer ce déclencheur pour un module complémentaire Google Workspace, consultez 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 à prévisualiser le lien (Example: Support case, par exemple). 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. Mettez en forme la langue au 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, il voit la version localisée de labelText.

patterns[]

object (UriPattern)

Obligatoire. Tableau de formats d'URL qui déclenchent les liens de prévisualisation du module complémentaire.
runFunction

string

Obligatoire. Nom de la fonction à exécuter lorsque l'utilisateur autorise le champ d'application https://www.googleapis.com/auth/workspace.linkpreview. S'il est spécifié, 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. En cas d'omission, le module complémentaire utilise son icône de 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, tel que subdomain.example.com, incluez le sous-domaine. Pour prévisualiser les liens sur 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 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 correspondre aux URL des demandes hébergées sur support.example.com/cases/.

Pour représenter toutes les URL du domaine du format d'hôte, laissez pathPrefix vide.

CreateActionTriggers

Configuration d'un déclencheur qui s'active lorsqu'un utilisateur sélectionne un élément de menu d'intégration tierce dans le menu @ de Google Docs.

Pour configurer ce déclencheur pour un module complémentaire Google Workspace, consultez 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 ce point d'extension. L'ID peut comporter jusqu'à 64 caractères et doit être au format [a-zA-Z0-9-]+..
labelText

string

Obligatoire. Texte qui apparaît dans le menu @, par exemple Create support case.
localizedLabelText

map (key: string, value: string)

Facultatif. Carte de labelText à localiser dans d'autres langues. Mettez en forme la langue au 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, il voit la version localisée de 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 @. En cas d'omission, le module complémentaire utilise son icône de barre d'outils, logoUrl.