Page Summary

outlined_flag

• Unpublished Google Workspace add-ons can be installed for testing and personal use directly from the Apps Script project.

• Users need editor access to the script project to install and test the unpublished add-on.

• Uninstalling an unpublished add-on removes it from all host applications and requires reinstallation for further use.

• Thorough testing is crucial, including card navigation, data handling, external service integrations, error management, and performance evaluation.

When you publish an add-on, users can install itthrough the host applicationor theGoogle Workspace Marketplace. Before you publish, test theadd-ons that you develop within the host applications thatthey extend.

This page describes how to install an add-on that isunder development (called anunpublished ordeveloperadd-on) for testing orpersonal use. You can also debug add-ons using theApps ScriptIDE'sdebugger 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 editoraccess to the script project. For details about granting access, seeCollaborating with Other Developers.

Install an unpublished add-on

You can install unpublished add-ons from Apps Script'sDeploymentsdialog.

Follow these steps to install an unpublishedGoogle Workspace add-on for testing:

1. Open the script project in the Apps Script editor.
2. ClickDeploy > Test deployments.
3. ClickInstall.
4. At the bottom, clickDone.

You can let other users test the add-on by sharing the Apps Script projectwith their account (edit access is required). Then prompt the users tofollow the above steps.

Once installed, the add-on is immediately available in host applications itextends. You may need to refresh the host application tab before the add-onappears. You must alsoauthorizethe add-on before using it. If your project is already authorized,useScriptApp.invalidateAuth to invalidatethe existing authorizations so that you can test thegranular OAuthfeature on your add-on.

Uninstall an unpublished add-on

To uninstall an unpublished add-on deployment, follow these steps:

1. Open the script project in the Apps Script editor.
2. ClickDeploy > Test deployments.
3. ClickUninstall.
4. At the bottom, clickDone.

These steps immediately remove the deployment and the add-on no longer appearsin any host application. You can reinstall the deployment at any time byrepeating theinstall procedure.

Testing best practices

While testing your Google Workspace add-on, be sureto follow theBest practicesfor add-on development. In addition, be sure to do the following:

1. Test card navigation flows thoroughly in all the host applications theadd-on extends. Make sure the add-on behavior is correct as the user movesfrom context to context, and between non-contextual and contextual cards.

2. Use example test datato evaluate your add-on's behavior.

3. If your add-on connects to a third-party API or other service, verifythat the service can be accessed and behaves as expected. Make sureyour add-on is handling theauthorization and log-in detailscorrectly.

4. Make sure any error conditions are handled gracefully.Use error cardswhere needed.

5. Pay attention to how performant the add-on is. If you make a change to thecode and the add-on starts slowing down, you may need to remove or reworkthat feature.