Admins of a Google Apps 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 Google Apps 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 Google Apps domain.
Before you publish
- In the script editor, select Resources > Advanced Google Services, then click the link for the Google Developers Console at the bottom of the dialog.
- You may be prompted to accept the Google APIs Terms of Service and the Google Apps Marketplace SDK Terms of Service. Read the terms carefully, then check the box and click Accept.
- In the console, type "marketplace" into the filter box, then click Google Apps Marketplace SDK (not the API) once you see it.
- On the next screen, click Enable API.
- Once the Apps Marketplace SDK has been enabled, click the Configuration tab.
-
Fill out the
configuration form
for the Google Apps Marketplace SDK.
- Add an application description, which is shown in the Google Apps Marketplace admin screen after installing the add-on.
- Upload four images in the different icon fields (note: only administrators will see these icons, and the image will be 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.)
- Click Save changes. If there are no error messages, close the Google Apps Marketplace SDK configuration form.
While publishing
Follow the normal instructions for publishing an add-on, but after you click Publish > Deploy as Docs Add-on, check the box next to Publish in Google Apps Marketplace. If you had previously published your add-on, you will need to republish before it will appear 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 Google Apps Marketplace app
If you have already developed and published a Google Apps Marketplace app that is closely related to your add-on, you can bundle your add-on with the Marketplace app. This will create a joint listing in the Apps Marketplace. When administrators install your app, the add-on will be installed and authorized at the same time.
Before you publish
- Follow these instructions to associate the add-on with the Marketplace app's Developers Console project.
- Next, you will need to update the Google Apps Marketplace listing for the existing app to include information about the add-on, following the instructions further above on this page. Since you will already have a Marketplace listing for your existing app, you will edit the listing instead of creating a new one.
- In the Marketplace listing, make sure that the description explains that installing this app will also install an add-on for Docs, Sheets, or Forms.
- 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 will need to reauthorize it.
- 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.)
- Click Save changes. If there are no error messages, close the Google Apps Marketplace SDK configuration form.
While publishing
Follow the normal instructions for publishing an add-on. Do not check the box next to Publish in Google Apps Marketplace.
Installing a domain-wide add-on
Admins of a Google Apps 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.