Créer les interfaces des éditeurs Google

Les modules complémentaires Google Workspace vous permettent de fournir des interfaces personnalisées dans les éditeurs, y compris Google Docs, Sheets et Slides. Vous pouvez ainsi fournir à l'utilisateur des informations pertinentes, automatiser des tâches et connecter des systèmes tiers aux éditeurs.

Accéder à l'UI du module complémentaire

Vous pouvez ouvrir un module complémentaire Google Workspace dans les éditeurs si son icône s'affiche dans le panneau latéral d'accès rapide Google Workspace, à droite des interfaces utilisateur de Docs, Sheets et Slides.

Un module complémentaire Google Workspace peut présenter les interfaces suivantes:

  • Interfaces de page d'accueil: si le fichier manifeste du module complémentaire inclut le déclencheur EDITOR_NAME.homepageTrigger pour l'éditeur dans lequel l'utilisateur ouvre le module complémentaire, le module complémentaire crée et renvoie une fiche de page d'accueil spécifiquement pour cet éditeur. Si le fichier manifeste du module complémentaire n'inclut pas EDITOR_NAME.homepageTrigger pour l'éditeur dans lequel l'utilisateur l'ouvre, une fiche de page d'accueil générique s'affiche à la place.

  • Interfaces d'API REST: si le module complémentaire utilise des API REST, vous pouvez inclure des déclencheurs qui demandent un accès par fichier à un document à l'aide de la portée drive.file. Une fois l'autorisation accordée, un autre déclencheur appelé EDITOR_NAME.onFileScopeGrantedTrigger s'exécute et affiche une interface spécifique au fichier.

  • Interfaces d'aperçu des liens: si votre module complémentaire s'intègre à un service tiers, vous pouvez créer des fiches qui prévisualisent le contenu des URL de votre service.

Créer des interfaces pour les modules complémentaires de l'éditeur

Pour créer des interfaces de modules complémentaires d'éditeur pour les éditeurs, procédez comme suit:

  1. Ajoutez les champs addOns.common, addOns.docs, addOns.sheets et addOns.slides appropriés au fichier manifeste du projet de script du module complémentaire.
  2. Ajoutez les champs d'application de l'éditeur requis au fichier manifeste de votre projet de script.
  3. Si vous fournissez une page d'accueil spécifique à l'éditeur, implémentez la fonction EDITOR_NAME.homepageTrigger pour créer l'interface. Si ce n'est pas le cas, utilisez l'interface common.homepageTrigger pour créer une page d'accueil commune pour vos applications hôtes.
  4. Si vous utilisez des API REST, implémentez le flux d'autorisation de l'étendue drive.file et la fonction de déclencheur EDITOR_NAME.onFileScopeGrantedTrigger pour afficher une interface spécifique au fichier ouvert. Pour en savoir plus, consultez la section Interfaces de l'API REST.
  5. Si vous configurez des aperçus de liens à partir d'un service tiers, implémentez le flux d'autorisation de champ d'application https://www.googleapis.com/auth/workspace.linkpreview et la fonction linkPreviewTriggers. Pour en savoir plus, consultez la section Interfaces d'aperçu des liens.
  6. Implémentez les fonctions de rappel associées nécessaires pour répondre aux interactions de l'utilisateur avec l'UI, telles que les clics sur les boutons.

Pages d'accueil de l'éditeur

Vous devez fournir une fonction de déclencheur de page d'accueil dans le projet de script de votre module complémentaire qui crée et renvoie un seul Card ou un tableau d'objets Card qui constituent la page d'accueil du module complémentaire.

La fonction de déclencheur de la page d'accueil reçoit un objet d'événement en tant que paramètre contenant des informations telles que la plate-forme du client. Vous pouvez utiliser les données de l'objet d'événement pour adapter la construction de la page d'accueil.

Vous pouvez présenter une page d'accueil commune ou une page d'accueil spécifique à l'éditeur dans lequel l'utilisateur ouvre votre module complémentaire.

Afficher la page d'accueil commune

Pour afficher la page d'accueil commune de votre module complémentaire dans les éditeurs, incluez les champs d'éditeur appropriés, tels que addOns.docs, addOns.sheets ou addOns.slides, dans le fichier manifeste du module complémentaire.

L'exemple suivant montre la partie addons d'un fichier manifeste de module complémentaire Google Workspace. Le module complémentaire étend Docs, Sheets et Slides, et affiche la page d'accueil commune dans chaque application hôte.

 "addOns": {
    "common": {
      "name": "Translate",
      "logoUrl": "https://www.gstatic.com/images/branding/product/1x/translate_24dp.png",
      "layoutProperties": {
        "primaryColor": "#2772ed"
      },
      "homepageTrigger": {
        "runFunction": "onHomepage"
      }
    },
    "docs": {},
    "sheets": {},
    "slides": {}
  }
}

Afficher une page d'accueil spécifique à l'éditeur

Pour présenter une page d'accueil spécifique à un éditeur, ajoutez EDITOR_NAME.homepageTrigger au fichier manifeste du module complémentaire.

L'exemple suivant montre la partie addons d'un fichier manifeste de module complémentaire Google Workspace. Le module complémentaire est activé pour Docs, Sheets et Slides. Elle affiche la page d'accueil commune dans Docs et Slides, et une page d'accueil unique dans Sheets. La fonction de rappel onSheetsHomepage crée la fiche de la page d'accueil spécifique à Sheets.

 "addOns": {
    "common": {
      "name": "Translate",
      "logoUrl": "https://www.gstatic.com/images/branding/product/1x/translate_24dp.png",
      "layoutProperties": {
        "primaryColor": "#2772ed"
      },
      "homepageTrigger": {
        "runFunction": "onHomepage"
      }
    },
    "docs": {},
    "slides": {},
    "sheets": {
     "homepageTrigger": {
       "runFunction": "onSheetsHomepage"
     },
  }
}

Interfaces de l'API REST

Si votre module complémentaire utilise des API REST, telles que l'API Google Sheets, vous pouvez utiliser la fonction onFileScopeGrantedTrigger pour afficher une nouvelle interface spécifique au fichier ouvert dans l'application hôte de l'éditeur.

Vous devez inclure le flux d'autorisation de portée drive.file pour utiliser la fonction onFileScopeGrantedTrigger. Pour savoir comment demander la portée drive.file, consultez Demander l'accès au fichier pour le document actuel.

Lorsqu'un utilisateur accorde la portée drive.file, EDITOR_NAME.onFileScopeGrantedTrigger.runFunction se déclenche. Lorsque le déclencheur se déclenche, il exécute la fonction de déclencheur contextuel spécifiée par le champ EDITOR_NAME.onFileScopeGrantedTrigger.runFunction dans le fichier manifeste du module complémentaire.

Pour créer une interface d'API REST pour l'un des éditeurs, procédez comme suit : Remplacez EDITOR_NAME par l'application hôte de l'éditeur que vous choisissez d'utiliser, par exemple sheets.onFileScopeGrantedTrigger.

  1. Incluez EDITOR_NAME.onFileScopeGrantedTrigger dans la section "Éditeur" appropriée de votre fichier manifeste. Par exemple, si vous souhaitez créer cette interface dans Google Sheets, ajoutez le déclencheur à la section "sheets".
  2. Implémentez la fonction nommée dans la section EDITOR_NAME.onFileScopeGrantedTrigger. Cette fonction accepte un objet d'événement comme argument et doit renvoyer un seul objet Card ou un tableau d'objets Card.
  3. Comme pour toute fiche, vous devez implémenter les fonctions de rappel utilisées pour fournir une interactivité de widget à l'interface. Par exemple, si vous incluez un bouton dans l'interface, il doit comporter une action associée et une fonction de rappel implémentée qui s'exécute lorsque l'utilisateur clique sur le bouton.

L'exemple suivant montre la partie addons d'un fichier manifeste de module complémentaire Google Workspace. Le module complémentaire utilise des API REST. onFileScopeGrantedTrigger est donc inclus pour Google Sheets. Lorsqu'un utilisateur accorde l'étendue drive.file, la fonction de rappel onFileScopeGrantedSheets crée une interface spécifique au fichier.

"addOns": {
   "common": {
     "name": "Productivity add-on",
     "logoUrl": "https://www.gstatic.com/images/icons/material/system_gm/1x/work_outline_black_18dp.png",
     "layoutProperties": {
       "primaryColor": "#669df6",
       "secondaryColor": "#ee675c"
     }
   },
   "sheets": {
     "homepageTrigger": {
       "runFunction": "onEditorsHomepage"
     },
     "onFileScopeGrantedTrigger": {
       "runFunction": "onFileScopeGrantedSheets"
     }
   }

Pour activer les aperçus de liens pour un service tiers, vous devez configurer les aperçus de liens dans le fichier manifeste de votre module complémentaire et créer une fonction qui renvoie une fiche d'aperçu. Pour les services qui nécessitent une autorisation utilisateur, votre fonction doit également appeler le flux d'autorisation.

Pour savoir comment activer les aperçus des liens, consultez Prévisualiser les liens avec les chips intelligents.

Objets d'événement

Un objet d'événement est créé et transmis aux fonctions de déclenchement, telles que EDITOR_NAME.homepageTrigger ou EDITOR_NAME.onFileScopeGrantedTrigger. La fonction de déclencheur utilise les informations de l'objet d'événement pour déterminer comment créer des fiches de modules complémentaires ou contrôler autrement le comportement des modules complémentaires.

La structure complète des objets d'événement est décrite dans Objets d'événement.

Lorsqu'un éditeur est l'application hôte du module complémentaire, les objets d'événement incluent des champs d'objets d'événement Docs, Sheets ou Slides qui contiennent des informations client.

Si le module complémentaire ne dispose pas de l'autorisation de champ d'application drive.file pour l'utilisateur ou le document actuels, l'objet d'événement ne contient que le champ docs.addonHasFileScopePermission, sheets.addonHasFileScopePermission ou slides.addonHasFileScopePermission. Si le module complémentaire est autorisé, l'objet d'événement contient tous les champs de l'objet d'événement de l'éditeur.

L'exemple suivant montre un objet d'événement Éditeur transmis à une fonction sheets.onFileScopeGrantedTrigger. Ici, le module complémentaire dispose de l'autorisation de champ d'application drive.file pour le document en cours:

`        {
          "commonEventObject": { ... },
          "sheets": {
            "addonHasFileScopePermission": true,
            "id":"A_24Q3CDA23112312ED52",
            "title":"How to get started with Sheets"
          },
          ...
        }