Si 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, et choisissez un propriétaire et des collaborateurs.
- Concevez l'apparence et le comportement de votre module complémentaire.
- Configurez la ressource de déploiement ou le fichier manifeste du projet 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.
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 un langage autre qu'Apps Script, il vous suffit de créer un projet Google Cloud.
Avant de commencer le développement des modules complémentaires, choisissez un seul compte utilisateur pour être propriétaire des projets et choisissez les autres comptes qui seront 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 ne dispose de la propriété exclusive. Le fait de placer le fichier de script du module complémentaire dans un Drive partagé garantit que plusieurs collaborateurs ont accès au projet de script.
Lorsque vous publiez un module complémentaire, un seul compte utilisateur fait office d'éditeur. Le compte de publication doit être autorisé à modifier le projet de script, mais ne doit pas nécessairement être le propriétaire.
Pour créer un projet Apps Script, consultez Projets Script.
Projets Google Cloud
Nous vous recommandons d'ajouter des collaborateurs au projet Cloud du module complémentaire. De cette façon, 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 du module complémentaire
Déterminez l'apparence de 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 tenter de fournir des solutions. Commencez par une conception simple pour commencer, puis ajoutez des améliorations.
Consultez le guide de style des modules complémentaires Google Workspace pour découvrir comment concevoir l'expérience utilisateur des modules complémentaires.
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 diverses informations sur le projet, telles 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.
À mesure que vous ajoutez du code et des fonctionnalités à votre module complémentaire, modifiez le fichier manifeste 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 fichier JSON correctement formaté pour que l'interface s'affiche sous forme de cartes.
Vous devez également mettre en œuvre 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 l'authentification OAuth pour ce service.
Créer des fiches
Pour définir une interface utilisateur 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 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 des 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 élément CardHeader et un ou plusieurs éléments CardSections. Vous devez remplir chaque section de fiche 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.
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 qui nécessitent 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 du sommet. Autrement dit, vous devez utiliser l'ordre de construction suivant:
- Créez le widget.
- Ajouter le widget à la section "Fiche".
- Répétez l'opération jusqu'à ce que la section des fiches contienne tous ses widgets.
- Ajoutez la section "Fiche" à la fiche.
Cette étape 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. Les modifications que vous apportez à l'objet widget après son ajout ne sont pas répercutées dans la fiche finale.
Actions universelles
Vous pouvez utiliser des actions universelles pour fournir des fonctionnalités indépendantes 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 pour le compte d'un utilisateur. Il est recommandé que les modules complémentaires ne disposent de champs d'application que pour les actions dont ils ont besoin pour fonctionner dans l'ordre, et rien de plus.
Dans les projets de modules complémentaires, définissez explicitement leurs champs d'application 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 son fichier manifeste.
Pour en savoir plus, consultez la section Champs d'application.
Tester le module complémentaire
Vous pouvez tester les modules complémentaires dont la publication a été annulée en commençant par installer le module complémentaire non publié. Une fois le module complémentaire installé et autorisé, vous pouvez l'utiliser 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 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 à d'autres utilisateurs, qu'ils soient publics ou uniquement accessibles aux utilisateurs de votre domaine. Avant de commencer le processus de publication, veillez à consulter la présentation des publications. La publication est un processus complexe qui nécessite une préparation et du temps pour terminer.
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 d'application avant leur publication.
Pour en savoir plus, consultez Publier le module complémentaire Google Workspace.