Lorsque vous souhaitez créer un module complémentaire Google Workspace, suivez cette procédure générale:
- 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 du module complémentaire.
- Écrivez du code pour définir l'apparence et le comportement du module complémentaire.
- Vérifiez les habilitations OAuth de votre module complémentaire.
- Testez le module complémentaire dans les applications hôtes qu'il étend.
- Publiez le module complémentaire.
Configurez les projets de votre module complémentaire, et choisissez 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 un autre langage qu'Apps Script, il vous suffit de créer un projet Google Cloud.
Avant de commencer le développement de modules complémentaires, choisissez un seul compte utilisateur qui possède les projets et décidez quels autres comptes sont des collaborateurs. Le propriétaire des projets crée et gère les fichiers du projet et les paramètres associés, tandis que les collaborateurs peuvent participer au codage et aux tests.
Projets Apps Script
Vous pouvez créer les fichiers de projet Apps Script de votre module complémentaire dans un Drive partagé afin qu'aucun compte ne soit propriétaire exclusif. 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 être autorisé à modifier le projet de script, mais il n'a pas besoin d'en être le propriétaire.
Pour créer un projet Apps Script, consultez la page Projets Script.
Projets Google Cloud
Nous vous recommandons d'ajouter des collaborateurs au projet Cloud du module complémentaire. Cela permet de garantir 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 ressemblera votre module complémentaire et son comportement avant de commencer à le créer. Réfléchissez aux cas d'utilisation pour lesquels le module complémentaire doit fournir des solutions. Commencez par une conception simple pour commencer, puis ajoutez d'autres améliorations.
Consultez le guide de style du module complémentaire Google Workspace pour savoir comment concevoir l'expérience utilisateur de votre module complémentaire.
Configurer le fichier manifeste du projet de 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 générer l'apparence et le comportement du module complémentaire 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 Card d'Apps Script ou, si vous écrivez dans un autre langage de code, renvoyez un fichier JSON correctement formaté pour que l'interface s'affiche sous forme de cartes.
Vous devez également implémenter 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éclenchement spécifiées dans votre fichier manifeste doivent renvoyer un objet Card unique 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, la classe CardBuilder vous permet de créer des fiches. Chaque carte nécessite un CardHeader et un ou plusieurs CardSections. Vous devez remplir chaque section de fiche avec les widgets individuels qui composent 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.
Après avoir 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 les données extraites de services autres que Google.
Si vos modules complémentaires Google Workspace ont besoin d'accéder à des API autres que Google nécessitant OAuth, vous devez configurer ce service et vous y connecter. Pour en savoir plus, consultez le guide Se connecter à des services autres que Google.
Ordre de construction
Lorsque vous créez une carte, vous devez partir de la pile. Autrement dit, vous devez utiliser cet ordre de construction:
- Créez le widget.
- Ajoutez le widget à la section des fiches.
- Répétez l'opération jusqu'à ce que la section "Fiche" comporte tous ses widgets.
- Ajoutez la section correspondante à la fiche.
Cela 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. Les modifications que vous apportez à l'objet de widget après l'avoir ajouté ne sont pas répercutées 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 carte 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 Actions universelles.
Vérifier les habilitations OAuth du module complémentaire
Les champs d'application définissent les actions que le module complémentaire est autorisé à effectuer pour le compte d'un utilisateur. Il est recommandé que les modules complémentaires ne disposent que de champs d'application pour les actions qu'ils doivent avoir dans l'ordre, et rien de plus.
Dans les projets de modules complémentaires, définissez explicitement les champs d'application des modules complémentaires afin de vous assurer qu'ils utilisent l'ensemble de champs d'application le moins permissif possible. Vous définissez les champs d'application utilisés par votre module complémentaire dans le fichier manifeste du module.
Pour en savoir plus, consultez la section Champs d'application.
Tester le module complémentaire
Vous pouvez tester des modules complémentaires non publiés en installant d'abord le module complémentaire non publié. 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
En publiant votre module complémentaire, vous le rendez accessible à d'autres personnes, que ce soit publiquement ou uniquement par les utilisateurs de votre domaine. Avant de commencer le processus de publication, veillez à consulter la présentation de la publication. La publication est un processus complexe qui nécessite une préparation et du temps.
Les modules complémentaires Google Workspace sont publiés sur Google Workspace Marketplace. Les modules complémentaires accessibles au public doivent faire l'objet d'un examen avant d'être publiés.
Pour en savoir plus, consultez Publier un module complémentaire Google Workspace.