Click here to see your recently viewed pages and most viewed pages.
Hide
Apps Script

Publishing an Add-on

Publishing add-ons allows them to be used by other users in their own documents. Public add-ons require a review before publication, although if you are a member of a private Google Apps domain, you can publish just for users within your domain without a review. You can also publish an add-on for domain-wide installation, which lets a domain admins find, authorize and install your add-on on behalf of all users within their domain.

Development checklist

Prior to publishing, your should verify that your add-on is functioning well. Use the checklist below to determine if your add-on is ready for publication.

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 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)).
  • 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 add-on script has been tested to verify the menus and functionality behave as expected for different states of installed and enabled.
  • The script does not use libraries, which can cause the add-on to run slowly.

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. If you want to allow admins to find and install your add-on for users in their domains (domain-wide installation), follow the steps to configure the Google Apps Marketplace SDK.
  2. Open the script project containing your add-on in the script editor.
  3. In the script editor, save a version of your project by clicking File > Manage versions, then Save New Version. Close the Manage Versions dialog.
  4. If publishing from a standalone script, click Publish > Deploy as add-on and in the resulting dialog select the appropriate add-on type in the Add-on Type box. If publishing from a script bound to a Sheet, Doc, or Form, just click Publish > Deploy as Sheets add-on. (Or Docs or Forms add-on.)
  5. 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.
  6. 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. The checkbox next to Publish in Google Apps Marketplace should be checked only if you are publishing the add-on for domain-wide install and you are not bundling the add-on with an existing Google Apps Marketplace app. 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. This will open a new page for you to configure the add-on for inclusion in the Chrome Web Store.

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; Apps Script generates this file automatically for you and uploading a separate file will cause the publication to fail.
    • 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 Public if you want to publish to the public add-on store, or Private if you intend to publish only for users within your private Google Apps domain. If you select Public, the add-on will undergo review before being displayed in the add-ons store.
  2. Click Publish changes, then click OK in the dialog that appears.
  3. Visit the Chrome Web Store developer dashboard to see the publication status of your add-on. Once the "Status" column says "Published", your add-on will be available in the store.

Add-on review

If you published as Private, publication should be complete after a few minutes. However, if you selected the Public visibility setting, your add-on will require review and will be labeled as Pending review the Chrome Web Store developer dashboard.

All public add-ons are subjected to review to ensure they are designed well, follow the UI Style Guide, and that they do not include or produce any spam, malware, or unacceptable content. After the review is finished, you will receive an email communicating whether your add-on has been approved (and added to the Add-ons store) or if it requires additional work before it is publicly available.

If your add-on requires additional work, please refer to the Review Document sent to you for more specific information. Please address all issues and, when ready, re-publish your add-on with the Public visibility setting (following the same steps you used previously, but with an updated add-on version). Many developers will be required to improve their add-ons prior to public release; some may be required to do this multiple times. You may always email/respond to our review team for more information and guidance with this process.

Update your add-on

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

  1. Open the add-on project in the 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 add-on. (Or Sheets 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 publication 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.