Tester un module complémentaire de l'éditeur
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Les modules complémentaires doivent être testés minutieusement avant d'être publiés pour s'assurer qu'ils se comportent comme prévu. Apps Script vous permet de tester les modules complémentaires Editor en cours de développement sur des fichiers Google Docs, Sheets, Forms ou Slides spécifiques. Vous pouvez l'utiliser pour:
- Vérifiez qu'un module complémentaire écrit dans un script autonome fonctionne comme prévu lorsqu'il est appliqué à une feuille de calcul, un document, une présentation ou un formulaire.
- Vérifiez que le flux d'installation du module complémentaire fonctionne comme prévu, en particulier pour les différents états de cycle de vie de l'autorisation initiaux (installé, activé ou les deux).
- Vérifiez que le module complémentaire fonctionne comme prévu lorsqu'il agit sur un document particulier et son contenu.
- Tester et comparer les versions actuelle et précédente du module complémentaire
Créer un déploiement de test
Un déploiement de test combine un module complémentaire et un document de test.
Une fois que vous avez développé une version de script et que vous souhaitez la tester en tant que module complémentaire, procédez comme suit:
- Si vous n'en avez pas encore, créez une feuille de calcul, un document, une présentation ou un formulaire pour tester le module complémentaire.
- Ouvrez le projet de script contenant votre module complémentaire.
- Cliquez sur Déployer > Tester les déploiements.
- À côté de Sélectionner le type, cliquez sur "Activer les types de déploiement" settings, puis sélectionnez Module complémentaire pour les éditeurs.
- Cliquez sur Créer un test ou Ajouter un test.
- Choisissez une version de code ou sélectionnez Dernier code.
- Dans la section Config (Configuration), sélectionnez l'état d'autorisation initial pour le test.
- Sous Document de test, cliquez sur Aucun document sélectionné. Sélectionnez le fichier Sheets, Docs, Slides ou Formulaires que vous souhaitez utiliser pour tester le module complémentaire, puis cliquez sur Insérer.
- Cliquez sur Enregistrer le test.
Tous les déploiements de test enregistrés s'affichent dans la boîte de dialogue Déploiements de test. Vous pourrez ainsi revenir sur le même déploiement de test plus tard.
Exécuter un déploiement test
Si vous avez enregistré un ou plusieurs déploiements de test, vous pouvez en exécuter un en procédant comme suit:
- Ouvrez le projet de script contenant votre module complémentaire.
- Cliquez sur Déployer > Tester les déploiements.
- Sous Tests enregistrés, sélectionnez la case d'option à côté du déploiement de test enregistré que vous souhaitez exécuter, puis cliquez sur Exécuter.
Le document de test s'ouvre dans un nouvel onglet. Le module complémentaire est dans l'état d'autorisation spécifié dans le déploiement de test. Vous pouvez vérifier que le module complémentaire fonctionne comme prévu en interagissant avec son menu et ses éléments d'interface utilisateur.
Détails des tests
Voici quelques points à prendre en compte lorsque vous testez des modules complémentaires Editor de cette manière:
- Les déclencheurs installables ne sont pas acceptés lors des tests. Les fonctionnalités qui dépendent de déclencheurs installables ne sont pas testables.
- Lorsque vous exécutez un déploiement de test configuré pour tester avec le code le plus récent, vous pouvez voir les modifications enregistrées dans le script du module complémentaire en actualisant le document de test.
- Le document de test comporte une URL que vous pouvez partager avec les éditeurs du document de test d'origine. Vous pouvez ainsi collaborer plus facilement avec d'autres personnes lors des tests et du développement.
- Si votre module complémentaire utilise le service Propriétés, les propriétés persistent et restent disponibles la prochaine fois que le déploiement de test est exécuté.
- De plus, tout déploiement de test qui utilise la même combinaison de module complémentaire et de document de test a accès aux mêmes informations sur la propriété. Par exemple, si vous créez deux déploiements de test, les propriétés enregistrées lors de l'exécution du premier sont disponibles lors de l'exécution du second et inversement, mais uniquement si les déploiements utilisent le même script et le même document de test.
- Si vous exécutez un déploiement de test, vous pouvez être invité à autoriser l'opération si vous n'avez jamais exécuté le script auparavant. Sachez que l'autorisation d'un script lors des tests l'autorise également en dehors des tests.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/12/22 (UTC).
[null,null,["Dernière mise à jour le 2024/12/22 (UTC)."],[[["\u003cp\u003eApps Script allows developers to test editor add-ons directly within Google Docs, Sheets, Slides, or Forms to verify functionality and installation flow.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can create test deployments to specify add-on versions, authorization states, and associated documents for controlled testing environments.\u003c/p\u003e\n"],["\u003cp\u003eSaved test deployments can be executed repeatedly, enabling developers to iterate on their add-ons and observe changes in real-time within the test document.\u003c/p\u003e\n"],["\u003cp\u003eWhile offering valuable testing capabilities, test deployments have limitations such as not supporting installable triggers and shared property persistence across deployments using the same add-on and document.\u003c/p\u003e\n"],["\u003cp\u003eTest deployments provide a shareable URL for collaborative testing and may require authorization for the script, both within and outside the testing environment.\u003c/p\u003e\n"]]],["To test add-ons in development, create a test deployment linking a script version to a specific Google Docs, Sheets, Forms, or Slides file. Select the add-on's authorization state and save the test. Run saved tests by selecting them in the \"Test deployments\" dialog and clicking \"Execute.\" During testing, changes to the script can be viewed by refreshing the test document; the test document URL is shareable for collaboration. Any properties created are also persisted across multiple test deployments.\n"],null,["# Test an Editor add-on\n\nAdd-ons should be tested thoroughly prior to publishing to ensure they\nbehave as intended. Apps Script lets you test\n[Editor add-ons](/workspace/add-ons/concepts/types#editor_add-ons)\nin development on specific Google Docs Sheets, Forms, or Slides files. This\ncan be used to:\n\n- Verify that an add-on written in a standalone script functions as intended when applied to a sheet, doc, presentation, or form.\n- Verify that the add-on installation flow works as intended, particularly for different initial [authorization lifecycle states](/workspace/add-ons/concepts/editor-auth-lifecycle#the_complete_lifecycle) ([installed, enabled, or both](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled)).\n- Verify that the add-on functions as intended when acting on a particular document and its contents.\n- Test and compare the current and previous versions of the add-on.\n\nCreate a test deployment\n------------------------\n\nA test deployment is the combination of an add-on and a test document.\nOnce you have a script version developed and would like to test it as an add-on,\nfollow these steps:\n\n1. If you don't have one already, create a spreadsheet, document, presentation, or form to test the add-on with.\n2. Open the script project containing your add-on.\n3. Click **Deploy** \\\u003e **Test deployments**.\n4. Next to **Select type** , click Enable deployment types settings and select **Editor add-on**.\n5. Click **Create new test** or **Add test**.\n6. Choose a code version or select **Latest Code**.\n7. In the **Config** section, select the initial [authorization state](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled) for the test.\n8. Under **Test document** , click **No document selected** . Select the Sheets, Docs, Slides, or Forms file you want to use to test the add-on and click **Insert**.\n9. Click **Save test**.\n\nAll saved test deployments appear in the **Test deployments** dialog. This lets\nyou revisit the same test deployment later on.\n\nRun a test deployment\n---------------------\n\nIf you have one or more saved test deployments, you can run one of them by\nfollowing these steps:\n\n1. Open the script project containing your add-on.\n2. Click **Deploy** \\\u003e **Test deployments**.\n3. Under **Saved Tests** , select the radio button next to the saved test deployment you want to run and click **Execute**.\n\nThe test document opens in a new tab. The add-on is in the\n[authorization state](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled)\nspecified in the test deployment. You can verify that the add-on functions as\nintended by interacting with its menu and UI elements.\n\n### Testing details\n\nThere are a number of things to keep in mind while testing Editor add-ons\nthis way:\n\n- [Installable triggers](/workspace/add-ons/concepts/editor-triggers#installable_triggers_in_add-ons) aren't supported when testing. Functionality that depends on installable triggers is not testable.\n- While running a test deployment that's set to test with the latest code, you can see changes saved to the add-on script by refreshing the test document.\n- The test document has a URL that you can share with editors of the original test document. This way, you can more easily collaborate with others while testing and developing.\n- If your add-on uses the [Properties service](/apps-script/reference/properties/properties-service), properties persist and remain available the next time the test deployment is run.\n- In addition, any test deployment that uses the same combination of add-on and test document has access to the same property information. For example, if you create two test deployments, the properties saved while running the first are available while running the second and vice versa, but only if the deployments use the same script and test document.\n- If you run a test deployment, you might be prompted for authorization if you have not run the script before. Be aware that authorizing a script while testing also authorizes the script outside of testing."]]