Publishing G Suite add-ons

After you've built and tested your add-on, you can publish it. Publishing add-ons allows them to be used by others, who can access and install them from the G Suite application and from the G Suite Marketplace.

You can publish your add-on publicly, so that any user can find and install it. You can also publish add-ons privately, for users in a specific domain only. If you are a G Suite domain administrator, you can install published add-ons—whether public or private—for your domain users.

Once you've successfully published an add-on, you can continue to improve it—see Updating published add-ons for more information.

In addition to published add-ons, you can also install an unpublished add-on—this lets you test it or just use it yourself without publishing.

Before you begin

Before you begin the publication process, it is important to understand your publishing options. Review the following and take the actions indicated.

Ensure your add-on meets all the publication requirements

Before you start the main publication process, you must verify you have satisfied all the necessary requirements, and have all the required publication assets.

Review every requirement listed in Publication requirements to verify that your add-on is ready for publication. Add-ons that don't meet all the publication requirements can't be published.

Use a standard Cloud Platform project

Publication requires that add-ons use a standard Cloud Platform (GCP) project, not the default Cloud Platform project that automatically attached to a new Apps Script project.

IIf your add-on is currently using a default Cloud Platform project, follow the instructions listed in Switching to a different standard GCP project to create a GCP project and attach it to your add-on. Once finished you may find that you need to re-authorize the add-on if you run it as an unpublished add-on.

Verify collaborator access

When you collaborate with others in developing an add-on, the add-on project is owned by a single user account or shared drive. When you publish an add-on, a single user account acts as the publisher. The publishing account must have edit access to the add-on script project, but it doesn't need to be the project owner.

Before you begin publication, be sure to determine and review your project collaborator access settings.

Decide on publishing visibility

When configuring your add-on for publication, you must choose to publish it as either a private or public add-on. This is the add-on's visibility.

  • Private add-ons are only visible to users in the same domain as the add-on publishing account. Only domain accounts can publish private add-ons. They can't be installed by outside users. Private add-ons do not require add-on review. Private visibility is also referred to as My Domain visibility.
  • Public add-ons are visible globally in the G Suite Marketplace. Anyone can install them if their domain policies allow it. Public add-ons must go through the add-on review process before they are published. This review process can take a few days to complete, and may require you to make changes to your add-on code.

Decide whether to allow individual installs

Domain administrators can install add-ons on behalf of some or all of their domain users. While configuring your add-on for publication, you can elect to also allow or prevent individual installs.

If individual installs are enabled, both admins and individual users can install your add-on. However, a domain user may still be prevented from installing an add-on if their domain policies prohibit it.

If individual installs are disabled, only domain admins are able to install your add-on for their domain users.

Individual installs are enabled by default.

After a user installs your add-on, they’re presented with a dialog that describes the requested permissions. You can customize some of the elements in this dialog to improve the user experience.

  1. Open the Google Cloud Platform console.
  2. At the top, make sure the Google Cloud Platform project associated with your add-on is selected.
  3. At the top-left, click Menu menu > APIs & Services > OAuth Consent Screen.
  4. Add details about your add-on, like application name and support email. These values should match what you display in your G Suite Marketplace listing; use the text assets you collected as part of the add-on publication requirements.

Step 2: Request reviews of your add-on

All G Suite add-ons, whether an upgraded add-on or one built from scratch, must be approved before they can be listed in the G Suite Marketplace.

Follow these steps to submit your add-on for review:

  1. Make sure your add-on fulfills all of the add-on publishing requirements, with special attention to the user data protection requirements.

  2. Create a versioned deployment of your add-on using the version of the code you want to publish. Do not attempt to publish using a head deployment. Record the deployment ID for use later.

  3. Share your Apps Script project with addonsreviewer2@gmail.com to ensure that the add-on review team can view (not edit) the code and provide feedback.

  4. Submit an add-on approval request form. This begins the add-on approval process, which can take several days to complete. After approval, you can enable and configure the G Suite Marketplace SDK.

  5. Request OAuth verification. This requires that you show ownership of a domain and that you have a privacy policy hosted within that domain. The verification process can take 72 hours or more to complete. Request verification only after the add-on review process is finished, otherwise you might need to repeat the process.

    Verification for sensitive scopes are expected to take 3-5 days to account for clarification questions and re-submissions. Verification for restricted scopes can take longer to complete, likely several weeks. User access to the add-on for existing approved scopes is not impacted during the verification process.

Step 3: Enable the G Suite Marketplace SDK

After your add-on is approved, you can configure the appearance of your G Suite Marketplace listing with the G Suite Marketplace SDK.

  1. Open the Google Cloud Platform console.
  2. At the top, make sure the Google Cloud Platform project associated with your add-on is selected.
  3. At the top-left, click Menu menu > APIs & Services > Dashboard.
  4. In the API dashboard, click Enable APIs and Services.
  5. In the Search for APIs & services search bar, type "G Suite Marketplace SDK". Then, select the API.
  6. In the API listing that opens, click Enable. After a moment the SDK overview control panel opens.

Step 4: Configure your G Suite Marketplace listing

The G Suite Marketplace SDK settings page has four panels: Overview, Configuration, Publish, and Usage. Follow the steps below to build your add-on's listing and start a publication request:

  1. Open the G Suite Marketplace SDK control panel.

  2. On the left, click Configuration to open the configuation panel. This panel contains a form where you provide information about your add-on.

  3. Complete the form using the required assets. Some of the form elements are optional, but providing them can improve your add-on's user experience.

    • Where indicated, provide localized assets for each language you intend to publish the add-on in.
    • Check the Enable individual install checkbox if you want to allow individual installs.
    • Under OAuth 2.0 Scopes, include every scope listed in your add-on's Apps Script project's manifest.
    • Under Extensions, check the G Suite Add-ons Extension checkbox. In the textbox that appears, enter the new deployment ID you created in step 2 for your G Suite add-on. If your deployment ID is valid, a list of supported hosts appears.
    • Under Visibility, select Public.
  4. Verify that the information you've entered in the form is correct. Then, click Save changes.

  5. On the left, click Publish to open the publishing panel.

  6. Complete the form using the required assets. Some of the form elements are optional, but providing them can improve your add-on's user experience.

    • Where indicated, provide localized assets for each language you intend to publish the add-on in.
    • In the Reach section, select an appropriate category for your add-on to help users locate it in the Marketplace. Also select the regions and countries where you want Marketplace to present your add-on. It's best practice to provide localized assets for each language used in the regions you select.
  7. Review the information you’ve entered. You won’t be able to modify any of the fields until a final review is completed, so make sure you double-check all fields.

  8. Click Publish. Your add-on configuration is now automatically sent for final review. A review team member will send you an email to confirm whether your add-on has been approved and published to the marketplace or whether it needs more work.

After final approval, the add-on enters the Marketplace.

If you have questions or encounter an issue during this publishing process, contact us.