授权范围

用户必须授权访问数据或代表自己的脚本项目。当用户首次运行需要授权的脚本时,界面会显示启动授权流程的提示。

在此流程中,界面会告知用户脚本想要获得权限执行什么操作。例如,脚本可能需要权限来读取用户的电子邮件或在日历中创建事件。脚本项目将这些单独的权限定义为 OAuth 范围

对于大多数脚本,Apps 脚本会自动检测您需要哪些范围;您可以随时查看脚本使用的范围。您还可以使用网址字符串在清单明确设置范围。对于某些应用(如插件),有时需要明确设置范围,因为已发布的应用应始终使用尽可能窄的范围。

在授权流程中,Apps 脚本会向用户显示可读范围的必要说明。例如,如果您的脚本需要对您的电子表格具有只读权限,则清单的作用域可能为 https://www.googleapis.com/auth/spreadsheets.readonly。在授权流程中,具有此范围的脚本会要求用户允许此应用“查看您的 Google 电子表格”。

某些范围包含其他范围。例如,授权后,范围 https://www.googleapis.com/auth/spreadsheets 允许对电子表格进行读取和写入。

查看范围

您可以通过执行以下操作来查看脚本项目当前所需的范围:

  1. 打开脚本项目。
  2. 点击左侧的概览
  3. 查看项目 OAuth 范围下的范围。

设置显式范围

Apps 脚本会扫描其代码以查找需要作用域的代码调用,从而自动确定脚本需要的范围。对于大多数脚本来说,这就足够了,这还可以为您节省时间;但对于已发布的插件和 Web 应用,您必须更直接地控制范围。

Apps 脚本有时会自动为项目分配非常宽松的范围。这可能意味着您的脚本向用户请求超出其需求的权限,这是一种不好的做法。对于已发布的脚本,您必须将宽泛的范围替换为一组更有限的脚本,以满足脚本的需求。

您可以通过修改脚本项目的 manifest 文件来明确设置其使用的范围。清单字段 oauthScopes 是项目使用的所有范围的数组。如需设置项目的范围,请执行以下操作:

  1. 打开脚本项目。
  2. 点击左侧的 Project Settings 图标
  3. 选中在编辑器中显示“appsscript.json”清单文件复选框。
  4. 点击左侧的编辑器
  5. 点击左侧的 appsscript.json 文件。
  6. 找到标记为 oauthScopes 的顶级字段。如果不存在,您可以自行添加。
  7. oauthScopes 字段指定字符串数组。如需设置项目使用的范围,请将此数组的内容替换为您希望其使用的范围。例如:
          {
            ...
            "oauthScopes": [
              "https://www.googleapis.com/auth/spreadsheets.readonly",
              "https://www.googleapis.com/auth/userinfo.email"
            ],
           ...
          }
    
  8. 点击顶部的“保存”图标

OAuth 验证

某些 OAuth 范围属于敏感信息,因为它们允许访问 Google 用户数据。如果您的脚本项目使用了允许访问用户数据的范围,则该项目必须通过 OAuth 客户端验证,然后才能作为 Web 应用或插件公开发布。如需了解详情,请参阅以下指南:

受限范围

除了敏感范围之外,特定范围被归类为受限,并受有助于保护用户数据的其他规则约束。如果您打算发布使用一个或多个受限范围的 Web 应用或插件,应用必须遵守所有指定的限制,然后才能发布。

在尝试发布之前,请查看受限范围的完整列表。如果您的应用使用了其中的任何一种机制,您都必须符合特定 API 范围的附加要求,然后才能进行发布。