Managing published add-ons

The following sections describe common actions you may need to perform to maintain and update add-ons that you've published.

Open the Marketplace SDK control panel

The publication settings for your add-on and the appearance of its G Suite Marketplace listing are controlled through the G Suite Marketplace SDK control panel. After you've enabled the G Suite Marketplace SDK for your add-on's script project, you can return to the SDK control panel at any time.

To open the SDK control panel, follow these steps:

  1. Open the add-on's script project in the Apps Script editor.
  2. Select Resources > Cloud Platform project from the editor menu. In the dialog that appears, click the name of the project your script is associated with.
  3. In the console's left navigation, select APIs & services to open the API dashboard.
  4. In the Dashboard panel, there is a list of APIs your project as enabled at the bottom. Select the Google Apps Marketplace SDK link.

This opens the SDK Overview panel. You can configure the SDK from the Configuration and Publish panels. After the add-on is published you can find some usage metrics in the Usage panels.

Check publication status

You can only check the publication status if you have finished configuring the G Suite Marketplace SDK by clicking Publish to start a publication request. After completing that process, you can check your add-on's publication status at any time by doing the following steps:

  1. If you have not done so, open the G Suite Marketplace SDK control panel.
  2. Select the Publish panel.
  3. At the top of the panel is a Publish status section. Your add-on's publication status is presented here.

Update published add-on code

After an add-on is published, it appears in the G Suite Marketplace. You can update the code of a published add-on to create a new version and deploy it without republishing. Creating a new add-on version this way does not require another round of add-on review.

If you want to make a change to your add-on's code after publishing, follow these steps:

  1. Make the changes you want in the add-on's script project.
  2. If you made changes that added or removed scopes to the script project, you must update the scopes listed to in the G Suite Marketplace SDK Configuration panel to exactly match the scopes listed in the add-on's project manifest.
  3. Using a head deployment, verify that the changes you made are working as intended by testing the add-on. You can install the new, unpublished version to test it.
  4. Once you are certain the updated add-on is functioning correctly, create a new script project version to correspond to this update.
  5. In the Apps Script editor, update the versioned deployment to use the new script project version you just created.
  6. Once the deployment is saved, the new version replaces the previous one. It may take some time before the change registers for a given user.
  7. If a code update changes the scopes used by the add-on after publication, you must file a new request for OAuth verification. Once re-verification is complete, make sure the OAuth scopes listed in the add-on manifest and in the G Suite Marketplace listing match the newly verified scope list. Failing to do so results in an unverified app warning being displayed to your users.

Update a Marketplace listing

If you want to update your add-on's G Suite Marketplace listing, follow these steps:

  1. If you have not done so, open the G Suite Marketplace SDK control panel.
  2. Select the Configuration panel. Review the information in the form, make any desired changes, and click Save changes. You can't change your add-on's visibility setting once it has been chosen, but you can alter the other configuration details.
  3. Select the Publish panel. Review the information in the form, make any desired changes, and click Update.

It may take some time for the changes you made to be reflected in your add-on's G Suite Marketplace listing.

Unpublish an add-on

If you need to unpublish an add-on, you can do so by following these steps:

  1. If you have not done so, open the G Suite Marketplace SDK control panel.
  2. Select the Publish tab.
  3. In the Publish status section, click the Unpublish button to unpublish the add-on.

Once unpublished, the add-on can no longer be used by users who installed it and the add-on listing no longer appears in the G Suite Marketplace.

You can republish the add-on later by following the above instructions and to open the Publish panel and then clicking the Publish button at the bottom.

Send feedback about...

Gmail Add-ons
Gmail Add-ons
Need help? Visit our support page.