Configure your app in the Google Workspace Marketplace SDK

This page explains how to use the Google Workspace Marketplace SDK to configure and manage your app on the Google Workspace Marketplace.

To make your app available for use, you need to set it up in the Google Workspace Marketplace SDK. The Google Workspace Marketplace SDK is a toolkit that lets you create and control your app on the Google Workspace Marketplace. You use the Google Workspace Marketplace SDK to manage Marketplace settings, such as the following:

• Whether your app is available for a specific Google Workspace organization (a private app), or for all Marketplace users (a public app)
• The types of Marketplace users who can install your app
• Which Google Workspace application(s) your app integrates with
• The OAuth scopes that your app requires
• Information about who built and maintains the app

Regardless of whether you're publishing your app publicly or privately, you must use the Google Workspace Marketplace SDK to manage your app on the Marketplace.

Enable the Google Workspace Marketplace SDK

If you haven't already done so, in your Google Cloud project, enable the Google Workspace Marketplace SDK:

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

5. Open the Google Workspace Marketplace SDK page.

   Warning: Make sure you enable the Google Workspace Marketplace SDK, not the API. The Google Workspace Marketplace API is a different tool used to integrate with Google's licensing and billing services.

6. If the Google Workspace Marketplace SDK isn't already enabled, click Enable.

Enter app settings in the Google Workspace Marketplace SDK

1. Open the Google Workspace Marketplace SDK.
2. Go to the App Configuration tab.
3. Fill out each section with the information about your app. To learn about each setting, see the following section App configuration settings.
4. Click Save.
5. (Optional) You can get analytics on app usage in Google Analytics. To do so, add a Google Analytics ID in the Google Workspace Marketplace SDK.
   1. Go to the Analytics tab.
   2. Enter your Google Analytics ID.
   3. Click Save.

App configuration settings

The following reference describes the settings available in the App Configuration page of the Google Workspace Marketplace SDK.

App visibility

Warning: Once you choose a visibility option and save the App Configuration page, you can't change your selection later.

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 doesn't show in browse or search results. Users can only access the app's store page with the direct URL.

If you want to limit which countries and regions your app is available in, you set that up in the Distribution section when you create the store listing.

Installation settings

The installation settings determine if users or Workspace admins can install your app from your store listing page on the Google Workspace Marketplace.

Note: For Google Chat apps, you can only select Individual + Admin Install because individuals can discover and install Chat apps directly from Google Chat. For details about how installation works, see Publishing Google Chat apps.

• Individual + Admin Install (default): The app can be installed by individual users or by admins for their domain, organizational unit, or a group of users. 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, organizational unit, or a group of users. Your app only shows up in Google Workspace Marketplace search results for admins and people who aren't logged in to their Google Account. Choose this option if your app requires domain installation.

App integration

Choose the Google Workspace services your app or add-on is designed to work with, such as a Google Workspace Add-on or a Google Chat app. 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 Google Cloud project. The following table describes the additional setup needed for each:

Google Workspace Add-on (Apps Script)

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. Click Deploy > Manage deployments.
3. Under the deployment ID, click Copy.

Google Workspace Add-on (Alternate runtime)

If you built your Google Workspace Add-on in a coding language other than Google Apps Script, follow these steps to get the deployment ID from the Google Cloud deployment resource.

1. On the App Configuration page under "Google Workspace Add-on," click Deploy using cloud deployment resource > Select Deployment.
2. Select the deployment you want to publish.
3. Click Select.

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 left, click Project settings .
3. Under "IDs," 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 right, click Deploy > Manage deployments.
3. The version number is under "Configuration."

Google Chat app

To publish a Google Chat app, you must configure the Google Chat API. See Publishing apps.

Drive app

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

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 Google Workspace Add-on in the Apps Script editor.
2. Click Deploy > New deployment.
3. Under "Select type," click Web app.
4. Fill out the options and click Deploy.
5. Click Copy.

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.

Developer information

These fields appear on your app's store listing page.

Fields
Trader status	Due to consumer protection laws, consumers based in the European Economic Area (EEA) must be informed whether a merchant on the Google Workspace Marketplace is a trader or a non-trader: Trader—A trader is a person who acts for purposes relating to a trade, business, craft, or profession; or in the name of or on behalf of a trader. Non-trader—A non-trader (consumer) is a person who acts for non-professional purposes. If unspecified, "Trader status unspecified" appears on your app's store listing page.
Developer mailing address	Required for traders. Not collected for non-traders. The location of your business. Enter a valid mailing address where you can be contacted.
Developer name	The name to display as the author of the app. If you are a trader, provide your trading name or legal name.
Developer website URL	The website that describes you (or your organization) as the developer.
Developer email	The email address to use 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.
Application website URL	Optional. The website that further describes your app.