Authorization scopes for editor add-ons

Users must authorize add-ons and other applications that access their data or act on their behalf. When a user runs an add-on for the first time, the add-on UI presents an authorization prompt to start the authorization flow.

During this flow, the prompt tells the user what the application wants permission to do. For example, an add-on might want permission to read a user's email message or create events in their calendar. The add-on's script project defines these individual permissions as OAuth scopes.

You declare scopes in your manifest using URL strings. During the authorization flow, Apps Script presents a human-readable description of the scope to the user. For example, your editor add-on might use the "Read current document" scope, which is written in your manifest as https://www.googleapis.com/auth/documents.currentonly. During the authorization flow, an add-on with this scope asks the user to allow the add-on to: View and manage documents that this application has been installed in.

Viewing scopes

You can see the scopes your script project currently requires by doing the following:

  1. Open the script project in the Apps Script editor.
  2. In the menu, select File > Project properties.
  3. Select the Scopes tab.

You can also view the script project's current scopes in the project manifest, under the oauthScopes field, but only if you have set those scopes explicitly.

Setting explicit scopes

Apps Script automatically determines what scopes a script needs by scanning its code for function calls that require them. For most scripts this is sufficient and saves you time, but for published add-ons you should exercise more direct control of the scopes.

For example, Apps Script might give an add-on script project the very permissive scope https://mail.google.com by default. When a user authorizes a script project with this scope, the project is granted full access to the user's Gmail account. For published add-ons, you must replace this scope with a more limited set that cover the add-on's needs and no more.

You can explicitly set the scopes your script project uses by editing its manifest file. The manifest field oauthScopes is an array of all scopes used by the add-on. To set your project's scopes, do the following:

  1. View the scopes your add-on currently uses. Determine what changes need to be made, such as using a narrower scope.
  2. Open your add-on's manifest file.
  3. Locate the top-level field labeled oauthScopes. If it is not present, you can add it.
  4. The oauthScopes field specifies an array of strings. To set the scopes your project uses, replace the contents of this array with the scopes you want it to use. For example, for an editor add-on that extends Sheets you might have the following:

    {
      ...
      "oauthScopes": [
        "https://www.googleapis.com/auth/script.container.ui",
        "https://www.googleapis.com/auth/spreadsheets.currentonly"
      ],
      ...
    }
    

  5. Save the manifest file changes.

OAuth verification

Using certain sensitive OAuth scopes may require that your add-on go through OAuth client verification before you can publish it. For more information, see the following guides:

Restricted scopes

Certain scopes are restricted and subject to additional rules that help protect user data. If you intend to publish a Gmail or editor add-on that uses one or more restricted scopes, the add-on must comply with all the specified restrictions before it can be published.

Review the full list of restricted scopes before you attempt to publish. If your add-on uses any of them, you must comply with the Additional requirements for specific API scopes prior to publishing.

Editor add-on scopes

When you build an editor add-on, the required scopes are determined by the Apps Script service and methods the add-on code uses. For example, a Sheets add-on might need the https://www.googleapis.com/auth/spreadsheets.readonly scope in order to read information from different Google Sheets.

Apps Script automatically determines the scopes required by the services you use as you add code to your script project. For editor add-ons, you can often just rely on this automatic scope collection instead of determining the scopes yourself and setting them explicitly.

If you are not setting your scopes explicitly and your editor add-on only ever reads or writes to the open editor file, add the following comment to one of your script project files:

  /**
   * @OnlyCurrentDoc
   */

This comment tells Apps Script to narrow the editor file scopes it sets to currentonly. For example, if you add this comment to a Sheets add-on script project file, you are specifying that the add-on only needs permission to operate on the currently open Sheet, and not any other Sheets the user might have in Google Drive. Conversely, you shouldn't use this comment if your Sheets add-on needs to read or write data in a Sheet the user currently hasn't opened.