Mettre à niveau les anciens modules complémentaires Gmail et Agenda

Remarque :Il n'est pas possible de mettre à niveau directement les modules complémentaires des éditeurs vers les modules complémentaires Google Workspace pour le moment. Pour en savoir plus, consultez Puis-je mettre à niveau mon module complémentaire Editor.

Si vous avez déjà créé et publié un module complémentaire pour enrichir Gmail ou Agenda, pouvez le convertir en module complémentaire Google Workspace. Les instructions de cette page expliquent en détail pour ajouter des fonctionnalités Google Workspace à vos modules complémentaires Gmail ou Agenda existants, et puis publiez votre module complémentaire mis à niveau pour qu'il puisse être découvert et installé.

Vous pouvez transférer les nouvelles fonctionnalités pour conserver votre fiche Google Workspace Marketplace, vos installations et vos utilisateurs. Passer à une édition supérieure vous permet également de profiter des nouvelles fonctionnalités du module complémentaire Google Workspace comme les pages d'accueil.

Remarque :Si vous ne mettez pas à niveau vos modules complémentaires Gmail ni vos modules complémentaires de conférence Agenda, ils seront automatiquement mis à niveau vers les modules complémentaires Google Workspace, avec une page d'accueil générique. Aucune modification de votre fiche ni de votre code de développeur n'est requise, et le module complémentaire sera disponible uniquement dans sa version d'origine application hôte. Dans Google Workspace Marketplace, sont répertoriés dans les sections "Compatible avec Gmail" ou "Compatible avec Agenda". grâce aux fiches, aux installations et aux utilisateurs fidélisés.

É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 celui utilisé mais il est important de créer et d'utiliser une copie des applications Créez un script de projet afin que vos utilisateurs existants ne soient pas affectés pendant les tests la version mise à niveau. La mise à niveau d'une copie du projet de script d'origine vous pouvez toujours accéder au code d'origine et le redéployer ultérieurement si nécessaires.

1. Ouvrir Apps Script votre module complémentaire Gmail ou de conférence Agenda existant projet.
2. Sur la gauche, cliquez sur Vue d'ensemble.
3. À droite, cliquez sur Créer une copie .
4. Sur la gauche, cliquez sur Paramètres du projet > Changer de projet
5. Cliquez sur Numéro de projet GCP.
6. Saisissez la même numéro du projet associé à votre projet Apps Script publié de module complémentaire existant.
7. Cliquez sur Définir un projet.

Avertissement :Ne mettez pas directement à niveau le projet Apps Script d'un module complémentaire public. Vous devez créer une copie pour séparer la version mise à niveau de la version publique lors de sa construction et de ses tests.

Étape 2: Intégrez le module complémentaire Google Workspace

Vous devez concevoir et mettre en œuvre les fonctionnalités des modules complémentaires Google Workspace que vous souhaitez ajouter. votre module complémentaire.

1. Planifier le contenu à afficher dans votre module complémentaire fiches de la page d'accueil et à déterminer si elles devraient s'afficher dans Gmail, Agenda, Drive ou une combinaison des hôtes. Si vous souhaitez disposer d'une page d'accueil sur plusieurs hôtes, peut correspondre à la même page d'accueil ou vous servir de fiches personnalisées pour chaque hôte.
2. Créer votre page d'accueil dans le projet Apps Script du module complémentaire que vous avez copié cartes avec homepageTrigger fonctions. Assurez-vous d'inclure toutes les fonctions ou logiques de soutien nécessaires pour de contrôler l'interface de votre nouvelle page d'accueil.

3. Envisagez d'ajouter des fiches contextuelles déclenchées par l'action de l'utilisateur (par exemple, l'ouverture d'un Fil de discussion Gmail ou Événement d'agenda

   Attention :Les modules complémentaires reçoivent un ID différent pour les messages Gmail. par rapport aux modules complémentaires Gmail. Cette modification ne concerne que les modules complémentaires mis à niveau utiliser messageId comme clé dans n'importe quel espace de stockage permanent. Si nécessaire, vous pouvez toujours récupérer les anciennes valeurs d'ID avec l'API Gmail. L'API Gmail Méthode messages().get() accepte les nouvelles et les anciennes valeurs d'ID, mais ne renvoie que les anciennes.

4. Mettre à jour les accès aux objets d'événements dans votre module complémentaire (dans les fonctions de rappel de widget ou dans le déclencheur contextuel) ; fonctions) pour utiliser les nouvelles structure de l'objet événement. La nouvelle structure contient toujours les champs d'objet d'événement utilisés par des modules complémentaires de conférence Gmail et Agenda, mais ces champs d'origine sont sont obsolètes et seront à terme supprimées.

Étape 3: Mettez à jour le fichier manifeste du module complémentaire

Manière dont les informations de configuration sont stockées structure du fichier manifeste de Les modules complémentaires Google Workspace ont considérablement changé par rapport à la structure des 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 en fonction aux tableaux ci-dessous. Vous devez mettre à jour toutes les sous-propriétés pertinentes vers les nouvelles addOns.

Veillez également à mettre à jour le fichier manifeste oauthScopes comme nécessaires 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 la section Fichiers manifestes.

Modules complémentaires Gmail

Champ d'origine du fichier manifeste	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 addOns.common.universalActions[].label correspondant .
gmail.useLocalFromApp	Déplacer vers addOns.common.useLocaleFromApp.

Modules complémentaires de conférence Agenda

Champ d'origine du fichier manifeste	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 votre module complémentaire mis à niveau

Pour tester votre module complémentaire mis à niveau avant de le publier, procédez comme suit : 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 supérieur ou d'un module entièrement pensé, doivent être approuvées pour figurer sur Google Workspace Marketplace.

Pour envoyer votre module complémentaire pour examen, procédez comme suit:

1. Assurez-vous que votre module complémentaire remplit toutes les conditions Exigences de publication dans les modules complémentaires.

2. Créer un déploiement avec gestion des versions de votre module complémentaire Google Workspace (dans le nouveau projet Apps Script) en utilisant la version de le code que vous souhaitez publier. N'essayez pas de publier à l'aide d'un en-tête le déploiement.

3. Si vous avez ajouté des 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 nouvelles habilitations Drive ou Agenda dans le version du module complémentaire Google Workspace, vous devez envoyer ces nouveaux champs d'application pour validation. La validation prend souvent quelques jours, alors commencez la procédure dès que possible. Assurez-vous que votre module complémentaire est validé avant de continuer à l'étape 6.

Étape 6: Proposez votre module complémentaire mis à niveau

1. Ouvrez le SDK Google Workspace Marketplace.

2. Sur la gauche, cliquez sur Configuration. Ce panneau contient un formulaire dans lequel vous fournir des informations sur votre module complémentaire.

3. Modifiez la brève description, la description détaillée et les captures d'écran de votre pour refléter les nouvelles fonctionnalités du module complémentaire Google Workspace.

4. Sous Extensions, cliquez sur le bouton Passer à Bouton du module complémentaire Google Workspace. Dans la zone de texte qui s'affiche, saisissez l'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, un la liste des hôtes compatibles s'affiche.

   Attention :La mise à niveau de votre module complémentaire en module complémentaire Google Workspace de cette manière est ponctuelle processus irréversible.

5. Si vous avez ajouté des habilitations à votre module complémentaire Google Workspace, veillez à les ajouter au Section Champs d'application OAuth 2.0 de la page Configuration Les habilitations listées de cette section doivent correspondre exactement aux champs d'application répertoriés dans les ressources d'un fichier manifeste.

6. Vérifiez que les informations saisies dans le formulaire sont correctes. Ensuite, cliquez sur Enregistrer les modifications.

Si vous avez des questions ou rencontrez un problème lors de la mise à niveau du module complémentaire Google Workspace contactez-nous.

Questions fréquentes

Voici les questions fréquentes concernant les mises à niveau des modules complémentaires:

Puis-je mettre à niveau mon module complémentaire Editor ?

La plupart des modules complémentaires des éditeurs peuvent être transférés vers les modules complémentaires Google Workspace. Toutefois, elles ne peuvent pas sont passés aux modules complémentaires Google Workspace aussi facilement que ceux de Gmail et Agenda.

Si vous souhaitez migrer votre module complémentaire Éditeur vers un module complémentaire Google Workspace, vous devez réécrire l'interface utilisateur du module complémentaire en remplaçant le code HTML par un modèle de commande, puis mettez à jour votre code JavaScript au 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 d'éditeur inclut un sélecteur de fichier, n'est pas un équivalent disponible auprès du service de carte 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 ?

Nous vous invitons à créer d'autres modules complémentaires Google Workspace sous d'autres marques, mais nous n'autorisons pas les modules complémentaires de conférence Gmail ou Agenda distincts ayant 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 à nouveau autoriser le module complémentaire après la mise à niveau ?

Tant que votre module complémentaire Google Workspace utilise le même Projet Cloud Platform (GCP), avec un ID client OAuth associé, vos utilisateurs n'auront pas besoin d'autoriser à nouveau autorisations précédemment accordées à votre module complémentaire d'origine. Toutefois, si lorsque vous ajoutez des niveaux d'accès pendant le processus de mise à niveau, vos utilisateurs doivent les autoriser de nouveaux champs d'application la première fois qu'ils utilisent du module complémentaire.

Puis-je mettre à niveau 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 la fiche d'une extension Chrome. avis. Vous devez créer un module complémentaire Google Workspace et diriger les utilisateurs de votre compte Chrome à Google Workspace Marketplace.

Puis-je associer plusieurs modules complémentaires à mon module complémentaire Google Workspace ?

Consultez la section Répertorier les intégrations d'applications ensemble.