选择 Google 文档 API 范围

本文档包含 Google 文档 API 特定的授权和身份验证信息。在阅读本文档之前,请务必阅读了解身份验证和授权中的 Google Workspace 常规身份验证和授权信息。

配置 OAuth 2.0 以进行授权

配置 OAuth 同意屏幕并选择范围,以定义向用户显示的信息和应用审核者,并注册您的应用,以便日后发布。

Google 文档 API 范围

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

安装应用时,系统会要求用户验证应用使用的范围。通常,您应尽可能选择范围最窄的范围,并避免请求应用不需要的范围。用户更容易授予对明确说明的有限范围的访问权限。

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

Google 文档 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 范围