Ressource de fichier manifeste de l'éditeur

Configuration des ressources utilisée pour définir le contenu et le comportement des modules complémentaires Google Workspace dans les éditeurs. Les fichiers manifestes des modules complémentaires Google Workspace doivent inclure 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 les 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. Elle remplace addOns.common.homepageTrigger.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

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

linkPreviewTriggers[]

object (LinkPreviewTriggers)

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

createActionTriggers[]

object (createActionTriggers)

Obligatoire pour créer une ressource tierce. Liste des 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 se déclenche lorsque la boîte de dialogue du champ d'application du fichier de requête utilise CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build(); et que l'utilisateur accorde l'autorisation du champ d'application drive.file.

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

string

Nom de la fonction à exécuter si l'autorisation du champ d'application drive.file est accordée. La fonction doit renvoyer un tableau d'objets Card pour l'UI.

LinkPreviewTriggers

Configuration d'un déclencheur qui se déclenche lorsqu'un utilisateur saisit ou colle un lien provenant d'un service tiers dans un fichier Docs, Sheets ou Slides.

Pour configurer ce déclencheur pour un module complémentaire Google Workspace, consultez Prévisualiser des 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 invitant les utilisateurs à prévisualiser le lien, tel que Example: Support case. Ce texte est statique.
localizedLabelText

map (key: string, value: string)

Facultatif. Carte de labelText à localiser dans d'autres langues. Indiquez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant par un tiret -.
patterns[]

object (UriPattern)

Obligatoire. Tableau de formats d'URL qui déclenchent l'aperçu des liens par le 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. La fonction doit accepter un objet d'événement, qui inclut une propriété matchedUrl.url contenant l'URL à prévisualiser, et renvoyer un objet Card.
logoUrl

string

Facultatif. Icône affichée dans le chip intelligent et la fiche d'aperçu. Si elle est omise, 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. Domaine du format d'URL. Le module complémentaire prévisualise les liens contenant ce domaine. Pour établir une correspondance avec tous les sous-domaines, utilisez un caractère générique astérisque (*).
pathPrefix

string

Facultatif. Chemin d'accès ajouté au domaine. Pour faire correspondre toutes les URL du domaine, laissez pathPrefix vide.

CreateActionTriggers

Configuration d'un déclencheur qui se déclenche 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 de ce point d'extension. Utilisez jusqu'à 64 caractères 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. Indiquez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant par un tiret -.
runFunction

string

Obligatoire. Nom de la fonction à exécuter lorsqu'un utilisateur sélectionne un point d'extension. La fonction doit renvoyer une fiche de formulaire.
logoUrl

string

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