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. Configurer les projets de votre module complémentaire et choisir un propriétaire et collaborateurs.
2. Concevez l'apparence et le comportement de votre module complémentaire.
3. Configurer le fichier manifeste de projet du module complémentaire ou ressource de déploiement.
4. Rédiger le code qui définit l'apparence du module complémentaire comportemental.
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.

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 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 que Apps Script, il vous suffit de créer un projet Google Cloud.

Avant de commencer à développer des modules complémentaires, choisissez-en un compte utilisateur propriétaire des projets et décide des autres comptes 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 contribuer au codage et aux tests.

Avertissement :Si vous n'ajoutez pas de collaborateurs à votre module complémentaire, vous devez impérativement en transférer la propriété avant que compte clôturé ou supprimé. Sinon, vous risquez de perdre l'accès du code et des paramètres complémentaires.

Projets Apps Script

Vous pouvez créer le script Apps Script de votre module complémentaire d'un projet partagé conduire afin que 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. du 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 garantir qu'un membre de votre équipe a toujours accès les paramètres Google 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. Démarrer avec une conception simple pour commencer, puis ajouter plus de perfectionnements.

<ph type="x-smartling-placeholder">

</ph> Conseil:Commencez par un fiche de la page d'accueil, puis ajoutez des widgets, des cartes, des fonctionnalités de navigation et d'autres comportements. Vous pouvez également tenir compte des fiches contextuelles déclenchées par l'action d'un utilisateur sur l'hôte application, comme ouvrir un <ph type="x-smartling-placeholder"></ph> Fil de discussion Gmail ou Événement d'agenda

Reportez-vous au guide de style du module complémentaire Google Workspace. pour obtenir des consignes sur la conception de l'utilisateur expérience.

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 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 les informations dont l'application hôte a besoin pour afficher du module complémentaire.

Consultez la section Fichiers manifestes pour savoir comment configurer votre le fichier manifeste du module complémentaire dans Apps Script.

Lorsque vous ajoutez du code et des fonctionnalités à votre module complémentaire, modifiez le manifeste au besoin pour produire le module complémentaire requis leur apparence et leur comportement.

Coder le module complémentaire

Vous devez implémenter une interface basée sur des cartes pour un 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 les déclencheurs fonctions 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.

Créer des cartes

Pour définir l'interface utilisateur d'un module complémentaire, des objets Card et les remplir de de widgets. Déclencher les fonctions spécifiées dans votre fichier manifeste doit renvoyer un seul un objet Card ou un tableau de Objets Card qui représentent 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 du CardBuilder. Chaque carte requiert un CardHeader et un ou plusieurs CardSections Vous devez remplir chaque section de carte avec les widgets individuels qui composent le de ce module complémentaire. Interaction des widgets, sont généralement liées à 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.

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. Les fonctions de déclenchement, par exemple doit renvoyer des objets Card. Clients connus : CardBuilder génère une erreur.

Vous pouvez utiliser d'autres applications Apps Script intégrées services 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 nécessitant OAuth, vous : doit configurer ce service et s'y connecter. Pour en savoir plus, consultez la section Guide des services autres que Google pour plus de détails.

Ordre de construction

Lorsque vous créez une carte, vous devez partir de la pile. 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 correspondante à 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 après leur ajout. Si vous si vous souhaitez modifier un widget ajouté, vous devez recréer la section ou la fiche auquel 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 disponible dans l'UI du module complémentaire, quelle que soit la carte affiché. Toutes les actions universelles définies apparaissent toujours dans le dans le menu de la fiche du module complémentaire.

Pour en savoir plus, consultez l'article Actions universelles. plus de détails.

Vérifier les habilitations OAuth du module complémentaire

Les champs d'application définissent les actions peut prendre pour le compte d'un utilisateur. Il s'agit d'un une bonne pratique pour que les modules complémentaires n'aient de portée que pour les actions qu'ils doivent avoir dans l’ordre et rien de plus.

Dans les projets de modules complémentaires, définissez explicitement le module complémentaire champs d'application afin de s'assurer le module complémentaire utilise 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 Champs d'application.

Tester le module complémentaire

Vous pouvez tester les modules complémentaires non publiés en installant d'abord le non publié du 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 s'é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

En publiant votre module complémentaire, vous le rendez disponible pour d'autres personnes. que ce soit publiquement ou uniquement aux utilisateurs de votre domaine. Avant de commencer la publication processus, veillez à consulter 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. Accessible publiquement les modules complémentaires doivent faire l'objet d'un examen de l'application au préalable avant leur publication.

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