Hide
Apps Script

Publishing an Add-on

The Apps Script add-ons framework is currently in developer preview. Although the features necessary to build add-ons are available to everyone, add-ons must be submitted for approval before publication. We encourage you to start developing your add-on today and submit it through the form below.

Once we have approved your add-on, we will send detailed information about the publishing process and provide tools for testing your add-on.

Development checklist

Approval depends on the quality of your add-on and its integration with Google Sheets, Docs, or Forms. Use the checklist below to determine if your add-on is ready to be submitted for approval.

General

  • The add-on must be fully functional — it can't be a “work in progress.”
  • The script has been tested with multiple active users.
  • The design adheres to the UI style guide.

Technical

  • The add-on script is bound to a Sheets, Docs, or Forms file.
  • The script's project name is the same as the name intended for publication. (The script name appears in the authorization dialog.)
  • The script has error-handling code and only shows appropriate error messages to the user.
  • The script does not log debug information to the JavaScript console.
  • The script includes an ‘onInstall(e)’ function that populates the menu (usually by calling ‘onOpen(e)’). All custom menu items must be place under the “Add-ons” tab.
  • To comply with the limitations of the no-authorization mode, the script's global code and the ‘AuthMode.NONE’ path of the ‘onOpen(e)’ function should not contain calls to services that require authentication.
  • The script does not use libraries, which can cause the add-on to run slowly.

Apply to publish

Please fill out the application form below to submit your add-on for review.

Publishing instructions

To publish an add-on for the first time, follow the steps below. If you also want to let Google Apps domain administrators install and authorize your add-on for all users in their domain, follow the steps for domain-wide publication as well.

Prepare and deploy your add-on

  1. Open the Google Sheets, Docs, or Forms file that contains your add-on and click Tools > Script editor.
  2. In the script editor, save a version of your project by clicking File > Manage versions, then Save New Version. Close the Manage Versions dialog.
  3. Click Publish > Deploy as Sheets add-on. (Or Docs or Forms add-on.)
  4. If you have not done so already, you will be prompted to accept the Apps Script Terms of Service. Read the terms carefully and click Accept.
  5. In the Deploy as Add-on dialog, fill all required fields. The add-on’s name must be the same as the name of the Apps Script project. See the style guide for more information on the other fields. Select the most recent version of your code and click Create web store draft.

Accept the Terms of Service (if previously accepted, skip this section)

  1. You will be prompted to accept the Chrome Web Store Terms of Service. Click Review, read the terms carefully, and click Accept.
  2. Close the Chrome Web Store window and return to the script editor.
  3. Click Publish > Deploy as Sheets add-on once again. (Or Docs or Forms add-on, of course.) The Deploy as Add-on dialog will appear again. Review and click Create web store draft.

Complete application and publish your add-on

  1. Fill in the Edit Item form on the Chrome Web Store page.
    • Do not upload a file in the Upload section at the top of the page.
    • Upload an icon, a screenshot, and a 440px × 280px tile image, as detailed in the Chrome Web Store documentation.
    • Select a Category and Language.
    • Under Visibility options, select Unlisted if you eventually intend to publish to the public add-on store, or Private if you intend to publish only for users within your domain.
  2. Click Publish changes, then click OK in the dialog that appears.
  3. Visit the Chrome Web Store developer dashboard to see the status of your add-on. Once the "Status" column says "Published", your add-on will be available in the store. Publication may take a few minutes.

Update your add-on

To update an add-on that you have already published:

  1. Open the Google Sheets, Docs, or Forms file that contains the Apps Script project for your add-on and click Tools > Script editor.
  2. Make the necessary changes to your code, then save a new version of your project by clicking File > Manage versions, then Save New Version. Close the Manage Versions dialog.
  3. Click Publish > Deploy as Sheets add-on. (Or Docs or Forms add-on.)
  4. In the dialog that appears, change the add-on's details as needed, select the new version of your script, then click Update store item. (If you change the add-on's name, make sure you also change the name of the Apps Script project to match, as the project name is shown in the authorization dialog.)
  5. In the store listing, click Publish changes, then click OK in the dialog that appears.
  6. Visit the Chrome Web Store developer dashboard to see the status of your add-on.

Unpublish your add-on

To unpublish an add-on, visit the Chrome Web Store developer dashboard and click Unpublish in the listing for your add-on.