Créer des modules complémentaires Google Workspace

Cette page explique comment concevoir, créer et publier des modules complémentaires Google Workspace. Elle décrit les étapes suivantes :

1. Déterminez les applications Google Workspace dans lesquelles vous souhaitez que votre module complémentaire soit disponible pour les utilisateurs.
2. Configurez les projets de votre module complémentaire, puis choisissez un propriétaire et des collaborateurs.
3. Concevez et configurez l'apparence et le comportement de votre module complémentaire.
4. Créez le module complémentaire.
5. Vérifiez les niveaux d'accès OAuth de votre module complémentaire.
6. Testez le module complémentaire dans une ou plusieurs applications Google Workspace.
7. Publiez le module complémentaire.

Vous pouvez créer un module complémentaire avec Apps Script ou HTTP. Pour une comparaison, regardez la vidéo "Apps Script vs. HTTP endpoints: Which should you choose? 🤔".

Choisir les 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 Chat
• Google Docs
• Google Drive
• Google Meet
• Google Sheets
• Google Slides

Pour savoir comment créer des applications pour Google Workspace, consultez Étendre l'interface utilisateur Google Workspace.

Configurer les projets de votre module complémentaire, puis 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, vous n'avez besoin de créer qu'un projet Google Cloud.

Avant de commencer à développer un module complémentaire, choisissez un seul compte utilisateur pour posséder les projets et décidez quels autres comptes 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 aider à la programmation et aux tests.

Avertissement : Si vous n'ajoutez pas de collaborateurs à vos projets de module complémentaire, il est essentiel que vous leur transfériez la propriété avant que le compte du propriétaire ne soit désactivé 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

Avant de créer votre module complémentaire, consultez les quotas et les limites d'Apps Script pour vous assurer que la conception de votre projet est conforme à ces consignes. Apps Script est idéal pour le développement léger de modules complémentaires personnels ou internes avec une petite base d'utilisateurs. Si vous prévoyez de créer un module complémentaire à grande échelle qui doit gérer de nombreux utilisateurs, nécessite une faible latence ou exige un contrôle total de votre infrastructure, envisagez de le développer dans un autre environnement d'exécution.

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 le seul propriétaire. En plaçant le fichier de script de votre 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 fait office d'é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 et configurer l'apparence et le comportement de votre module complémentaire

Avant de commencer à créer votre module complémentaire, décidez de son apparence et de son comportement. 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 à travailler, puis ajoutez des améliorations.

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

Pour obtenir des conseils sur la conception de l'expérience utilisateur de votre module complémentaire, consultez le guide de style des modules complémentaires Google Workspace.

Configurer le fichier manifeste du module complémentaire

Une fois que vous avez conçu votre module complémentaire, vous pouvez commencer à implémenter la conception dans le fichier manifeste du module complémentaire. C'est dans le fichier manifeste que vous configurez la plupart de l'apparence et du comportement du module complémentaire, y compris les applications hôtes Google Workspace que le module complémentaire étend.

Pour en savoir plus, consultez Fichiers manifestes pour les modules complémentaires Google Workspace.

À mesure que 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.

Configurer l'apparence et le comportement de l'application Google Chat

Si vous avez conçu un module complémentaire qui étend Google Chat, vous devez utiliser l'API Google Chat pour configurer l'apparence et le comportement d'une application Chat. Pour connaître la procédure à suivre, consultez Configurer une application Google Chat.

Créer le module complémentaire

Vous devez implémenter une interface basée sur des fiches pour le module complémentaire. Utilisez le service de fiches d'Apps Script ou, si vous écrivez dans un autre langage de programmation, renvoyez un JSON correctement formaté pour que l'interface s'affiche sous forme de fiches.

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 non Google à l'aide d'OAuth, vous devez également configurer OAuth pour ce service.

Construire des fiches

Vous définissez une interface utilisateur de module complémentaire en créant Card objets et en les remplissant avec 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 de l'utilisateur.

Dans Apps Script, vous créez des fiches à l'aide de la CardBuilder classe. Chaque fiche nécessite CardHeader et une 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 lié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.

Remarque : Si vous n'appelez pas build() après avoir utilisé des classes de compilation dans le service de fiches, des erreurs de type se produisent. Les fonctions de déclencheur, par exemple, doivent renvoyer des objets Card. Le renvoi d'CardBuilder objets entraîne une erreur.

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 module complémentaire que vous créez. Vous pouvez utiliser des données récupérées à partir de services non Google.

Si votre module complémentaire a besoin d'accéder à des API non 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 non Google .

Ordre de construction

Lorsque vous créez une fiche, vous devez la construire de haut en bas. Vous devez donc utiliser l'ordre de construction suivant :

1. Créez le widget.
2. Ajoutez le widget à la section de la fiche.
3. Répétez l'opération jusqu'à ce que la section de la fiche contienne tous ses widgets.
4. 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. Les modifications que vous apportez à l'objet widget après l'avoir ajouté ne sont pas reflétées dans la fiche finale.

**Avertissement** : N'ajoutez un widget à une fiche ou à une section de fiche qu'une fois que vous avez terminé de le créer. N'ajoutez une section de fiche à une fiche qu'une fois qu'elle a été entièrement remplie avec ses widgets. Ne modifiez pas les widgets ni les sections après les avoir 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 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 s'affichent toujours dans le menu de la fiche du module complémentaire.

Pour en savoir plus, consultez Actions universelles.

Vérifier les niveaux d'accès OAuth du module complémentaire

Les niveaux d'accès 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 des niveaux d'accès nécessaires à leur fonctionnement.

Dans les projets de module complémentaire, définissez explicitement les niveaux d'accès du module complémentaire pour vous assurer qu'il utilise l'ensemble de niveaux d'accès le moins permissif possible. Vous définissez les niveaux d'accès utilisés par votre module complémentaire dans le fichier manifeste du module complémentaire.

Pour en savoir plus, consultez Niveaux d'accès.

Tester le module complémentaire

Vous pouvez tester les modules complémentaires non publiés en les installant d'abord non publiés module complémentaire. 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 commencer à tester votre module complémentaire, consultez les guides suivants :

• Tester et déboguer des modules complémentaires Google Workspace Apps Script
• Tester et déboguer le code HTTP de modules complémentaires Google Workspace
• Tester les fonctionnalités interactives des applications Google Chat

Publier le module complémentaire

La publication de votre module complémentaire le met à la disposition d'autres personnes, publiquement ou uniquement des 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 de la préparation et du temps.

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

Pour en savoir plus, consultez Publier un module complémentaire Google Workspace pour plus de détails.