Créer des modules complémentaires Google Workspace

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Pour créer un Google Workspace module complémentaire, procédez comme suit:

  1. Configurez les projets de votre module complémentaire et choisissez un propriétaire et des collaborateurs.
  2. Concevez l'apparence et le comportement de votre module complémentaire.
  3. Configurez le fichier manifeste ou la ressource de déploiement du module complémentaire.
  4. Rédigez le code permettant de définir l'apparence et le comportement du module complémentaire.
  5. Vérifiez les champs d'application OAuth de votre module complémentaire.
  6. Testez le module complémentaire dans les applications hôtes auxquelles il s'applique.
  7. 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 allez créer 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 suffira de créer un projet Google Cloud.

Avant de commencer à développer des modules complémentaires, choisissez un seul compte utilisateur pour être propriétaire des projets et décider quels autres comptes sont 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 vous aider à coder et à tester.

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 soit propriétaire unique. En plaçant votre fichier de script complémentaire 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 fait office d'éditeur. Le compte de publication doit être autorisé à modifier le projet de script, mais il n'a pas besoin d'en être le propriétaire.

Projets Google Cloud

Nous vous recommandons d'ajouter des collaborateurs au projet Cloud du module complémentaire. Ainsi, les membres de votre équipe peuvent toujours accéder aux paramètres cloud du module complémentaire.

Concevoir l'apparence et le comportement de votre module complémentaire

Choisissez l'apparence du 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 fournir des solutions. Commencez par une conception simple pour commencer, puis ajoutez d'autres filtres.

Reportez-vous au Google Workspace Guide de style pour les modules complémentaires 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 de 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 Google Workspace modules complémentaires, 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 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 du module complémentaire.

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 mis en forme 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 non-Google via OAuth, vous devez également configurer OAuth pour ce service.

Construction de cartes

Pour définir une interface utilisateur complémentaire, vous devez créer des objets Card et les remplir 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 qui représentent 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 créez des fiches à l'aide de la classe CardBuilder. Chaque carte nécessite un CardHeader et un ou plusieurs CardSections. Vous devez remplir chaque section de la 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 complémentaires que vous créez. Vous pouvez utiliser les données extraites de services autres que Google.

Si votre Google Workspace module complémentaire a besoin d'accéder à des API autres que Google qui nécessitent OAuth, vous devez le configurer et vous y connecter. Consultez le guide Se connecter à des services autres que Google pour en savoir plus.

Ordre de construction

Lorsque vous créez une carte, vous devez la créer de haut en bas. Autrement dit, vous devez utiliser cet 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 de la fiche contienne tous ses widgets.
  4. Ajoutez la section de la fiche à celle-ci.

En effet, 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 reflété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'UI 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 niveaux d'accès 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 n'aient que des champs d'application pour les actions devant être exécutées dans l'ordre, et rien d'autre.

Dans les projets de module complémentaire, définissez explicitement les niveaux d'accès du module complémentaire pour vous assurer que celui-ci utilise 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 le fichier manifeste.

Pour en savoir plus, consultez Champs d'application.

Tester le module complémentaire

Vous pouvez tester les modules complémentaires non publiés en installant le 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 étendues. Vous devez vérifier que le module complémentaire se comporte comme prévu pour les contextes et les actions des utilisateurs.

Pour en savoir plus, consultez la page Tester les Google Workspace modules complémentaires.

Publier le module complémentaire

En publiant votre module complémentaire, vous le rendez accessible à d'autres utilisateurs, qu'ils soient publics ou seuls les 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.

Google Workspace Les modules complémentaires sont publiés sur Google Workspace Marketplace. Les modules complémentaires accessibles au public doivent effectuer un examen de l'application avant leur publication.

Pour en savoir plus, consultez Module complémentaire Google Workspace Publication.

Google Workspace Exemple de module complémentaire

 l10n-placeholder41=.

Pour vous aider à comprendre Google Workspace les modules complémentaires, Google Workspace ce guide de démarrage rapide montre comment créer un module Google Workspace simple, y compris un service de cartes, des connexions Une fois le guide de démarrage rapide terminé, vous pouvez installer le module complémentaire et tester le code.