Publishing add-ons lets them to be used by other users. When you publish, you set the add-on visibility to determine who able to install the add-on.
You can publish your add-on publicly, so that any G Suite user can find and install it. You can also publish add-ons privately, for users in a specific domain only. Publishing add-ons publicly requires add-on review; publishing privately does not.
Editor add-ons are published to the Chrome Web Store, but can additionally be published to the G Suite Marketplace so that domain administrators can find and install them for users in their domain. Publishing to the G Suite Marketplace requires a few extra steps in the publication process.
This guide describes the process of publishing editor add-ons to the Chrome Web Store only. The publish add-ons for domains guide describes how to adjust the publication process so that an editor add-on is also published in the G Suite Marketplace, or so that an editor add-on is bundled with another G Suite Marketplace app.
Prior to publishing, your should verify that your editor add-on is functioning well. Use the checklist below to determine if your add-on is ready for publication.
- The editor 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.
- If you want to publish your add-on publicly, request verification before starting the publishing process.
- It is preferable to develop add-ons in a standalone script. Be sure to test your add-on to ensure the add-on is behaving correctly in Sheets, Docs, Slides, or Forms as appropriate. Verify the menus and functionality behave as expected for different states of installed and enabled.
- The script project's name is the same as the name intended for publication, as the script project name appears in the authorization dialog.
- The add-on has error-handling code and only shows appropriate error messages to the user.
- The add-ons script project includes an
onInstall(e)function that populates the menu (usually by calling
- To comply with the
limitations of the
AuthMode.NONE, the script project's global code and the
AuthMode.NONEpath of the
onOpen(e)function should not contain calls to services that require authentication.
- The script should not use libraries excessively, because libraries can cause the add-on to lose performance.
To publish an editor add-on for the first time, follow the steps below. If you also want to let G Suite domain administrators install and authorize your add-on for all users in their domain, follow the steps for domain-wide publication in the G Suite Marketplace as well.
Prepare and deploy your add-on
- 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 G Suite Marketplace SDK. This requires you to have access to the Cloud Platform project your add-on uses, which may not be the case if the script resides in Team Drive. If necessary you can switch your script to use a standard Cloud Platform project that you can access.
- Open the script project containing your add-on in the script editor.
- In the script editor, save a version of your project by clicking File > Manage versions, then Save New Version. Close the Manage Versions dialog.
- If publishing from a standalone script, click Publish > Deploy as web 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, Slides presentation, or Form, just click Publish > Deploy as Sheets add-on (Or Docs, Slides, or Forms add-on).
- If you have not done so already, you are prompted to accept the Apps Script Terms of Service. Read the terms carefully and click Accept.
- 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 G Suite 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 G Suite 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 opens 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)
- You will be prompted to accept the Chrome Web Store Terms of Service. Click Review, read the terms carefully, and click Accept.
- Close the Chrome Web Store window and return to the script editor.
- Click Publish > Deploy as web add-on once again (or Sheets, Docs, Slides, or Forms add-on, of course). The deploy dialog appears again. Review and click Create web store draft.
Complete application and publish your add-on
- 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 causes 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 G Suite domain. If you select Public, the add-on undergoes review before being displayed in the add-ons store.
- Click Publish changes, then click OK in the dialog that appears.
- 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 is available in the store.
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 while the add-on review process is conducted. See Add-on review for more information.
Update your editor add-on
To update an editor add-on that you have already published:
- Open the add-on project in the script editor.
- 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.
- Click Publish > Deploy as add-on (or Sheets, Docs, Slides, or Forms add-on).
- 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.)
- In the store listing, click Publish changes, then click OK in the dialog that appears.
- Visit the Chrome Web Store developer dashboard to see the publication status of your add-on.
Unpublish your editor add-on
To unpublish an editor add-on, visit the Chrome Web Store developer dashboard and click Unpublish in the listing for your add-on.