选择 Google 文档 API 范围

本文档包含 Google 文档 API 专属的授权和身份验证信息。在阅读本文档之前,请务必参阅 了解身份验证和授权,了解 Google Workspace 的一般身份验证和授权信息。

配置 OAuth 2.0 以进行授权

配置 OAuth 权限请求页面并选择范围,以定义向用户和应用审核者显示哪些信息,并注册应用以便以后发布。

Google 文档 API 权限范围

如需定义授予应用的访问权限级别,您需要确定并声明授权范围。授权范围是 OAuth 2.0 URI 字符串,其中包含 Google Workspace 应用名称、它访问的数据类型以及访问权限级别。范围是您的应用请求处理 Google Workspace 数据(包括用户的 Google 账号数据)的请求。

在用户安装您的应用时,系统会要求用户验证该应用使用的范围。通常,您应尽可能选择最窄的范围,并避免请求应用不需要的范围。用户更乐意向描述清晰的有限范围授予访问权限。

我们建议您尽可能使用非敏感镜,因为它会授予文件级访问权限范围,并缩小对应用所需特定功能的访问权限。

Docs API 支持以下范围:

范围代码 说明 用法
https://www.googleapis.com/auth/documents 查看、修改和删除您使用 Google 文档创建的所有文档以及创建这种文档。 敏感内容
https://www.googleapis.com/auth/documents.readonly 查看您使用 Google 文档创建的所有文档。 敏感内容
https://www.googleapis.com/auth/drive.file 仅查看、修改、创建和删除您通过此应用使用的特定 Google 云端硬盘文件。 推荐
不敏感
https://www.googleapis.com/auth/drive 查看、修改、创建和删除您的所有 Google 云端硬盘文件。 受限
https://www.googleapis.com/auth/drive.readonly 查看和下载您的所有 Google 云端硬盘文件。 受限

表格中的“使用情况”列会根据以下定义指示每个镜面的敏感性:

  • 非敏感:这些范围提供的授权访问范围最小,并且只需进行基本应用验证。如需了解此要求,请参阅提交应用以供验证

  • 敏感:这些范围可访问用户为您的应用授权的特定 Google 用户数据。您需要完成额外的应用验证。如需了解此要求,请参阅敏感和受限范围要求

  • 受限:这些范围可提供对 Google 用户数据的广泛访问权限,并且您需要完成受限范围验证流程。如需了解此要求,请参阅 Google API 服务用户数据政策针对特定 API 范围的其他要求。如果您在服务器上存储(或传输)受限范围的数据,则必须接受安全评估。

如果您的应用需要访问任何其他 Google API,您也可以添加这些范围。如需详细了解 Google API 范围,请参阅使用 OAuth 2.0 访问 Google API

如需详细了解特定 OAuth 2.0 范围,请参阅适用于 Google API 的 OAuth 2.0 范围