Installing Unpublished Add-ons

When you publish an add-on, users can install it through Gmail or the G Suite Marketplace. Before publication, however, it is useful to test add-ons that you develop within Gmail.

This page describes how to install an add-on that is currently under development (a developer add-on).

Requirements

You can only install an unpublished add-on for a @gmail.com account. The account you use must have read access to that add-on's script project.

Before installing a developer add-on, you must have a valid deployment. You can install a head deployment that is always synced to the current code, a versioned deployment that is locked to a specific version, or both. Once you have chosen which deployment to use, you must look up its deployment ID.

It is possible to install more than one deployment of the same add-on, provided you have the deployment IDs for each. You can also install a developer add-on created by another developer, provided you have the deployment ID and permission to access the associated script project.

Install a developer add-on

You can install a developer add-on's deployment with the following steps:

  1. Open the Gmail add-on settings tab.
  2. In the Add-ons tab, make sure that you have selected the Enable developer add-ons for my account checkbox.
  3. Paste your add-on's deployment ID into the Install developer add-on textbox and click Install.
  4. Optionally, check the Enable debugging information checkbox. If selected, any errors the add-on script encounters cause the add-on to automatically display an error card to the user.

Once installed, the add-on is immediately available in Gmail. You may need to refresh the Gmail tab before the add-on appears.

Uninstall a developer add-on

If you which to uninstall a developer add-on deployment, follow these steps:

  1. Open the Gmail add-on settings tab.
  2. In the Add-ons tab, find the add-on deployment you wish to uninstall in the list under Developer add-ons.
  3. Click the Uninstall link for that deployment.

Gmail immediately removes the deployment and the add-on no longer appears in Gmail. You can reinstall the deployment at any time by using the same deployment ID.