Cette page a été traduite par l'API Cloud Translation.

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. Cela vous permet de fournir à l'utilisateur des informations pertinentes, d'automatiser des tâches et de connecter des systèmes tiers aux éditeurs.

Accéder à l'interface utilisateur du module complémentaire

Vous pouvez ouvrir un module complémentaire Google Workspace dans les éditeurs si son icône apparaît 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 la 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, celui-ci 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 le 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 de l'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 du champ d'application 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

Créez des interfaces de module complémentaire Build Editor pour les éditeurs en procédant comme suit :

Ajoutez les champs addOns.common, addOns.docs, addOns.sheets et addOns.slides appropriés au manifeste du projet de script du module complémentaire.
Ajoutez les scopes d'éditeur requis au fichier manifeste de votre projet de script.
Si vous fournissez une page d'accueil spécifique à l'éditeur, implémentez la fonction EDITOR_NAME.homepageTrigger pour créer l'interface. Sinon, utilisez l'interface common.homepageTrigger pour créer une page d'accueil commune pour vos applications hôtes.
Si vous utilisez des API REST, implémentez le flux d'autorisation du champ d'application drive.file et la fonction de déclenchement EDITOR_NAME.onFileScopeGrantedTrigger pour afficher une interface spécifique au fichier ouvert. Pour en savoir plus, consultez Interfaces de l'API REST.
Si vous configurez des aperçus de liens à partir d'un service tiers, implémentez le flux d'autorisation du champ https://www.googleapis.com/auth/workspace.linkpreview et la fonction linkPreviewTriggers. Pour en savoir plus, consultez Interfaces d'aperçu des liens.
Implémentez les fonctions de rappel associées nécessaires pour répondre aux interactions de l'utilisateur avec l'UI, comme 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. Cette fonction doit créer et renvoyer un seul Card ou un tableau d'objets Card qui composent 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 personnaliser la création 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 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, comme 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 du champ d'application drive.file pour utiliser la fonction onFileScopeGrantedTrigger. Pour savoir comment demander le champ d'application drive.file, consultez Demander l'accès aux fichiers pour le document actuel.

Lorsqu'un utilisateur accorde le champ d'application drive.file, EDITOR_NAME.onFileScopeGrantedTrigger.runFunction se déclenche. Lorsque le déclencheur est activé, 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.

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".
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.
Comme pour toute carte, vous devez implémenter les fonctions de rappel utilisées pour fournir l'interactivité des widgets pour l'interface. Par exemple, si vous incluez un bouton dans l'interface, il doit être associé à une Action 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. Par conséquent, onFileScopeGrantedTrigger est inclus pour Google Sheets. Lorsqu'un utilisateur accorde le champ d'application 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"
     }
   }

Interfaces d'aperçu des liens pour les services tiers

Pour activer les aperçus des liens pour un service tiers, vous devez configurer les aperçus des 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 de l'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 pour déclencher des fonctions, 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 construire des fiches de module complémentaire ou contrôler le comportement du module complémentaire.

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 active du module complémentaire, les objets d'événement incluent les champs d'objet d'événement Docs, Sheets ou Slides qui contiennent des informations sur le client.

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

L'exemple suivant montre un objet d'événement Editor transmis à une fonction sheets.onFileScopeGrantedTrigger. Ici, le module complémentaire dispose de l'autorisation de portée drive.file pour le document actuel :

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

Créer les interfaces des éditeurs Google Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.