G Suite Marketplace SDK

The G Suite Marketplace SDK is a toolkit that allows you to control the content and appearance of your application's listing—the text and graphics that describe your application in the G Suite Marketplace.

Step 1: Enable the G Suite Marketplace SDK

If you haven't done so already, you must enable the G Suite Marketplace SDK in your application's Google Cloud Platform project.

  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 application project and click Open.
  4. At the top, in the search bar, type G Suite Marketplace SDK and press enter.
  5. Click Enable.

Step 2: Configure your app listing

  1. Open your app's Cloud Platform project in the APIs & Services dashboard.
  2. Under Name find and click G Suite Marketplace SDK.
  3. At the left, click App Configuration.
  4. Fill out each section with the information about the app you want to publish. Learn more about each section below.
  5. When you're finished, at the bottom, click Save.

About App Configuration

You must complete the App Configuration page for every app you want to publish in the G Suite Marketplace. Each section of the App Configuration page is described below.

App Extension

Choose the G Suite services your app is designed to work with as a third-party service. You must choose at least one option.

OAuth Scopes

Provide a complete list of all the OAuth scopes the application requires. These scopes are determined by the API calls the application uses. The OAuth scope you enter here should match what you display in the OAuth consent screen and include in your app's manifest. Always use the narrowest scopes possible (for example, don't include a full Drive scope when a read-only scope is all your application needs). For Apps Script projects, see Scopes for more details.

  • Application website URL: The website that describes your application (optional).
  • Developer name: The name to display as the author of the application.
  • Developer website URL: The website that describes you (or your organization) as the developer of the application.
  • Developer email: The email address that's used as a point of contact for the application. This email address isn't included in the G Suite Marketplace listing. It’s used if Google needs to contact the application developer.

Listing Data

Add a Google Analytics ID to track your app's G Suite Marketplace listing in Google Analytics (optional). See Use analytics for more information.

Installation Settings

By default, G Suite Marketplace apps are visible and installable by G Suite domain administrators and individuals. To limit your app to admins only, select Admin Only Install.

App Visibility

If you're using a free Gmail account, you won't see this option.

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

If you also choose to publish your app as Unlisted, it won't be shown in browse or search results. It can only be accessed by the direct URL.

Step 3: Complete your Store Listing

The Store Listing page is where you describe your application to potential users. This is how you advertise your application within the Marketplace, so you should construct it thoughtfully.

  1. At the left of the G Suite Marketplace SDK, click Store Listing.
  2. Fill out each section with the information about the app you want to publish. Learn more about each section below.
  3. Review all the information in each of the forms carefully to ensure what you have provided is complete and accurate.
  4. To save the information and initiate a publication request, click Publish.

Assets needed for G Suite Marketplace Store Listing

Some of the below assets are optional, but providing them can help make your listing more descriptive.

App Details

The text in your listing describes your application to potential users. The following information is required:

  • Language: If your application supports multiple locales, you should create localized versions of your application's name, descriptions (short and detailed), and screenshots.
  • Application name: This is the name of the application shown in the listing and should match the name in the OAuth consent screen. Limit your application name to 50 characters or less to ensure it displays well. Don’t use the word "Google" or other Google product names.
  • Short description: A short summary of what your application does (200 characters limit).
  • Detailed description: A longer description of what your application can do for the user. It's presented in the Overview section of the G Suite Marketplace listing, under the screenshots you provide. Limit this to less than 16,000 characters.
  • Category: Select the category most appropriate for your app. When you publish, your app appears in that collection for greater discoverability.

Graphic Assets

Marketplace listings use graphics to illustrate and advertise applications. You must provide the graphics used in your listing, with the specified image sizes.

The following graphic assets are required:

  • Application icon images: All applications require at least two icon images—one sized to 128 x 128 pixels and another to 32 x 32 pixels. Applications configured to be a web app also require 96 x 96 and 48 x 48 pixel icons.
  • An application card banner image: Sized to 220 x 140 pixels.
  • Screenshots of your application: At least one is required, but you can provide up to five screenshots. These should be 1280 x 800 pixels in size. If necessary, screenshots 640 x 400 pixels or 2560 x 1600 pixels in size can be used. Your screenshots should have square corners and no padding (full bleed).

Optionally, you can add a link to a YouTube video that describes your application and shows it in action.

Add links to your Marketplace listing that let users learn more about your application. The following URLs are required:

  • Terms of service: A link to a web page that describes your application's terms of service.
  • Privacy policy: A link to a web page that describes your application's privacy policy.
  • Support: A link to a web page that describes how your users can get help from you if they're having issues with the application.

You can further enhance your application listing by providing the following URLs:

  • Setup: A link to a web page that describes how to set up your application after it's first installed. Recommended if the application requires configuration that is hard to explain well within the application itself.
  • Admin config: A link to a web page that tells domain administrators how to configure the application for use by their users. Unnecessary unless the application requires additional configuration for domain-wide installation.
  • Deletion policy: A link to a web page that describes how and when your application deletes user data. Strongly recommended if the application collects and stores user data.
  • Help: This link is used with editor add-ons in the Help menu. If you add this URL, a Learn More button is added to your editor add-on's Help menu.
  • Report issue: This link is used with editor add-ons in the Help menu. If you add this URL, the Report an issue button opens that URL. If you don't provide a URL, a user can write a report that's sent to the developer email address. If the developer email isn't provided, the report is sent to the publisher of the add-on.

Distribution

The Distribution section has a list of world region checkboxes. By default, your application is set to All regions.

To restrict which regions you want your app to be presented in, uncheck the box next to All regions and choose the regions you want. For example, checking "South Africa" only directs the G Suite Marketplace to include your app in the store for users in South Africa and nowhere else.

Use analytics

If you provide a Google Analytics ID when configuring the G Suite Marketplace SDK for your application, you can monitor how users interact with your app's Marketplace listing from Google Analytics. Here is some of the information Google Analytics can provide about your listing:

  • How many visitors have viewed your listing for a specific time period. A visit is only counted if the visitor clicks on your G Suite Marketplace listing to view the application details.
  • The geographic distribution of visitors.
  • How visitors are reaching your listing (that is, whether they are finding the listing from a Google search, the Admin console, or some other means).
  • The average time spent viewing your listing.
  • Install events that are created when users start installing your application and finish installing your application. These events let you determine how often an install process was aborted and how many installs were completed over time.

You can access your listing's analytic data from Google Analytics once the G Suite Marketplace SDK is configured and the application listing is published.

To find install information in Google Analytics, search using the following event information:

Install events
When an install of the application is started. category=GSUITE_MARKETPLACE
action=START_INSTALL
When an install of the application is completed. category=GSUITE_MARKETPLACE
action=FINISH_INSTALL