Tester et déboguer les modules complémentaires Google Workspace Apps Script
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Lorsque vous publiez un module complémentaire, les utilisateurs peuvent l'installer via l'application hôte ou Google Workspace Marketplace. Avant de publier, testez les modules complémentaires que vous développez dans les applications hôtes qu'ils étendent.
Cette page explique comment installer un module complémentaire en cours de développement (appelé non publié ou pour les développeurs) à des fins de test ou d'utilisation personnelle. Vous pouvez également déboguer des modules complémentaires à l'aide du débogueur et des points d'arrêt de l'IDE Apps Script.
Prérequis
Vous devez disposer d'un accès éditeur au projet de script du module complémentaire.
Pour autoriser d'autres membres de votre organisation à tester le module complémentaire, accordez-leur un accès éditeur au projet de script. Pour en savoir plus sur l'attribution d'accès, consultez la section Collaborer avec d'autres développeurs.
Installer un module complémentaire non publié
Vous pouvez installer des modules complémentaires non publiés à partir de la boîte de dialogue Déploiements d'Apps Script.
Pour installer un module complémentaire Google Workspace non publié à des fins de test, procédez comme suit:
Ouvrez le projet de script dans l'éditeur Apps Script.
Cliquez sur Déployer > Tester les déploiements.
Cliquez sur Installer.
En bas de la page, cliquez sur OK.
Vous pouvez autoriser d'autres utilisateurs à tester le module complémentaire en partageant le projet Apps Script avec leur compte (un accès en modification est requis). Demandez ensuite aux utilisateurs de suivre les étapes ci-dessus.
Une fois installé, le module complémentaire est immédiatement disponible dans les applications hôtes qu'il étend. Vous devrez peut-être actualiser l'onglet de l'application hôte avant que le module complémentaire ne s'affiche. Vous devez également autoriser le module complémentaire avant de l'utiliser.
Désinstaller un module complémentaire non publié
Pour désinstaller un déploiement de module complémentaire non publié, procédez comme suit:
Ouvrez le projet de script dans l'éditeur Apps Script.
Cliquez sur Déployer > Tester les déploiements.
Cliquez sur Désinstaller.
En bas de la page, cliquez sur OK.
Ces étapes permettent de supprimer immédiatement le déploiement et le module complémentaire n'apparaît plus dans aucune application hôte. Vous pouvez réinstaller le déploiement à tout moment en répétant la procédure d'installation.
Bonnes pratiques de test
Lorsque vous testez votre module complémentaire Google Workspace, veillez à suivre les bonnes pratiques pour le développement de modules complémentaires. En outre, assurez-vous de suivre les étapes suivantes:
La navigation dans les fiches de test est entièrement testée dans toutes les applications hôtes auxquelles le module complémentaire s'étend. Assurez-vous que le comportement du module complémentaire est correct lorsque l'utilisateur passe d'un contexte à un autre, et entre les fiches non contextuelles et contextuelles.
Si votre module complémentaire se connecte à une API ou à un autre service tiers, vérifiez que le service est accessible et qu'il se comporte comme prévu. Assurez-vous que votre module complémentaire gère correctement les informations d'autorisation et de connexion.
Assurez-vous que toutes les conditions d'erreur sont gérées correctement. Utilisez des fiches d'erreur si nécessaire.
Faites attention aux performances du module complémentaire. Si vous modifiez le code et que le module complémentaire commence à ralentir, vous devrez peut-être supprimer ou retravailler cette fonctionnalité.
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).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2024/12/22 (UTC)."],[[["\u003cp\u003eUnpublished Google Workspace add-ons can be installed for testing and personal use directly from the Apps Script project.\u003c/p\u003e\n"],["\u003cp\u003eUsers need editor access to the script project to install and test the unpublished add-on.\u003c/p\u003e\n"],["\u003cp\u003eUninstalling an unpublished add-on removes it from all host applications and requires reinstallation for further use.\u003c/p\u003e\n"],["\u003cp\u003eThorough testing is crucial, including card navigation, data handling, external service integrations, error management, and performance evaluation.\u003c/p\u003e\n"]]],["To test an unpublished add-on, open its script project in the Apps Script editor and navigate to **Deploy \u003e Test deployments**. Click **Install**, then **Done** to make it available in host applications. Share the project for others to test. Uninstall by repeating the process and selecting **Uninstall**. Testing should include card navigation, example data evaluation, third-party service verification, error handling, and performance monitoring.\n"],null,["# Test and debug Apps Script Google Workspace add-ons\n\nWhen you publish an add-on, users can install it\nthrough the host application\nor the [Google Workspace Marketplace](https://workspace.google.com/marketplace/). Before you publish, test the\nadd-ons that you develop within the host applications that\nthey extend.\n\nThis page describes how to install an add-on that is\nunder development (called an *unpublished* or *developer*\nadd-on) for testing or\npersonal use. You can also debug add-ons using the\nApps Script\nIDE's [debugger and breakpoints](/apps-script/guides/support/troubleshooting#use-debugger).\n\nPrerequisites\n-------------\n\n- You must have editor access to the add-on's script project.\n- To let other people in your organization test the add-on, grant them editor access to the script project. For details about granting access, see [Collaborating with Other Developers](/apps-script/guides/collaborating).\n\nInstall an unpublished add-on\n-----------------------------\n\nYou can install unpublished add-ons from Apps Script's **Deployments**\ndialog.\n\nFollow these steps to install an unpublished\nGoogle Workspace add-on for testing:\n\n1. Open the script project in the Apps Script editor.\n2. Click **Deploy \\\u003e Test deployments**.\n3. Click **Install**.\n4. At the bottom, click **Done**.\n\nYou can let other users test the add-on by sharing the Apps Script project\nwith their account (edit access is required). Then prompt the users to\nfollow the above steps.\n\nOnce installed, the add-on is immediately available in host applications it\nextends. You may need to refresh the host application tab before the add-on\nappears. You must also\n[authorize](/workspace/add-ons/how-tos/authorizing-addons#authorizing_unpublished_g_suite_add-ons)\nthe add-on before using it.\n\nUninstall an unpublished add-on\n-------------------------------\n\nTo uninstall an unpublished add-on deployment, follow these steps:\n\n1. Open the script project in the Apps Script editor.\n2. Click **Deploy \\\u003e Test deployments**.\n3. Click **Uninstall**.\n4. At the bottom, click **Done**.\n\nThese steps immediately remove the deployment and the add-on no longer appears\nin any host application. You can reinstall the deployment at any time by\nrepeating the [install procedure](#install_an_unpublished_add-on).\n\nTesting best practices\n----------------------\n\nWhile testing your Google Workspace add-on, be sure\nto follow the\n[Best practices](/workspace/add-ons/guides/workspace-best-practices)\nfor add-on development. In addition, be sure to do the following:\n\n1. Test card navigation flows thoroughly in all the host applications the\n add-on extends. Make sure the add-on behavior is correct as the user moves\n from context to context, and between non-contextual and contextual cards.\n\n2. [Use example test data](/workspace/add-ons/guides/workspace-best-practices#_write_tests_and_test_messages)\n to evaluate your add-on's behavior.\n\n3. If your add-on connects to a third-party API or other service, verify\n that the service can be accessed and behaves as expected. Make sure\n your add-on is handling the\n [authorization and log-in details](/workspace/add-ons/how-tos/non-google-services)\n correctly.\n\n4. Make sure any error conditions are handled gracefully. [Use error cards](/workspace/add-ons/guides/workspace-best-practices#_use_error_cards)\n where needed.\n\n5. Pay attention to how performant the add-on is. If you make a change to the\n code and the add-on starts slowing down, you may need to remove or rework\n that feature."]]