Enable and configure the Google Workspace Marketplace SDK

If you haven't already done so, in your Google Cloud Platform (GCP) project, enable the Google Workspace Marketplace SDK.

  1. Open the Google Cloud Platform console.
  2. At the top, click Select a project. If a different project is already open, click the project name to switch projects.
  3. Select your app’s project and click Open.
  4. At the top, in the search bar, type Google Workspace Marketplace SDK and press enter.
  5. On the Google Workspace Marketplace SDK page, click Enable.

Fill out the Google Workspace Marketplace SDK App Configuration page

  1. In the Google Workspace Marketplace SDK, at the left, click App Configuration.
  2. Fill out each section with the information about your app. Learn more about each section below.
  3. At the bottom, click Save.

About App Configuration

App Extension

App extension is the app integration you want to publish, such as a Google Workspace Add-on or a Google Chat bot. You must choose at least one option. In some cases, you can include multiple app integrations in your app listing. See List app integrations together.

Depending on which app integrations you choose, you might need to provide more information and enable relevant APIs in your GCP project. The following describes the additional setup needed for each:

Google Workspace Add-on

To publish a Google Workspace Add-on, you must provide the add-on’s deployment ID. To find the deployment ID, follow these steps:

  1. Open your Google Workspace Add-on in the Apps Script editor.
  2. At the top, click Publish > Deploy from manifest.
  3. At the right of the version you want to publish, click Get ID.

Google Chat bot

To publish a Google Chat bot, you must configure the Google Chat API. See Publishing bots.

Web app

To publish a web app, you must provide its universal nav URL, the URL that points to the web app from the Google apps menu . Your web app must be in production and fully functional.

When you fill out the Store Listing page, you must provide additional icons sized to 96x96 and 48x48 pixels.

If you built your web app in Apps Script, to get the universal nav URL, follow these steps:

  1. Open your web app in the Apps Script editor.
  2. At the top, click Publish > Deploy as web app .
  3. Fill out the options and click Deploy.
  4. Copy the URL.

Drive app

To publish a Drive App, you must enable and configure the Drive API.

Editor Add-on (Docs, Sheets, Slides, Forms)

To publish an Editor Add-on, you must provide the project script ID and version you want to publish.

To find the project script ID, follow these steps:

  1. Open the add-on in the Apps Script editor.
  2. At the top, click File > Project properties.
  3. Copy the script ID.

To find the version, follow these steps:

  1. Open the add-on in the Apps Script editor.
  2. At the top, click File > Manage versions.
  3. Find the version number of the version you want to publish.

OAuth Scopes

Provide a complete list of the OAuth scopes your app requires. The OAuth scopes you enter here should match what you display in your OAuth consent screen and if applicable, Apps Script manifest.

If you include more than one app integration, make sure you add the scopes from each one to the Google Workspace Marketplace SDK App Configuration page and your OAuth consent screen.

Always use the narrowest scopes possible (for example, don't include a full Drive scope if you only need a read-only scope).

For Apps Script projects, see Scopes for more details.

  • Application website URL: The website that further describes your app (optional).
  • Developer name: The name to display as the author of the app.
  • Developer website URL: The website that describes you (or your organization) as the developer.
  • Developer email: The email address that's used as a point of contact. It’s not included in your app listing. Make sure this email address is kept up to date, it’s used:
    • If Google needs to contact the developer, for example, during the app review process.
    • To send feedback from Editor add-ons if a Report Issue URL isn’t provided on the Store Listing page.

Listing Data

Add a Google Analytics ID to track your app listing in Google Analytics (optional). For more information, see Obtain analytics on app usage.

Installation Settings

  • Individual + Admin Install (default): The app can be installed by individuals for themselves or by admins for their domain. A user's domain policies might prevent them from installing an app even if individual installs are enabled.
  • Admin Only Install: The app can only be installed by admins for their domain, and can’t be installed by individuals. Choose this option if your app requires domain installation to work.

App Visibility

You see the App Visibility option if you’re using a Google Workspace account (an account created by your work or school organization). If you’re using a consumer account (an account ending with “@gmail.com”), you can only publish publicly.

  • Public: The app can be found and installed by people outside of your domain. If you choose public visibility, Google reviews and approves your app listing before it's published.
  • Private: Only people within your domain can find and install your app.

If you choose to publish as Unlisted, the app listing won't show in browse or search results. Users can only access the app’s store page with the direct URL.