Si vous avez déjà créé et publié un module complémentaire pour étendre Gmail ou Agenda, vous pouvez le mettre à niveau vers un module complémentaire Google Workspace. Les instructions de cette page expliquent comment ajouter des fonctionnalités Google Workspace à vos modules complémentaires Gmail ou Agenda existants, puis comment publier votre module complémentaire mis à niveau pour qu'il puisse être trouvé et installé.
Vous pouvez transférer la nouvelle fonctionnalité dans votre module complémentaire d'origine pour conserver votre fiche, vos installations et vos utilisateurs Google Workspace Marketplace. La mise à niveau vous permet également de profiter des nouvelles fonctionnalités des modules complémentaires Google Workspace, comme 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 votre module complémentaire publié. Toutefois, 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 pendant que 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 le redéployer ultérieurement si nécessaire.
- Ouvrez votre projet Apps Script de module complémentaire Gmail ou de module complémentaire de visioconférence Agenda existant.
- Sur la 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 associé à votre projet Apps Script de module complémentaire existant et publié.
- Cliquez sur Définir un projet.
Étape 2 : Intégrez le module complémentaire Google Workspace
Vous devez concevoir et implémenter toutes les fonctionnalités de module complémentaire Google Workspace que vous souhaitez ajouter à votre module complémentaire.
- Planifiez le contenu à afficher dans les cartes de la page d'accueil de votre module complémentaire et déterminez s'il doit apparaître dans Gmail, Agenda, Drive ou une combinaison de ces trois hôtes. Si vous souhaitez une page d'accueil dans plusieurs hôtes, déterminez si elle peut être la même ou si vous souhaitez des fiches de page d'accueil personnalisées pour chaque hôte.
- Dans le projet Apps Script du module complémentaire que vous avez copié, créez les fiches de votre page d'accueil avec les fonctions
homepageTrigger. Veillez à inclure toutes les fonctions ou logiques nécessaires pour contrôler les nouvelles interfaces de votre page d'accueil. Envisagez d'ajouter des fiches contextuelles déclenchées par l'action d'un utilisateur, comme l'ouverture d'un fil de discussion Gmail ou d'un événement 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 visioconférence Gmail et Agenda, mais ces champs d'origine sont obsolètes et seront supprimés à terme.
Étape 3 : Mettez à jour le fichier manifeste de votre module complémentaire
La façon 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 visioconférence Agenda. Lorsque vous mettez à niveau votre module complémentaire, vous devez mettre à jour les champs du fichier manifeste du projet Apps Script de votre module complémentaire en fonction des tableaux ci-dessous. Vous devez mettre à jour toutes les sous-propriétés concernées avec la nouvelle propriété addOns.
Veillez également à mettre à jour le champ oauthScopes du fichier manifeste si nécessaire pour 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éplacé vers addOns.gmail.composeTrigger. |
gmail.contextualTriggers[] |
Déplacez la liste vers addOns.gmail.contextualTriggers[]. |
gmail.logoUrl |
Déplacé vers addOns.common.logoUrl. |
gmail.name |
Déplacé vers addOns.common.name. |
gmail.openLinkUrlPrefixes[] |
Déplacez la liste vers addOns.common.openLinkUrlPrefixes[].
|
gmail.primaryColor |
Déplacé vers addOns.common.layoutProperties.primaryColor. |
gmail.secondaryColor |
Déplacé 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 le champ addOns.common.universalActions[].label correspondant. |
gmail.useLocalFromApp |
Déplacé vers addOns.common.useLocaleFromApp. |
Modules complémentaires de visioconférence Agenda
| Champ du fichier manifeste d'origine | Action requise |
|---|---|
calendar.createSettingsUrlFunction |
Déplacé vers addOns.calendar.createSettingsUrlFunction. |
calendar.conferenceSolution[] |
Déplacé vers addOns.calendar.conferenceSolution[]. |
calendar.logoUrl |
Déplacé vers addOns.common.logoUrl. |
calendar.name |
Déplacé vers addOns.common.name. |
Étape 4 : Testez votre 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 à niveau
Tous les modules complémentaires Google Workspace, qu'il s'agisse d'un module complémentaire mis à niveau ou créé de toutes pièces, doivent être approuvés avant de pouvoir être listés dans Google Workspace Marketplace.
Pour envoyer votre module complémentaire pour examen :
Assurez-vous que votre module complémentaire remplit toutes les conditions de publication des modules complémentaires.
Créez un déploiement versionné de votre module complémentaire Google Workspace (dans le nouveau projet Apps Script) en utilisant la version du code que vous souhaitez publier. N'essayez pas de publier à l'aide d'un déploiement "head".
Si vous avez ajouté des 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 niveaux d'accès Drive ou Agenda dans la version du module complémentaire Google Workspace, vous devez soumettre ces nouveaux niveaux d'accès pour validation. La validation prend souvent quelques jours. Commencez donc le processus le plus tôt possible. Assurez-vous que votre module complémentaire est validé avant de passer à l'étape 6.
Étape 6 : Mettez à disposition votre 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 description courte, la description détaillée et les captures d'écran de votre fiche pour refléter la nouvelle fonctionnalité 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, une liste d'hôtes compatibles s'affiche.
Si vous avez ajouté des niveaux d'accès à votre module complémentaire Google Workspace, assurez-vous de les ajouter à la section Niveaux d'accès OAuth 2.0 de la page Configuration. Les niveaux d'accès listés dans cette section doivent correspondre exactement à ceux listés dans le fichier manifeste de votre module complémentaire.
Vérifiez que les informations que vous avez 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 de ce module complémentaire Google Workspace, contactez-nous.
Questions fréquentes
Voici quelques questions fréquentes concernant les mises à niveau des modules complémentaires :
Puis-je passer à un forfait supérieur pour mon module complémentaire Editor ?
La plupart des modules complémentaires de l'éditeur peuvent être transférés vers les modules complémentaires Google Workspace. Toutefois, il n'est pas aussi facile de les mettre à niveau vers des modules complémentaires Google Workspace que pour les modules complémentaires Gmail et Agenda.
Si vous souhaitez migrer votre module complémentaire Editor vers un module complémentaire Google Workspace, vous devez réécrire l'UI du module complémentaire en passant du HTML à une interface basée sur des fiches et mettre à jour votre gestion JavaScript vers le service de fiches.
Il est possible que certains services de votre module complémentaire Éditeur existant ne soient pas disponibles dans le service de cartes. Par exemple, si votre module complémentaire Editor inclut un sélecteur de fichiers, il n'existe pas d'équivalent disponible dans le service de cartes 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 d'autres modules complémentaires Google Workspace sous différentes marques, mais nous n'autorisons pas les modules complémentaires de conférence Gmail ou Agenda distincts sous la même marque que votre module complémentaire Google Workspace. Si vous avez des questions ou souhaitez demander une exception, contactez-nous.
Mes utilisateurs devront-ils réautoriser 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 de réautoriser les autorisations qu'ils ont déjà accordées pour votre module complémentaire d'origine. Toutefois, si vous ajoutez de nouveaux champs d'application lors du processus de mise à niveau, vos utilisateurs devront autoriser ces nouveaux champs d'application la première fois qu'ils utiliseront la version Google Workspace de votre module complémentaire.
Puis-je migrer mon extension Chrome vers un module complémentaire Google Workspace et transférer des utilisateurs ?
Non. Vous ne pouvez pas transférer les utilisateurs, les installations et les avis sur la fiche d'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 Lister les intégrations d'applications.