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 comment ajouter des fonctionnalités Google Workspace à vos modules complémentaires Gmail ou Agenda existants, puis publier votre module complémentaire mis à niveau afin qu'il puisse être détecté 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. 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é, 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 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 plus tard si nécessaire.
- Ouvrez votre projet Apps Script existant pour le module complémentaire Gmail ou le module complémentaire de conférence Agenda.
- Sur la gauche, cliquez sur Vue d'ensemble .
- Sur la droite, cliquez sur Créer une copie .
- Sur la gauche, cliquez sur Paramètres du projet > Modifier le 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 publié.
- Cliquez sur Définir un projet.
Étape 2: Intégrer 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 les contenus à afficher dans les fiches de la page d'accueil de votre module complémentaire et indiquez s'ils doivent apparaître dans Gmail, Agenda, Drive ou toute combinaison des trois hôtes. Si vous souhaitez afficher une page d'accueil sur plusieurs hôtes, décidez si vous pouvez utiliser la même page d'accueil ou si vous souhaitez des fiches de page d'accueil personnalisées pour chaque hôte.
- Dans votre projet Apps Script de module complémentaire copié, créez vos fiches de page d'accueil avec les fonctions
homepageTrigger. Assurez-vous d'inclure toutes les fonctions ou logiques de support nécessaires pour contrôler vos nouvelles interfaces de 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 utilisés par les modules complémentaires de conférence Gmail et Agenda, mais ces champs d'origine sont obsolètes et seront éventuellement supprimés.
É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 de 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 de votre module complémentaire conformément aux tableaux ci-dessous. Vous devez mettre à jour toutes les sous-propriétés pertinentes dans la nouvelle propriété addOns.
Veillez également à mettre à jour le champ oauthScopes de votre 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 de modules complémentaires Google Workspace, consultez la section Fichiers manifestes.
Modules complémentaires Gmail
| Champ "Fichier manifeste d'origine" | Action requise |
|---|---|
gmail.composeTrigger |
Déplacez-vous vers addOns.gmail.composeTrigger. |
gmail.contextualTriggers[] |
Déplacez la liste vers addOns.gmail.contextualTriggers[]. |
gmail.logoUrl |
Déplacez-vous vers addOns.common.logoUrl. |
gmail.name |
Déplacez-vous vers addOns.common.name. |
gmail.openLinkUrlPrefixes[] |
Déplacez la liste vers addOns.common.openLinkUrlPrefixes[].
|
gmail.primaryColor |
Déplacez-vous vers addOns.common.layoutProperties.primaryColor. |
gmail.secondaryColor |
Déplacez-vous 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éplacez-vous vers addOns.common.useLocaleFromApp. |
Modules complémentaires Agenda pour les visioconférences
| Champ "Fichier manifeste d'origine" | Action requise |
|---|---|
calendar.createSettingsUrlFunction |
Déplacez-vous vers addOns.calendar.createSettingsUrlFunction. |
calendar.conferenceSolution[] |
Déplacez-vous vers addOns.calendar.conferenceSolution[]. |
calendar.logoUrl |
Déplacez-vous vers addOns.common.logoUrl. |
calendar.name |
Déplacez-vous vers addOns.common.name. |
Étape 4: Tester 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 des avis sur votre module complémentaire mis à niveau
Tous les modules complémentaires Google Workspace, qu'ils soient mis à niveau ou créés à partir de zéro, doivent être approuvés avant de pouvoir être listés sur Google Workspace Marketplace.
Pour envoyer votre module complémentaire pour examen, procédez comme suit:
Assurez-vous que votre module complémentaire répond à toutes les conditions de publication des modules complémentaires.
Créez un déploiement avec version 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 de tête.
Si vous avez ajouté de nouvelles habilitations 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 les envoyer 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 devez fournir 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 les nouvelles fonctionnalités du module complémentaire Google Workspace.
Sous Extensions, cliquez sur le bouton Passer à un 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 des hôtes compatibles s'affiche.
Si vous avez ajouté des champs d'application à votre module complémentaire Google Workspace, assurez-vous de les ajouter à la section Champs d'application OAuth 2.0 de la page Configuration. Les portées listées dans cette section doivent correspondre exactement à celles listées 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 cette mise à niveau des modules complémentaires 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 à niveau mon module complémentaire Éditeur ?
La plupart des modules complémentaires Éditeur peuvent être migrés vers des modules complémentaires Google Workspace. Toutefois, ils ne peuvent pas être convertis en modules complémentaires Google Workspace aussi facilement que les modules complémentaires pour Gmail et Agenda.
Si vous souhaitez migrer votre module complémentaire Editor vers un module complémentaire Google Workspace, vous devez réécrire l'interface utilisateur du module complémentaire en HTML vers une interface basée sur des cartes et mettre à jour la gestion JavaScript avec le service de cartes.
Il est possible que certains services de votre module complémentaire Editor existant ne soient pas disponibles dans le service de cartes. Par exemple, si votre module complémentaire Éditeur inclut un sélecteur de fichiers, aucun équivalent n'est disponible dans le service de cartes pour les modules complémentaires Google Workspace.
Puis-je créer un module complémentaire Google Workspace distinct tout en conservant mon module complémentaire existant ?
Vous pouvez créer d'autres modules complémentaires Google Workspace sous différents noms de marque, mais nous n'autorisons pas de modules complémentaires de conférence Gmail ou Agenda distincts sous le même nom de 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 précédemment accordées à votre module complémentaire d'origine. Toutefois, si vous ajoutez de nouveaux champs d'application au cours du processus de migration, vos utilisateurs devront les autoriser la première fois qu'ils utiliseront la version Google Workspace de votre module complémentaire.
Puis-je passer mon extension Chrome à 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.