The G Suite Marketplace SDK (also known as the "Apps Marketplace SDK") is a toolkit that allows you to control the content and appearance of the application's listing—the text and graphics that describe your application in the G Suite Marketplace.
Before you can publish, you must enable the SDK in the application's Cloud Platform project and then configure the SDK to define your listing. Configuring the listing requires that you provide a number of text and graphic assets, so you should assemble those prior to starting this process.
Assets needed for Marketplace listings
Your application's listing in the G Suite Marketplace describes your application to potential users. It is also how you advertise your application within the Marketplace, so you should construct it thoughtfully.
The listing is comprised of several text and graphic assets which you must provide. Some of the assets are optional, but providing them can help make you listing more descriptive. The assets used by the G Suite Marketplace SDK are described below.
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 additional graphic assets are required to build the G Suite Marketplace listing for your application:
- An application banner image. Sized to 220 x 140 pixels.
- Screenshots of your application. At least one is required, but you can optionally 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).
- Icon images. All applications require one icon image sized to 128 x 128 pixels and another to 32 x 32 pixels. Applications configured to be Universal navigation extensions also require 96 x 96 and 48 x 48 pixel icons.
The text in your Marketplace listing describes your application to potential users. The following text assets are required to build the G Suite Marketplace listing for your application:
- Application name. The name of the application shown in the listing; this should match the Product name shown to users in the OAuth consent screen. Limit this string to 15 characters or less to ensure it displays well in the G Suite Marketplace listing. Do not use the word "Google" or other Google product names.
- Short application description. A short summary of what your application does. Limit this to 200 characters or less.
- Detailed application description. A longer description of what your application can do for the user. It is presented in the Overview section of the G Suite Marketplace listing, under the screenshots you provide. Limit this to less than 16,000 characters.
- Scopes. A complete list of all the OAuth scopes the application requires. These scopes are determined by the API calls the application uses. 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.
In addition to the required text assets, you can optionally provide the following details:
- Developer name. The name you want displayed as the author of the application in the listing.
- Developer email. An email address that is used as point of contact for the application. This email address is not included in the G Suite Marketplace listing; rather, it is used if Google needs to contact the application developer (strongly recommended).
- Google Analytics ID. A Google Analytics ID you can use to track your app's G Suite Marketplace listing in Google Analytics. See Using analytics for more information.
By providing the following URLs, you create links in your Marketplace listing that allow users to learn more about your application. The following URLs are required to build the G Suite Marketplace listing for your application:
- Terms of Service URL. A URL to a web page that describes your application's terms of service.
- Developer website URL. A URL to a web page that identifies you (or your organization) as the developer of the application.
You can further enhance your application listing by providing the following URLs:
- Application website URL. A link to a web site that describes your application. This is distinct from the above developer website URL, which is a page that describes you or your organization.
- YouTube video URL. A link to a YouTube video that describes your application and shows it in action.
- Setup URL. A link to a web page that describes how to set up your application after it is first installed. Recommended if the application requires configuration that is hard to explain well within the application itself.
- Admin config URL. 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 a domain-level configuration.
- Support URL. A link to a web page that describes how your users can get support from you if they are having issues with the application. Recommended.
- Deletion policy URL. 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.
- Product logo URL. A link to a hosted image logo to display on the application's OAuth consent screen. The image should be no larger than 120 x 120 pixels.
If your application supports multiple locales, you can localize your listing. To do this, you should create localized versions of your application's Screenshots, Application descriptions (short and detailed), and Application name for every locale your application supports.
Enabling the Marketplace SDK
If you have not done so already, you must enable the Marketplace SDK in your application's Google Cloud Platform project. Search for and enable the "G Suite Marketplace SDK".
Configuring the Marketplace SDK
Once you have enabled the SDK in your application Cloud Platform project and assembled the listing assests, you are ready to configure the Marketplace SDK to define your application listing. The SDK configuration settings consists of four panels:
- Overview provides general information about the SDK.
- Configuration provides a place for you to enter information about the app listing. You must fill out this panel for every app you want to publish in the Marketplace.
- Publish provides a place for you to give some supplemental information about the app listing. It also lets you see the publication status of the app, and it lets you start a publication request. If you are publishing the app to the Chrome Web Store in addition to the Marketplace, you must use the Chrome Web Store dashboard instead of this panel.
- Usage provides you information about how your published app is being used.
To fully configure your app listing, you must either:
- Complete the Configuration and Publish panels (for apps only published to the G Suite Marketplace), or
- Complete the Configuration panel and then complete the entry in the Chrome Web Store dashboard. See Publishing using the Chrome Web Store for more details.
Completing the Configuration panel
You can configure the Marketplace listing by doing the following:
- Open your app's Cloud Platform project in the APIs & Services dashboard and find the "G Suite Marketplace SDK" you enabled. Click the icon to open the SDK control panel. This panel has four tabs; select Configuration if it isn't already selected.
- The Configuration panel has a large form where you can provide the assets you assembled. Fill in the form, providing each asset where indicated and selecting options appropriate for your application. See Other SDK options for descriptions of the form elements that aren't asset related.
- When you've finished filling out the Configuration panel, click Save changes.
For applications that are published through the Chrome Web Store, this completes the Marketplace SDK configuration.
Completing the Publication panel
If your application (such as a Gmail add-on) is published to the G Suite Marketplace only, you must complete a few more steps:
- Select the Publish tab to continue configuring the SDK.
- The Publish panel is another form where you provide additional assets and information. As with the prior form, fill in the form, providing each asset where indicated and selecting options appropriate for your application. See Other SDK options for descriptions of the form elements that aren't asset related.
- Review all the information in each of the forms carefully to ensure what you have provided is complete and accurate.
- Click the Publish button to save the information and initiate a publication request.
Other SDK options
There are a few form elements in the Configuration and Publish panels that only require you to make a choice (instead of providing a text or graphic asset).
Enabling individual installs
By default, G Suite Marketplace apps are only visible and installable by G Suite domain administrators. You can choose to let individual users install your apps by checking the Enable individual install checkbox in the Configuration panel:
If checked, this option interacts with the visibility options on the Chrome Web Store developer dashboard:
- If the visibility is Private, then only users in the domain can discover and install the app.
- If the visibility is Public, then any user with a Google account, whether within a G Suite domain or not, can discover and install the app.
The Extensions section of the Configuration panel lets you define how your app is accessed. There are several options, one of which must be enabled and configured:
- Universal Navigation Extension. This places a menu item for your app in the universal navigation bar, displayed at the top of the page in each Google app. You'll need to include a link URL in the field that appears.
- Drive Extension. This makes your app a Google Drive app. This requires you to enable and configure the Google Drive SDK in addition to the Marketplace SDK.
- Hangouts Chat bot. This allows your app to be used as a Hangouts Chat bot. This requires you to enable and configure the Hangouts Chat API in addtion to the Marketplace SDK.
Add-on Extensions. You can publish add-ons for Google Sheets, Docs, Slides, Forms, and Gmail to the Marketplace. To publish these extensions you need the following:
- The project script ID, which you can find by selecting File > Project properties in the Apps Script editor.
- The project script version, which you can find by selecting File > Manage versions in the Apps Script editor.
- List of OAuth scopes, which you can find by selecting File > Project properties > Scopes in the Apps Script editor.
If you are configuring the SDK using a domain account, the Configuration panel displays a Visibility section with two choices: Public and My Domain.
- Public indicates that the application, when published, can be found by and installed any admin from the G Suite Marketplace. If Enable individual install is also checked, any user can find and install the application as well.
- My Domain (also known as Private visibility) indicates that only admins in your domain can find and install the app from the G Suite Marketplace. If Enable individual install is also checked, users in your domain can find and install the application as well.
If you are configuing the SDK using Gmail or other non-domain account, the Visibility section does not appear in the SDK and the app can only have Public visibility.
In the Publish panel, there is Reach section where you can define a Category your application belongs to (such as "Accounting & Finance" or "Office Applications"). Select the category most appropriate for your app; when you publish, G Suite Marketplace places your app in that collection for greater discoverability.
The Reach section also has a list of world region checkboxes. You can restrict which regions you want your app to be presented in; for example, checking "South Africa" only directs Marketplace to include your app in the store for users in South Africa and nowhere else. You can also check All regions to have your app included in every region's Marketplace.
If you provide a Google Analytics ID when configuring the G Suite Marketplace SDK for your application, you are able to 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:
|When an install of the application is started.||
|When an install of the application is completed.||
Updating a Marketplace listing
You can update a published app's Marketplace listing at any time. For example, you may want to clarify something in the app description or include new screenshots. To update your listing, follow these instructions.