Pour créer un module complémentaire Google Workspace, procédez comme suit:
- 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 champs d'application 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 langage autre qu'Apps Script, il vous suffit de créer un projet Google Cloud.
Avant de commencer à développer des modules complémentaires, choisissez un seul compte utilisateur comme propriétaire des 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 aider 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 unique ne soit propriétaire. En plaçant votre fichier de script de modules complémentaires dans un Drive partagé, vous vous assurez facilement que plusieurs collaborateurs ont toujours 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 écriture au projet de script, mais il n'est pas nécessaire d'en être le propriétaire.
Projets Google Cloud
Nous vous recommandons d'ajouter des collaborateurs au projet Cloud du module complémentaire. Cela permet à un membre de votre équipe d'accéder en permanence aux paramètres cloud du module complémentaire.
Concevoir l'apparence et le comportement de votre module complémentaire
Déterminez l'apparence et le comportement du module complémentaire 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 filtres.
Reportez-vous au guide de style des modules complémentaires Google Workspace pour savoir comment concevoir votre expérience utilisateur.
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 Fichier manifestes pour en savoir plus sur la configuration du 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 une carte 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 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 d'OAuth, vous devez également configurer OAuth pour ce service.
Construction de cartes
Pour définir une interface utilisateur de module complémentaire, créez des objets Card et remplissez-les de widgets. Les fonctions de déclenchement 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 complémentaire. Votre module complémentaire peut également créer et afficher des fiches en réponse aux actions des utilisateurs.
Dans Apps Script, vous devez créer 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 la 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 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 les informations à afficher dans les fiches complémentaires que vous créez. Vous pouvez utiliser des 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 sur la connexion à des services autres que Google.
Ordre de construction
Lorsque vous créez une carte, vous devez compiler de haut en haut. Autrement dit, vous devez utiliser l'ordre de construction suivant:
- Créez le widget.
- Ajouter le widget à la section des fiches.
- Répétez l'opération jusqu'à ce que la section des fiches contienne tous ses widgets.
- Ajoutez la section de la fiche à la fiche.
Cela est nécessaire, car lorsque vous ajoutez un widget à une fiche ou à une section de fiche, vous ajoutez en fait une copie de ce widget. Toutes les modifications que vous apportez à l'objet 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 la section Actions universelles.
Vérifier les champs d'application OAuth des modules complémentaires
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 n'aient un champ d'application que pour les actions qu'ils doivent avoir dans l'ordre, et rien d'autre.
Dans les projets de modules complémentaires, définissez explicitement les champs d'application des modules complémentaires afin que l'ensemble de niveaux d'accès soit le moins permissif possible. Vous définissez les champs d'application que votre module complémentaire utilise dans son fichier manifeste.
Pour en savoir plus, consultez la section Champs d'application.
Tester le module complémentaire
Pour tester les modules complémentaires non publiés, vous devez d'abord installer 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 de l'utilisateur.
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 à tous les utilisateurs, qu'ils soient publics ou réservés aux 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 disponibles publiquement doivent être examinés avant d'être publiés.
Pour en savoir plus, consultez Publier le module complémentaire Google Workspace.
Exemple de module complémentaire Google Workspace
Pour vous aider à comprendre la conception des modules complémentaires Google Workspace, le guide de démarrage rapide des modules complémentaires Google Workspace explique comment créer un module complémentaire Google Workspace simple, y compris les pages d'accueil, la navigation par carte et les connexions à un service tiers. Une fois le démarrage rapide terminé, vous pouvez installer le module complémentaire et tester le code.