Chrome Web Store migration

In order to streamline the add-on discovery experience for users and to facilitate add-ons publication, we are phasing out publication of add-ons to the Chrome Web Store. Once this process is completed, the G Suite Marketplace will be the sole add-on store. Chrome extensions will continue to be presented in the Chrome Web Store and are unaffected by this change.

To prepare for this shift, all add-ons must have a G Suite Marketplace listing prior to August 26, 2019. In the short term this means editor add-ons will be listed in both the Chrome Web Store and the G Suite Marketplace, but sometime after this date the add-on Chrome Web Store listings will be removed.

This guide provides information about this migration, and explains the steps you need to take (if any) to ensure your add-ons are listed properly in the G Suite Marketplace when published.

Background

Originally when a developer published an editor add-on the resulting listing was added to the Chome Web Store. When a user selects Add-ons > Get add-ons... from the editor menu, the resulting dialog is populated from Chrome Web Store listings.

In addition to publishing in the Chrome Web Store, developers could optionally publish in the G Suite Marketplace as well. This was referred to as publishing for domain-wide installation, because doing so would allow domain admins to find the add-on in the G Suite Marketplace and install it on behalf of their domain users.

The decision to phase out the Chrome Web Store means that publishing for domain-wide installation is no longer optional. For now, new and existing add-ons must be published to both stores, but once the phase out is complete add-ons will only need to publish to the G Suite Marketplace.

Once this phase out is complete, the G Suite Marketplace will handle all add-on listings, for users and domain administrators.

What you need to do

Depending on how you published your add-on, you may need to take action. Read the following to determine what actions are required, if any.

  • If your editor add-on isn't published yet, publish it to both the Chrome Web Store and the G Suite Marketplace. Sometime after August 26, 2019 the add-on publication instructions will be revised again to only describe publication to the G Suite Marketplace.

  • If your editor add-on is already present in the G Suite Marketplace (because you published it for domain-wide installation), you do not need to take any further action.

  • If you published your editor add-on but it only is present in the Chrome Web Store, you must create a new G Suite Marketplace listing for your add-on.

  • If your editor add-on shares a Cloud Platform project with other add-ons or extensions, you must configure it to remain bundled in the G Suite Marketplace, create a separate Cloud Platform project and G Suite Marketplace listing for the add-on, or else unpublish it. See Configure bundled add-ons for more details.

Create a new G Suite Marketplace listing for an editor add-on

If your editor add-on was published but not for domain-wide installation, the add-on's listing only appears in the Chrome Web Store. To migrate your add-on, you must take a few steps to create a new G Suite Marketplace listing:

  1. Review the required assets for G Suite Marketplace listings and make sure you have these assets for your add-on. These assets are used to define the appearance and content of your add-on's G Suite Marketplace listing. The add-on's original Chrome Web Store listing also uses some of these assets; you can reuse the same asset in the G Suite Marketplace.
  2. Enable the G Suite Marketplace SDK in your add-on's Cloud Platform (GCP) project, if it isn't already.
  3. Complete the Configuration panel in the SDK settings, using the assets you assembled. You must provide a Terms of Service URL for your add-on. Be sure to click Save changes when finished.
  4. Complete the Publish panel in the SDK settings, using the assets you assembled.
  5. In the Publish panel, click Publish to start the publication process.

Configure bundled add-ons for the G Suite Marketplace

Extensions are apps that extend G Suite appplications. Editor add-ons, Gmail add-ons, Drive apps, and Hangout Chat bots are all extensions. If you've published editor add-ons to the Chrome Web Store, you may have a situation where multiple add-ons share the same Cloud Platform project, possibly along with other extensions apps. This is known as bundling and it allows users to install multiple extensions as a single package.

The G Suite Marketplace allows developers to bundle add-ons and other extensions, provided that only one extension of a given type is present in the bundle. For example, a single listing can install both a Google Docs add-on and a Google Sheets add-on, but not two Google Sheets add-ons. To migrate your Chrome Web Store listings as a bundle it is required that they have a corresponding extension listing in the G Suite Marketplace. After the migration is complete, users can only install these extensions as a bundle.

When this is not possible or desired, the add-on's Chrome Web Store listing must be associated to a different Cloud Platform project, or else unpublished.

Configuration instructions

Since you have multiple Chrome Web Store listings sharing a common Cloud Platform project, you must examine each and determine how you want that listing to be represented in the G Suite Marketplace, if at all.

First, determine which extensions in your Cloud Platform project are already published in the G Suite Marketplace:

  1. Open your app's Cloud Platform project in the APIs & Services dashboard and find and click the "G Suite Marketplace SDK" link.
  2. In the left-nav menu, click Configuration.
  3. Scroll down the section titled Extensions.
  4. For each extension that is published in the G Suite Marketplace, the corresponding extension option checkbox is checked and the resulting form elements are completed. For example, if you have a Google Docs add-on published in the G Suite Marketplace, the Docs add-on extension option is checked and the correct script key and script version are provided. For Drive apps, the Drive extension box is checked. Review the list of checked extensions to determine which are already published to the G Suite Marketplace. You don't need to take any further actions for these extensions.
  5. For editor add-ons, make sure that the account publishing the add-on the Chrome Web Store has access to the add-on's script project.

Chrome Web Store listings that have a corresponding listing in the G Suite Marketplace are migrated automatically; no further action is needed. For each add-on or extension that isn't in G Suite Marketplace you must decide how you want that extension presented. You have the following options:

  1. Bundle the extension with the main G Suite Marketplace listing. In other words, keep the extension connected to the one that is already published and listed in the G Suite Marketplace. This results in the extension being installed when a user installs from that G Suite Marketplace listing (in addition to any other extensions that listing installs). However, you can't have more than one extension of the same type connected to the same Marketplace listing. For example, a single G Suite Marketplace listing could install a Google Sheets add-on and a Google Docs add-on, but it couldn't install two different Google Docs add-ons. If you choose this option, do the following for each extension you want to bundle:

    1. Open the main app's Cloud Platform project in the APIs & Services dashboard and find and click the "G Suite Marketplace SDK" link.
    2. In the left-nav menu, click Configuration.
    3. Scroll down the section titled Extensions.
    4. For each G Suite extension that you want bundled with the main G Suite Marketplace listing, make sure the corresponding extension option checkbox is checked and the resulting form elements are completed. For example, if the extension is a Google Docs add-on, confirm that the Docs add-on extension option is checked and that the correct script key and script version are provided. For Drive apps, make sure the Drive extension box is checked.
    5. Click Save changes.
  2. Publish the extension to G Suite Marketplace separately. This option unbundles the extension from the others in the G Suite Marketplace. For this you must create a new Cloud Platform project for the extension, and configure a new G Suite Marketplace listing for it. This process also requires that existing users reauthorize the extension the next time they attempt to use it. Triggers and interactive add-on operations stop running until reauthorized.

    If you choose to publish the extension separately, do the following:

    1. Create a new Cloud Platform project and enable the G Suite Marketplace SDK. One of your bundled extensions can optionally reuse the original Cloud Platform project.
    2. For add-on extensions, do the following:
      1. Change the project associated with the script to the new project.
      2. Republish the script. but don't check the Publish in G Suite Marketplace checkbox; leaving it unchecked allows a backend sync to take place.
    3. Wait at least two days. The G Suite Marketplace SDK uses that time to populate its Configuration and Publish screens with information migrated from the Chrome Web Store listing. This process also migrates over your existing user installs and user reviews to the new listing.
    4. Review the values in the Configuration screen and provide any missing information, such as a Terms of Service URL.
    5. Click Save changes.
    6. Review the values in the Publish screen and provide any missing information, such as a Developer's website URL. When finished click Publish.
  3. Unpublish the extension. If you no longer want that extension to be available, you can just unpublish it from the Chrome Web Store. Do this by opening the Chrome Web Store developer dashboard, locating the add-on listing, and clicking Unpublish.

If I do nothing, what will happen?

The Chrome Web Store listings that have a corresponding extension in the G Suite Marketplace are automatically migrated. These G Suite extensions continue to work for existing users. However, the Chrome Web Store listings that do not have a corresponding listing in the G Suite Marketplace aren't migrated. Any users who try to access these extensions may no longer be able to use them or find these listings after August 26, 2019.

If you have additional questions or need assistance, please contact CWS migration support.

FAQ

This section provides answers to some common questions about this migration.

Are Gmail add-ons or Hangout Chat bots affected?

No. All published Gmail add-ons and Hangouts Chat bots already appear in the G Suite Marketplace. You don't need to take action for these applications.

What happens if I don't or can't add a G Suite Marketplace listing to my add-on by that date?

At some point on or after the August 26, 2019 deadline, your add-on listing will be removed from the Chrome Web Store. When that happens, new users will be unable to find or install the add-on. Users that have already installed the add-on can continue using it, but if they ever uninstall the add-on they won't be able to re-install it again.

Is the Chrome Web Store being shut down?

No. The Chrome Web Store is simply not the best place to showcase add-ons, and it is better to have add-on listings in one location so that users and domain administrators can find them more easily.

If my editor add-on is privately published/visible, do I need to migrate?

Yes.

Does migration require my editor add-on to be reviewed again?

By itself, no. However, if you also make updates to your add-on code that change its authorization scopes an additional review may be required when you republish in the G Suite Marketplace.

How does migration to the G Suite Marketplace affect my editor add-on user installs, user ratings, and user reviews?

If the add-on was previously only published in Chrome Web Store, user installs, reviews, comments, and star ratings will be migrated to the new G Suite Marketplace listing. Since user installs are migrated, your existing add-on users can use the add-on without interruption.

For add-ons that were already published to both Chrome Web Store and G Suite Marketplace, installs in both places will be preserved.

What if my editor add-on is currently bundled with another G Suite Marketplace app?

If you bundled your editor add-on with a G Suite Marketplace app, you can either maintain the bundle in the G Suite Marketplace, make a new G Suite Marketplace listing for the editor add-on. See Configure bundled add-ons for details.

What happens to the individual installs of the bundled editor add-on?

The installs associated with each of these Chrome Web Store add-ons continue to be honored with whatever option you take: maintaining the bundle, or creating an individual CWS listing for the add-on, or unpublishing the add-on.

What happens to the installs of the original add-ons bundle in G Suite Marketplace?

The original add-ons bundle can have domain-wide installs done by admins. Admin installs remain in place. The bundled listing continues to appear in G Suite Marketplace and domain admins can still find it and do domain wide installs. On or after August 26, 2019, the Get add-ons and Manage add-ons dialogs opened from the editors (Google Docs, Sheets, Slides, and Forms) will switch from using Chrome Web Store to G Suite Marketplace for showing the add-ons.

At that point, the Chrome Web Store add-ons that you reassociated to new Cloud Platform projects, as well as the bundled listing will appear in the Get Add-ons dialog. Any user that installs this bundled listing installs all of the add-ons included in the bundle. If you rather prefer not to have this bundled listing to show up in the G Suite Marketplace, please contact CWS migration support when this switch-over happens.

Do I need Terms of Service (ToS) for my own add-on?

Yes. Every listing on the G Suite Marketplace requires its own Terms of Service. These are terms you define that govern how users may use your product or service. There are many examples of ToS available online (including templates) that you can customize to your needs. Your terms can vary depending on your product and its functionality, and we cannot provide legal advice on your specific ToS. You should reach out to your legal counsel and determine what's appropriate for your add-on.