Alternate Runtimes for G Suite Add-ons is coming soon. Learn more.

Manifests for editor add-ons

An Apps Script project uses a manifest file to configure certain details about the script and its operation. A manifest is a special JSON-formatted file that is hidden in your script project by default; in most cases, Apps Script automatically adjusts the manifest in response to actions you take in the Apps Script editor. For example, if you add a library to a script project, the relevant details of that library are added to the manifest behind the scenes for you. See Manifest structure for a list of properties an Apps Script project can define in its manifest.

Sometimes it is helpful or necessary to edit a manifest directly. For example, if you intend to publish an add-on you must configure your add-on's manifest to always use the narrowest scopes possible. See Setting explicit scopes for more details.

This documentation covers the details of configuring a manifest for a editor add-on.

Editing a manifest

The Apps Script editor hides manifest files by default in order to protect your Apps Script project settings. Follow these steps to make a hidden project manifest visible in the Apps Script editor:

  1. Open the script project in the Apps Script editor.
  2. Select View > Show project manifest.

The manifest file appears as a project file named appsscript.json. You can edit this file directly in the editor and save any changes you make. To hide the manifest file after you are finished, select View > Show project manifest again.

Manifest structure for editor add-ons

The Apps Script manifest structure doesn't include any properties that are specific to editor add-ons. However, editor add-on manifests can define the general properties that are common to all Apps Script projects, such as OAuth scopes and library dependencies.

See Manifest structure for a full list of potential manifest properties that editor add-ons can use.