Publishing Add-ons for Domain-Wide Installation

Admins of a G Suite domain can install and authorize a Docs, Sheets, or Forms add-on for all users in the domain if the add-on is published to the G Suite Marketplace using the instructions below. These steps are in addition to normal add-on publication.

Publishing for domain-wide installation

It takes a few extra steps to publish an add-on so that administrators can pre-install it for all users in their G Suite domain.

Publishing an add-on for domain-wide install requires you to enable and configure the G Suite Marketplace SDK. In order to this, you must have access to the Cloud Platform project the add-on uses, which may not be the case if the script resides in Team Drive. If necessary you can switch your script to use a standard Cloud Platform project that you can access.

Before you publish

  1. In the script editor, select Resources > Cloud Platform project...
  2. Click the blue link at the top of the resulting dialog to open the project in the API Console. If there is no link, it's because you don't have access to the Cloud Platform project because it resides in a Team Drive. You can't proceed with publishing without access to the script Cloud Platform project. You can switch your script to use a standard Cloud Platform project that you can access.
  3. You may be prompted to accept the Google APIs Terms of Service and the G Suite Marketplace SDK Terms of Service. Read the terms carefully, then check the box and click Accept.
  4. In the console, type "marketplace" into the filter box, then click G Suite Marketplace SDK (not the API) once you see it.
  5. On the next screen, click Enable API.
  6. Once the G Suite Marketplace SDK has been enabled, click the Configuration tab.
  7. Fill out the configuration form for the G Suite Marketplace SDK.
    • Add an application description, which is shown in the G Suite Marketplace admin screen after installing the add-on.
    • Upload four images in the different icon fields (note: only administrators see these icons, and the image is resized if the dimensions are incorrect).
    • Add a Terms of Service URL, which is shown in the administrator's authorization dialog.
    • Add a list of all the OAuth 2.0 Scopes that your add-on asks the user to grant. To determine these scopes, return to the script editor and click File > Project properties, then click the Scopes tab within the project properties dialog.
    • Check the box next to Enable Docs Add-on extension, Enable Sheets Add-on extension, or Enable Forms Add-on extension, as appropriate.
    • Add the Apps Script Project Key for your add-on. (To find this key, return to the script editor and select File > Project properties, then copy the Project key.)
  8. Click Save changes. If there are no error messages, close the G Suite Marketplace SDK configuration form.

While publishing

Follow the normal instructions for publishing an add-on, but after you click Publish > Deploy as web add-on, check the box next to Publish in G Suite Marketplace. If you had previously published your add-on, you need to republish before it appears in the Marketplace.

Note that there is sometimes a delay when publishing or republishing an add-on, but usually less than an hour.

Bundling with an existing G Suite Marketplace app

If you have already developed and published a G Suite Marketplace app that is closely related to your add-on, you can bundle your add-on with the Marketplace app. This creates a joint listing in the G Suite Marketplace. When administrators install your app, the add-on is installed and authorized at the same time.

Bundling requires you to have access to the Marketplace app's Cloud Platform project so that you can make adjustments to its settings.

Before you publish

  1. Follow these instructions to associate the add-on with the Marketplace app's Cloud Platform project.
  2. Next, you need to update the G Suite Marketplace listing for the existing app to include information about the add-on, following the instructions further above on this page. Since you already have a Marketplace listing for your existing app, you edit the listing instead of creating a new one.
  3. In the Marketplace listing, make sure that the description explains that installing this app also installs an add-on for Docs, Sheets, or Forms.
  4. Make sure that the OAuth scopes section lists all scopes required by the Marketplace app and the add-on. If you need to add any scopes to support the add-on, remember that admins who have previously installed the Marketplace app need to reauthorize it.
  5. Check the box next to Enable Docs Add-on extension, Enable Sheets Add-on extension, or Enable Forms Add-on extension, as appropriate.
  6. Add the Apps Script Project Key for your add-on. (To find this key, return to the script editor and select File > Project properties, then copy the Project key.)
  7. Click Save changes. If there are no error messages, close the G Suite Marketplace SDK configuration form.

While publishing

Follow the normal instructions for publishing an add-on. Do not check the box next to Publish in G Suite Marketplace.

Installing a domain-wide add-on

Admins of a G Suite domain can install an add-on that they or another developer have published for domain-wide use by following the instructions in this support article.

If you are the add-on's developer and you just published it, note that it may take up to an hour before the add-on appears in the Marketplace.

发送以下问题的反馈:

此网页
Apps Script
Apps Script