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 |
Cette fonction de déclenchement crée la page d'accueil du module complémentaire dans l'application hôte. Elle remplace
|
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 |
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 |
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 |
Example: Support case . Ce texte est statique et s'affiche avant que les utilisateurs n'exécutent le module complémentaire.
|
localizedLabelText |
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 |
patterns[] |
|
runFunction |
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 |
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 |
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, |
pathPrefix |
hostPattern .
Par exemple, si le format d'hôte de l'URL est Pour correspondre à toutes les URL du domaine du format d'hôte, laissez |