Alternate Runtimes for Google Workspace Add-ons is coming soon. Learn more.

Testing Google Workspace add-ons

When you publish an add-on, users can install it through the host application or the Google Workspace Marketplace. Before publication, however, it is useful to test the add-ons that you develop within the host applications they extend.

This page describes how to install an add-on that is currently under development (called an unpublished or developer add-on) for testing or personal use.

Requirements

In order to install an unpublished Google Workspace add-on for testing, you must have read access to that add-on's script project. This means you can have collaborators in your organization test add-ons for you if you give them read access to the script project.

Install an unpublished add-on

You can install unpublished add-ons from Apps Script's Deployments dialog:

Google Workspace add-on sidebar

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

  1. Open the add-on's script project in the Apps Script editor.
  2. Select Publish > Deploy from manifest... to open the Deployments dialog.
  3. In the Latest Version (Head) row, click Install add-on to install the currently saved version of the add-on in development-mode. If you install the Latest Version (Head) of the add-on, any changes you make to the add-on code are applied immediately without you needing to reinstall it.
  4. Alternatively, you can create a versioned deployment and install that instead. This can be helpful if you want to 'checkpoint' a version of the add-on to compare it to the version under development.

You can allow other users to test the add-on by sharing the Apps Script project with their account (read access is required) and then prompting 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

If you wish to uninstall an unpublished add-on deployment, follow these steps:

  1. Open the add-on script project in the Apps Script editor.
  2. Select Publish > Deploy from manifest... to open the Deployments dialog.
  3. Click the Uninstall add-on link for the deployment you installed.

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 sur to follow the Best practices for add-on development. In addition, be sure to do the following:

  1. 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.

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

  3. 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.

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

  5. 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.