Test and debug Apps Script Google Workspace add-ons
Stay organized with collections
Save and categorize content based on your preferences.
When you publish an add-on, users can install it
through the host application
or the Google Workspace Marketplace. Before you publish, test the
add-ons that you develop within the host applications that
they extend.
This page describes how to install an add-on that is
under development (called an unpublished or developer
add-on) for testing or
personal use. You can also debug add-ons using the
Apps Script
IDE's debugger and breakpoints.
Prerequisites
You must have editor access to the add-on's script project.
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.
Install an unpublished add-on
You can install unpublished add-ons from Apps Script's Deployments
dialog.
Follow these steps to install an unpublished
Google Workspace add-on for testing:
Open the script project in the Apps Script editor.
Click Deploy > Test deployments.
Click Install.
At the bottom, click Done.
You can let other users test the add-on by sharing the Apps Script project
with their account (edit access is required). Then prompt the users to
follow the above steps.
Once installed, the add-on is immediately available in host applications it
extends. You may need to refresh the host application tab before the add-on
appears. You must also
authorize
the add-on before using it.
Uninstall an unpublished add-on
To uninstall an unpublished add-on deployment, follow these steps:
Open the script project in the Apps Script editor.
Click Deploy > Test deployments.
Click Uninstall.
At the bottom, click Done.
These steps immediately remove the deployment and the add-on no longer appears
in any host application. You can reinstall the deployment at any time by
repeating the install procedure.
Testing best practices
While testing your Google Workspace add-on, be sure
to follow the
Best practices
for add-on development. In addition, be sure to do the following:
Test card navigation flows thoroughly in all the host applications the
add-on extends. Make sure the add-on behavior is correct as the user moves
from context to context, and between non-contextual and contextual cards.
If your add-on connects to a third-party API or other service, verify
that the service can be accessed and behaves as expected. Make sure
your add-on is handling the
authorization and log-in details
correctly.
Make sure any error conditions are handled gracefully. Use error cards
where needed.
Pay attention to how performant the add-on is. If you make a change to the
code and the add-on starts slowing down, you may need to remove or rework
that feature.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 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."]]
