Publish an add-on

When you publish your add-on, you make it available for others to find, install, and use.

Before you publish

Determine your audience

To let any user find and install your add-on, publish it publicly. When you publish your add-on publicly, the Google team reviews your add-on before it’s published live on Google Workspace Marketplace.

To limit your add-on to users in a specific domain, publish it privately. When you publish your add-on privately to your domain, the Google team doesn’t review your add-on before it’s published.

Review the add-on publication requirements

Review the add-on publication requirements for your add-on type and verify that your add-on satisfies all of them. See Areas of review.

Verify collaborator access

Your add-on’s Apps Script project is owned by either a single user account (usually your own account) or a shared drive. To publish the add-on, a script collaborator must act as the publisher, which includes creating a standard Google Cloud project.

To publish the add-on, you must have edit access to the script project. If you're not the script project owner, your Workspace account must belong to the same domain as the project owner.

To verify collaborator access, see the overview for Building Google Workspace Add-ons.

Test your add-on

Make sure your add-on is fully functional and not a work in progress.

For testing purposes, you can install unpublished add-ons (also called Developer add-ons). You can share unpublished add-ons with others by sharing the Apps Script project.

Create a version of your add-on

Create a version of your add-on and record the version number. A version is a snapshot of code that your published add-on uses.

  • If you publish an Editor Add-on, you need to use the version number when you configure the Google Workspace Marketplace SDK.
  • If you publish a Google Workspace add-on, you need to use the deployment ID of the version you want to publish.

If your add-on uses an Apps Script library, you must also create and use a version of the library's script project. For more information, see Libraries.

Create a standard Google Cloud project

When you build your add-on in Apps Script, a default Google Cloud project is automatically created for it. However, you can’t use the default Google Cloud project to publish your app. Instead, use the steps below to create a standard Google Cloud project:

  1. Open the Google API Console projects list.
  2. Click Create Project.
  3. Fill out the project information for your add-on.
  4. Click Create.

After you create your standard Google Cloud project, switch your Apps Script project from your default Google Cloud project to the standard Google Cloud project.

Publish your add-on

When you’re ready to publish your add-on, follow the steps to publish an app in the Google Workspace Marketplace. See How to publish.