Si vous avez déjà créé et publié un module complémentaire pour étendre Gmail ou Agenda, vous pouvez le convertir en module complémentaire Google Workspace. Les instructions de cette page expliquent en détail comment ajouter les fonctionnalités Google Workspace à vos modules complémentaires Gmail ou Agenda existants, puis publier votre module complémentaire mis à niveau pour qu'il soit visible et installé.
Vous pouvez transférer la nouvelle fonctionnalité dans votre module complémentaire d'origine pour conserver votre fiche Google Workspace Marketplace, vos installations et vos utilisateurs. Cette mise à niveau vous permet également de profiter des nouvelles fonctionnalités du module complémentaire Google Workspace, telles que les pages d'accueil.
Étape 1: Créez une copie du projet Apps Script de votre module complémentaire
Votre module complémentaire mis à niveau utilise le même projet Google Cloud que le module complémentaire publié, mais il est important de créer et d'utiliser une copie du projet Apps Script sous-jacent afin que vos utilisateurs existants ne soient pas affectés lorsque vous testez la version mise à niveau. La mise à niveau d'une copie du projet de script d'origine signifie également que vous pouvez toujours accéder au code d'origine et que vous pouvez le redéployer plus tard si nécessaire.
- Ouvrez le projet Apps Script de votre module complémentaire Gmail ou de votre module complémentaire de conférence Agenda existant.
- À gauche, cliquez sur Vue d'ensemble .
- À droite, cliquez sur Créer une copie .
- Sur la gauche, cliquez sur Paramètres du projet > Changer de projet.
- Cliquez sur Numéro de projet GCP.
- Saisissez le même numéro de projet que celui associé à votre projet Apps Script publié existant.
- Cliquez sur Définir un projet.
Étape 2: Intégrez le module complémentaire Google Workspace
Vous devez concevoir et implémenter les fonctionnalités du module complémentaire Google Workspace que vous souhaitez y ajouter.
- Planifiez le contenu à afficher dans les fiches de la page d'accueil de votre module complémentaire et indiquez si elles doivent apparaître dans Gmail, Agenda, Drive ou une combinaison des trois hôtes. Si vous souhaitez une page d'accueil sur plusieurs hôtes, décidez s'il peut s'agir de la même page d'accueil ou de fiches de page d'accueil personnalisées pour chaque hôte.
- Dans le projet Apps Script que vous avez copié, créez les fiches de votre page d'accueil à l'aide des fonctions
homepageTrigger. Veillez à inclure toutes les fonctions ou logiques de soutien nécessaires pour contrôler vos nouvelles interfaces de page d'accueil. Pensez à ajouter des fiches contextuelles déclenchées par l'action d'un utilisateur, comme l'ouverture d'un thread de message Gmail ou d'un événement d'agenda.
Mettez à jour tout accès aux objets d'événement dans votre module complémentaire (dans les fonctions de rappel de widget ou dans les fonctions de déclencheur contextuel) pour utiliser la structure d'objet d'événement mise à jour. La nouvelle structure contient toujours les mêmes champs d'objet d'événement que ceux utilisés par les modules complémentaires de conférence Gmail et Agenda, mais ces champs d'origine sont obsolètes et seront à terme supprimés.
Étape 3: Mettez à jour le fichier manifeste de votre module complémentaire
La manière dont les informations de configuration sont stockées dans la structure du fichier manifeste des modules complémentaires Google Workspace a considérablement changé par rapport à la structure utilisée par les modules complémentaires Gmail et les modules complémentaires de conférence Agenda. Lorsque vous mettez à niveau votre module complémentaire, vous devez mettre à jour les champs du fichier manifeste du projet Apps Script du module complémentaire conformément aux tableaux ci-dessous. Vous devez mettre à jour toutes les sous-propriétés pertinentes pour qu'elles correspondent à la nouvelle propriété addOns.
Veillez également à mettre à jour le champ oauthScopes de votre fichier manifeste si nécessaire afin de refléter les autorisations requises par votre module complémentaire mis à jour.
Pour en savoir plus sur les fichiers manifestes des modules complémentaires Google Workspace, consultez Fichiers manifestes.
Modules complémentaires Gmail
| Champ du fichier manifeste d'origine | Action requise |
|---|---|
gmail.composeTrigger |
Déplacer vers addOns.gmail.composeTrigger. |
gmail.contextualTriggers[] |
Déplacez la liste vers addOns.gmail.contextualTriggers[]. |
gmail.logoUrl |
Déplacer vers addOns.common.logoUrl. |
gmail.name |
Déplacer vers addOns.common.name. |
gmail.openLinkUrlPrefixes[] |
Déplacez la liste vers addOns.common.openLinkUrlPrefixes[].
|
gmail.primaryColor |
Déplacer vers addOns.common.layoutProperties.primaryColor. |
gmail.secondaryColor |
Déplacer vers addOns.common.layoutProperties.secondaryColor.
|
gmail.universalActions[] |
Déplacez la liste vers addOns.common.universalActions[]. |
gmail.universalActions[].text |
Déplacez chaque champ gmail.universalActions[].text vers un champ addOns.common.universalActions[].label correspondant. |
gmail.useLocalFromApp |
Déplacer vers addOns.common.useLocaleFromApp. |
Modules complémentaires des conférences Agenda
| Champ du fichier manifeste d'origine | Action requise |
|---|---|
calendar.createSettingsUrlFunction |
Déplacer vers addOns.calendar.createSettingsUrlFunction. |
calendar.conferenceSolution[] |
Déplacer vers addOns.calendar.conferenceSolution[]. |
calendar.logoUrl |
Déplacer vers addOns.common.logoUrl. |
calendar.name |
Déplacer vers addOns.common.name. |
Étape 4: Testez le module complémentaire mis à niveau
Pour tester votre module complémentaire mis à niveau avant de le publier, consultez Tester les modules complémentaires Google Workspace.
Étape 5: Demandez l'examen de votre module complémentaire mis à jour
Tous les modules complémentaires Google Workspace, qu'ils soient mis à niveau ou créés entièrement, doivent être approuvés pour pouvoir être listés dans Google Workspace Marketplace.
Pour demander l'examen de votre module complémentaire, procédez comme suit:
Assurez-vous que votre module complémentaire remplit toutes les exigences de publication des modules complémentaires.
Créez un déploiement avec versions gérées de votre module complémentaire Google Workspace (dans le nouveau projet Apps Script) à l'aide de la version du code que vous souhaitez publier. N'essayez pas de publier à l'aide d'un déploiement principal.
Si vous avez ajouté de nouveaux champs d'application lors de la mise à niveau de votre module complémentaire, vous devez demander la validation OAuth. Par exemple, si votre module complémentaire Gmail utilise de nouveaux champs d'application Drive ou Agenda dans la version du module complémentaire Google Workspace, vous devez faire valider ces nouveaux champs d'application. La validation prend souvent quelques jours. Nous vous conseillons donc de commencer le processus le plus tôt possible. Assurez-vous que votre module complémentaire est validé avant de passer à l'étape 6.
Étape 6: Disponibilité du module complémentaire mis à niveau
Ouvrez le SDK Google Workspace Marketplace.
Sur la gauche, cliquez sur Configuration. Ce panneau contient un formulaire dans lequel vous fournissez des informations sur votre module complémentaire.
Mettez à jour la brève description, la description détaillée et les captures d'écran de votre fiche pour refléter les nouvelles fonctionnalités du module complémentaire Google Workspace.
Sous Extensions, cliquez sur le bouton Passer au module complémentaire Google Workspace. Dans la zone de texte qui s'affiche, saisissez le nouvel ID de déploiement que vous avez créé pour votre module complémentaire Google Workspace à l'étape précédente. Si votre ID de déploiement est valide, la liste des hôtes compatibles s'affiche.
Si vous avez ajouté de nouveaux champs d'application à votre module complémentaire Google Workspace, veillez à les ajouter à la section Champs d'application OAuth 2.0 de la page Configuration. Les champs d'application répertoriés dans cette section doivent correspondre exactement à ceux indiqués dans le fichier manifeste de votre module complémentaire.
Vérifiez que les informations saisies dans le formulaire sont correctes. Cliquez ensuite sur Enregistrer les modifications.
Si vous avez des questions ou rencontrez un problème lors de la mise à niveau d'un module complémentaire Google Workspace, contactez-nous.
Questions fréquentes
Vous trouverez ci-dessous les questions fréquentes concernant les mises à niveau des modules complémentaires:
Puis-je mettre à jour mon module complémentaire Editor ?
La plupart des modules complémentaires des éditeurs peuvent être déplacés vers les modules complémentaires Google Workspace. Toutefois, ils ne peuvent pas être mis à niveau vers des modules complémentaires Google Workspace aussi facilement que des modules complémentaires pour Gmail et Agenda.
Si vous souhaitez migrer votre module complémentaire d'éditeur vers un module complémentaire Google Workspace, vous devez réécrire l'UI du module complémentaire au format HTML vers une interface basée sur des fiches, puis mettre à jour la gestion du code JavaScript vers le service de carte.
Il est possible que certains services de votre module complémentaire d'éditeur existant ne soient pas disponibles dans le service de carte. Par exemple, si votre module complémentaire d'éditeur inclut un sélecteur de fichier, aucun équivalent n'est disponible dans le service Card pour les modules complémentaires Google Workspace.
Puis-je créer un module complémentaire Google Workspace distinct et conserver mon module complémentaire existant ?
Vous pouvez créer des modules complémentaires Google Workspace supplémentaires sous des marques différentes, mais nous n'autorisons pas les modules complémentaires de conférence Gmail ou Agenda distincts qui portent le même nom que votre module complémentaire Google Workspace. Si vous avez des questions ou souhaitez demander une dérogation, contactez-nous.
Mes utilisateurs devront-ils autoriser à nouveau le module complémentaire après sa mise à niveau ?
Tant que votre module complémentaire Google Workspace utilise le même projet Cloud Platform (GCP) sous-jacent, avec un ID client OAuth associé, vos utilisateurs n'auront pas besoin d'accorder à nouveau les autorisations qu'ils ont déjà autorisées pour votre module complémentaire d'origine. Toutefois, si vous ajoutez de nouveaux champs d'application au cours du processus de mise à niveau, vos utilisateurs doivent les autoriser la première fois qu'ils utilisent la version Google Workspace de votre module complémentaire.
Puis-je convertir mon extension Chrome en module complémentaire Google Workspace et transférer des utilisateurs ?
Non. Vous ne pouvez pas transférer les utilisateurs, les installations ni les avis associés à une extension Chrome. Vous devez créer un module complémentaire Google Workspace et rediriger les utilisateurs de votre extension Chrome vers Google Workspace Marketplace.
Puis-je regrouper plusieurs modules complémentaires avec mon module complémentaire Google Workspace ?
Consultez Répertorier les intégrations d'applications au même endroit.