Créer des modules complémentaires Google Workspace

Lorsque vous souhaitez créer un module complémentaire Google Workspace, procédez comme suit : procédure:

1. Configurez les projets de votre module complémentaire, puis choisissez un propriétaire et des collaborateurs.
2. Concevez l'apparence et le comportement de votre module complémentaire.
3. Configurez le fichier manifeste du projet ou la ressource de déploiement de l'extension.
4. Écrivez du code pour définir l'apparence et le comportement du module complémentaire.
5. Vérifiez les habilitations OAuth de votre module complémentaire.
6. Testez le module complémentaire dans la applications hôtes qu'elle s'étend.
7. 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 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.

Avertissement : Si vous n'ajoutez pas de collaborateurs à vos projets de modules complémentaires, vous devez absolument en transférer la propriété avant que le compte du propriétaire ne soit clôturé ou supprimé. Sinon, vous risquez de perdre complètement l'accès au code et aux paramètres du module complémentaire.

Projets Apps Script

Vous pouvez créer le script Apps Script de votre module complémentaire d'un projet partagé conduire afin qu'aucune qu'un seul compte en est propriétaire. Placer votre module complémentaire d'un fichier de script dans un Drive partagé s'assure que plusieurs collaborateurs ont accès le projet de script.

Lorsque vous publiez un module complémentaire, un seul compte utilisateur en tant qu'éditeur. Le compte de publication doit être autorisé à modifier le script. projet, mais il n'est pas nécessaire qu'il en soit 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 modules complémentaires Google Cloud. 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 ressemblera votre module complémentaire et comment elle doit se comporter avant de commencer à la construire. Réfléchissez aux cas d'utilisation doit tenter de fournir des solutions. Commencez par une conception simple pour commencer à travailler, puis ajoutez des améliorations.

Conseil : Commencez par une fiche de page d'accueil simple, puis ajoutez des widgets, des fiches, des éléments de navigation et d'autres comportements. Vous pouvez également envisager des cartes contextuelles déclenchées par l'action d'un utilisateur dans l'application hôte, comme l'ouverture d'un fil de discussion Gmail ou d'un événement Agenda.

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 sa bibliothèque les dépendances. 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.

Pour savoir comment configurer le fichier manifeste de votre module complémentaire dans Apps Script, consultez la section Fichiers manifestes.

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. Utiliser des scripts Apps Script service de cartes ou, si vous écrivez dans un autre langage de code, renvoyez 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 se connecte à un service tiers autre que Google avec OAuth, vous devez configurer OAuth pour Google Cloud.

Cartes de construction

Vous définissez une interface utilisateur de module complémentaire en créant des objets Card et en les remplissant de 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 peut également créer et afficher des fiches dans en réponse aux actions de l'utilisateur.

Dans Apps Script, vous créez des fiches à l'aide de la classe CardBuilder. Chaque carte requiert 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. Interaction les widgets sont généralement liées à 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.

Remarque :Si vous ne parvenez pas à appeler build() après avoir utilisé des classes de compilateur dans la classe Le service de cartes génère des erreurs de type. Par exemple, les fonctions de déclencheur doivent renvoyer des objets Card. Si vous renvoyez des objets CardBuilder à la place, une erreur se produit.

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 votre module complémentaire a besoin d'accéder à des API autres que Google OAuth, vous devez le configurer et vous y connecter. Pour en savoir plus, consultez Guide sur la connexion à des services autres que Google pour en savoir plus.

Ordre de construction

Lorsque vous créez une fiche, vous devez le faire de haut en bas. Autrement dit, vous devez utiliser cette ordre de construction:

1. Créez le widget.
2. Ajoutez le widget à la section des fiches.
3. Répétez l'opération jusqu'à ce que la section "Fiche" comporte tous ses widgets.
4. Ajoutez la section correspondant à la fiche.

Cela est nécessaire, car lorsque vous ajoutez un widget à une fiche ou à une section de fiche, ajoutent en fait une copie de ce widget. Toute modification apportée au widget après l'avoir ajouté ne sont pas reflétés dans la fiche finale.

Avertissement :N'ajoutez un widget à une fiche ou à une section de fiches qu'après avoir terminé. le construire. N'ajoutez une section Fiche à une fiche qu'après avoir été entièrement remplie avec ses widgets. Ne modifiez pas les widgets ni les sections une fois qu'ils ont été ajoutés. Si vous souhaitez modifier un widget ajouté, vous devez recréer la section ou la fiche à laquelle il a été ajouté.

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 disponible dans l'UI du module complémentaire, quelle que soit la carte affiché. 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 habilitations 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 niveaux d'accès que votre module complémentaire utilise le module complémentaire manifest.

Pour en savoir plus, consultez la section Champ d'application.

Tester le module complémentaire

Vous pouvez tester les modules complémentaires dont la publication a été annulée en installant d'abord non publié du module complémentaire. 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 attendu 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 la préparation et le temps nécessaires.

Les modules complémentaires Google Workspace sont publiés sur Google Workspace Marketplace. Les modules complémentaires disponibles publiquement doivent être soumis à un examen de l'application avant d'être publiés.

Consultez l'article Publier un module complémentaire Google Workspace pour en savoir plus plus de détails.