Cette page explique comment concevoir, créer et publier des modules complémentaires Google Workspace. Cette présentation décrit les étapes suivantes:
- Déterminez les applications Google Workspace dans lesquelles vous souhaitez mettre votre module complémentaire à la disposition des utilisateurs.
- Configurez les projets de votre module complémentaire, puis choisissez un propriétaire et des collaborateurs.
- Concevez l'apparence et le comportement de votre module complémentaire.
- Configurez le fichier manifeste du projet ou la ressource de déploiement de l'extension.
- Écrivez du code pour définir l'apparence et le comportement du module complémentaire.
- Vérifiez les niveaux d'accès OAuth de votre module complémentaire.
- Testez le module complémentaire dans une ou plusieurs applications Google Workspace.
- Publiez le module complémentaire.
Choisir des applications hôtes Google Workspace
Vous pouvez configurer les modules complémentaires Google Workspace pour qu'ils s'affichent dans les applications hôtes Google Workspace suivantes :
- Gmail
- Google Agenda
- Google Docs
- Google Drive
- Google Sheets
- Google Slides
Pour découvrir comment créer des applications Google Workspace, consultez la page Étendre l'interface utilisateur de Google Workspace.
Configurer les projets de votre module complémentaire, et choisir un propriétaire et des collaborateurs
Si vous créez votre module complémentaire dans Apps Script, vous créez à la fois un projet Apps Script et un projet Google Cloud. Si vous créez votre module complémentaire dans une autre langue qu'Apps Script, il vous suffit de créer un projet Google Cloud.
Avant de commencer à développer un module complémentaire, choisissez un seul compte utilisateur pour en être le propriétaire et décidez des autres comptes qui seront des collaborateurs. Le propriétaire des projets crée et gère les fichiers de projet et les paramètres associés, tandis que les collaborateurs peuvent l'aider à coder et à tester.
Projets Apps Script
Vous pouvez créer les fichiers de projet Apps Script de votre module complémentaire dans un disque partagé afin qu'aucun compte ne soit propriétaire unique. En plaçant le fichier de script du module complémentaire dans un Drive partagé, vous vous assurez que plusieurs collaborateurs ont accès au projet de script.
Lorsque vous publiez un module complémentaire, un seul compte utilisateur agit en tant qu'éditeur. Le compte de publication doit disposer d'un accès en modification au projet de script, mais il n'a pas besoin d'en être le propriétaire.
Pour créer un projet Apps Script, consultez Projets de script.
Projets Google Cloud
Nous vous recommandons d'ajouter des collaborateurs au projet Cloud du module complémentaire. Cela permet de s'assurer qu'un membre de votre équipe peut toujours accéder aux paramètres Cloud du module complémentaire.
Pour créer un projet Google Cloud, consultez Créer un projet Google Cloud.
Concevoir l'apparence et le comportement de votre module complémentaire
Déterminez à quoi doit ressembler votre module complémentaire et comment il doit se comporter avant de commencer à le créer. Réfléchissez aux cas d'utilisation pour lesquels le module complémentaire doit tenter de fournir des solutions. Commencez par une conception simple pour commencer, puis ajoutez d'autres améliorations.
Consultez le guide de style des modules complémentaires Google Workspace pour obtenir des conseils sur la conception de l'expérience utilisateur de votre module complémentaire.
Configurer le fichier manifeste du projet du module complémentaire
Dans les projets Apps Script, le fichier manifeste du projet est un fichier JSON spécial. Il spécifie divers détails sur le projet, tels que ses dépendances de bibliothèque. Pour les modules complémentaires Google Workspace, le fichier manifeste fournit également les informations de base dont l'application hôte a besoin pour afficher correctement le module complémentaire.
Consultez la section Fichiers manifestes pour savoir comment configurer le fichier manifeste de votre module complémentaire dans Apps Script.
Lorsque vous ajoutez du code et des fonctionnalités à votre module complémentaire, modifiez le fichier manifeste si nécessaire pour obtenir l'apparence et le comportement requis.
Coder le module complémentaire
Vous devez implémenter une interface basée sur des cartes pour le module complémentaire. Utilisez le service de cartes d'Apps Script ou, si vous écrivez dans un autre langage de code, renvoyez un code JSON correctement formaté pour que l'interface s'affiche sous forme de cartes.
Vous devez également implémenter toutes les fonctions de déclencheur spécifiées dans le fichier manifeste du module complémentaire. Si votre module complémentaire se connecte à un service tiers autre que Google à l'aide du protocole OAuth, vous devez également configurer OAuth pour ce service.
Créer des cartes
Pour définir une interface utilisateur de module complémentaire, créez des objets Card et remplissez-les avec des widgets. Les fonctions de déclencheur spécifiées dans votre fichier manifeste doivent renvoyer un seul objet Card ou un tableau d'objets Card représentant différentes "pages" de l'interface du module complémentaire. Votre module complémentaire peut également créer et afficher de nouvelles fiches en réponse aux actions des utilisateurs.
Dans Apps Script, vous créez des fiches à l'aide de la classe CardBuilder. Chaque carte nécessite un CardHeader et un ou plusieurs CardSections. Vous devez renseigner chaque section de carte avec les widgets individuels qui constituent l'interface du module complémentaire. Les widgets d'interaction sont généralement associés à des actions pour définir leur comportement d'interaction.
Une fois que vous avez ajouté toutes les sections et tous les widgets à votre fiche via son CardBuilder, vous devez appeler CardBuilder.build() pour créer l'objet Card correspondant.
Vous pouvez utiliser d'autres services Apps Script intégrés tels que CalendarApp pour récupérer des informations à afficher dans les fiches de modules complémentaires que vous créez.
Vous pouvez utiliser des données extraites de services autres que Google.
Si votre module complémentaire a besoin d'accéder à des API autres que Google qui nécessitent OAuth, vous devez configurer et vous connecter à ce service. Pour en savoir plus, consultez le guide de connexion aux services autres que Google.
Ordre de construction
Lorsque vous créez une fiche, vous devez le faire de haut en bas. Autrement dit, vous devez utiliser cet ordre de construction:
- Créez le widget.
- Ajoutez le widget à la section "Carte".
- Répétez l'opération jusqu'à ce que la section des fiches contienne tous ses widgets.
- Ajoutez la section de la carte à la carte.
Cette opération est nécessaire, car lorsque vous ajoutez un widget à une fiche ou à une section de carte, vous ajoutez en fait une copie de ce widget. Toute modification que vous apportez à l'objet du widget après l'avoir ajouté n'est pas répercutée dans la fiche finale.
Actions universelles
Vous pouvez utiliser des actions universelles pour fournir une fonctionnalité indépendante du contexte. Les actions universelles sont des éléments de menu disponibles dans l'interface utilisateur du module complémentaire, quelle que soit la fiche affichée. Toutes les actions universelles définies apparaissent toujours dans le menu de la fiche du module complémentaire.
Pour en savoir plus, consultez la section Actions universelles.
Vérifier les champs d'application OAuth du module complémentaire
Les champs d'application définissent les actions que le module complémentaire est autorisé à effectuer au nom d'un utilisateur. Il est recommandé que les modules complémentaires ne disposent que de portées pour les actions dont ils ont besoin pour fonctionner, et rien de plus.
Dans les projets de modules complémentaires, définissez explicitement les champs d'application des modules complémentaires pour vous assurer qu'ils utilisent l'ensemble de champs d'application le moins permissif possible. Vous définissez les portées que votre module complémentaire utilise dans le fichier manifeste du module complémentaire.
Pour en savoir plus, consultez la section Champ d'application.
Tester le module complémentaire
Pour tester des modules complémentaires non publiés, vous devez d'abord les installer. Une fois installé et autorisé, vous pouvez utiliser le module complémentaire dans votre compte, et tester son apparence et son comportement dans les applications hôtes qu'il étend. Vous devez vérifier que le module complémentaire se comporte comme prévu pour les contextes et les actions des utilisateurs.
Pour en savoir plus, consultez Tester les modules complémentaires Google Workspace.
Publier le module complémentaire
Si vous publiez votre module complémentaire, il sera disponible pour d'autres utilisateurs, que ce soit publiquement ou uniquement pour les utilisateurs de votre domaine. Avant de commencer le processus de publication, consultez la présentation de la publication. La publication est un processus complexe qui nécessite de la préparation et du temps.
Les modules complémentaires Google Workspace sont publiés sur Google Workspace Marketplace. Les modules complémentaires disponibles publiquement doivent passer un examen de l'application avant d'être publiés.
Pour en savoir plus, consultez Publier un module complémentaire Google Workspace.