Créer des modules complémentaires Google Workspace

Découvrez comment concevoir, créer et publier des modules complémentaires Google Workspace :

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 et 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.

Créez un module complémentaire avec Apps Script ou HTTP. Pour comparer les deux, 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 créer des applications pour Google Workspace, consultez Étendre l'UI Google Workspace.

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 langue autre qu'Apps Script, vous n'avez qu'à créer un projet Google Cloud.

Pour créer un module complémentaire, vous devez configurer un projet de script et un projet Cloud.

Avant de commencer à développer un module complémentaire, choisissez un seul compte utilisateur pour posséder les projets et décider quels autres comptes sont 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 modules complémentaires, transférez-en la propriété avant que le compte du propriétaire ne soit clôturé ou supprimé. Sinon, vous risquez de perdre 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 limites d'Apps Script pour aligner la conception de votre projet sur 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 votre module complémentaire nécessite une assistance pour de nombreux utilisateurs, une faible latence ou un contrôle total de votre infrastructure, envisagez d'utiliser un autre environnement d'exécution.

Créez 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. Placer le fichier de script de votre module complémentaire dans un Drive partagé permet à tous les collaborateurs d'accéder au projet de script.

Lorsque vous publiez un module complémentaire, un seul compte utilisateur est l'éditeur. Le compte de publication doit disposer d'un accès Éditeur 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

Ajoutez des collaborateurs au projet Cloud du module complémentaire. Cela permet à votre équipe d'accéder en permanence 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

Décidez de l'apparence et du comportement de votre module complémentaire avant de le créer. Déterminez les cas d'utilisation que le module complémentaire résout. Commencez par un design de base pour vous familiariser avec l'outil, puis ajoutez des détails.

Conseil : Commencez par une fiche de page d'accueil de base, puis ajoutez d'autres widgets, fiches, éléments de navigation et autres comportements. Pensez aux cartes contextuelles qu'une action utilisateur dans l'application hébergée déclenche, 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 consignes sur la conception de l'expérience utilisateur de votre module complémentaire.

Configurer le fichier manifeste du module complémentaire

Implémentez la conception dans le fichier manifeste du module complémentaire. Configurez l'apparence et le comportement du module complémentaire dans le fichier manifeste, y compris les applications hôtes Google Workspace que le module complémentaire étend.

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

À mesure que vous ajoutez du code et des fonctionnalités, mettez à jour le fichier manifeste si nécessaire pour définir l'apparence et le comportement requis du module complémentaire.

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

Si vous concevez un module complémentaire qui étend Google Chat, utilisez l'API Google Chat pour configurer l'apparence et le comportement d'une application Chat. Pour connaître la procédure à suivre, consultez Utiliser l'API Google Chat.

Créer le module complémentaire

Implémentez une interface basée sur des cartes pour le module complémentaire. Utilisez Card service ou, si vous utilisez un autre langage de programmation, renvoyez un fichier JSON mis en forme pour que l'interface s'affiche sous forme de fiches.

Implémentez les fonctions de déclenchement spécifiées dans le fichier manifeste du module complémentaire. Si votre module complémentaire se connecte à un service tiers à l'aide d'OAuth, configurez OAuth pour ce service.

Cartes de construction

Définissez une interface utilisateur de module complémentaire en créant des objets Card et en ajoutant 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 qui représentent différentes "pages" de l'interface du module complémentaire. Le module complémentaire peut également créer et afficher de nouvelles fiches en réponse aux actions de l'utilisateur.

Dans Apps Script, créez des fiches à l'aide de la classe CardBuilder. Chaque fiche nécessite un CardHeader et un ou plusieurs CardSections. Remplissez chaque section de carte avec les widgets individuels qui composent l'interface. 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 carte via son CardBuilder, appelez CardBuilder.build pour créer l'objet Card correspondant.

Remarque : Si vous n'appelez pas build après avoir utilisé des classes de création dans le service Card, des erreurs de type se produiront. Les fonctions de déclencheur doivent renvoyer des objets Card. Le renvoi d'objets CardBuilder génère une erreur.

Utilisez les services Apps Script intégrés](/apps-script/guides/services/) tels que CalendarApp pour récupérer les informations à afficher dans les fiches du module complémentaire. Utiliser des données provenant de services n'appartenant pas à Google

Si votre module complémentaire a besoin d'accéder à des API non Google qui nécessitent OAuth, configurez-le et connectez-le à ce service. Pour en savoir plus, consultez le guide de connexion aux services non Google.

Ordre de construction

Lorsque vous créez une carte, commencez par le haut. Utilisez cet ordre de construction :

1. Créez le widget.
2. Ajoutez le widget à la section de la carte.
3. Répétez l'opération jusqu'à ce que la section de cartes contienne tous ses widgets.
4. Ajoutez la section de carte à la carte.

En effet, lorsque vous ajoutez un widget à une fiche ou à une section de fiche, vous ajoutez en réalité 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 : Ajoutez un widget à une fiche ou à une section de fiche après l'avoir créée. Ajoutez une section de carte à une carte une fois qu'elle est entièrement remplie de widgets. Ne modifiez pas les widgets ni les sections une fois qu'ils ont été ajoutés. Pour modifier un widget ajouté, recréez la section ou la fiche.

Actions universelles

Utilisez des actions universelles pour fournir des fonctionnalités indépendantes du contexte. Les actions universelles sont des éléments de menu disponibles dans l'UI du module complémentaire, quelle que soit la fiche. Toutes les actions universelles définies s'affichent 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 scopes définissent les actions que le module complémentaire peut effectuer au nom d'un utilisateur. Les modules complémentaires ne doivent disposer que des niveaux d'accès dont ils ont besoin pour fonctionner.

Dans les projets de modules complémentaires, définissez les champs d'application du module complémentaire pour vous assurer qu'il utilise l'ensemble de champs d'application le moins permissif possible. Définissez les champs d'application dans le fichier manifeste du module complémentaire.

Pour en savoir plus, consultez Scopes.

Tester le module complémentaire

Vous pouvez tester les modules complémentaires non publiés en installant d'abord le module complémentaire non publié. Une fois le module complémentaire installé et autorisé, utilisez-le dans votre compte pour tester son apparence et son comportement dans les applications hôtes qu'il étend. Vérifiez que le module complémentaire se comporte comme prévu pour les contextes et les actions utilisateur.

Pour commencer à tester votre module complémentaire, consultez les guides suivants :

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

Publier le module complémentaire

La publication permet de rendre votre module complémentaire disponible pour les autres utilisateurs. Avant de publier, consultez la vue d'ensemble de la publication. La publication est un processus complexe qui nécessite une préparation.

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

Pour en savoir plus, consultez Publier un module complémentaire Google Workspace.