选择 Google 云端硬盘标签 API 范围

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

配置 OAuth 2.0 以进行授权

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

Google 云端硬盘标签 API 范围

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

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

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

以下 OAuth 2.0 范围可用于读取、搜索和修改已应用的云端硬盘内容标签元数据:

范围 含义
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
读取、搜索和修改应用于云端硬盘内容的标签元数据。
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.metadata.readonly
读取和搜索应用于该应用已获准使用的云端硬盘内容的标签元数据。

如需了解详情,请参阅 Drive API OAuth 2.0 范围Drive API 特定授权

标签的范围

以下 OAuth 范围可用于查看和管理标签:

范围 含义
https://www.googleapis.com/auth/drive.labels 查看、使用和管理云端硬盘标签。
  • 此范围允许用户访问,如果未设置 use_admin_access,则写入操作需要此范围。
  • 此范围的写入操作适用于具有 SHARED 标签类型的标签。
https://www.googleapis.com/auth/drive.labels.readonly 查看和使用云端硬盘标签。
  • 此范围允许用户访问,如果未设置 use_admin_access,则读取操作需要此范围。
https://www.googleapis.com/auth/drive.admin.labels 查看、修改、创建和删除贵组织中的所有云端硬盘标签,并查看贵组织与标签相关的管理政策。
  • 此范围会授予管理员访问权限;在设置 use_admin_access 后,执行写入操作时需要此范围。此范围还会授予读取权限。
  • 此范围的写入操作适用于具有 SHAREDADMIN 标签类型的标签。
https://www.googleapis.com/auth/drive.admin.labels.readonly 查看贵组织中的所有云端硬盘标签和与标签相关的管理政策。
  • 此范围会授予管理员访问权限;设置 use_admin_access 后,执行读取操作需要此范围。

管理员访问权限

如需管理 ADMIN 标签,您必须指定以下各项:

  • useAdminAccesstrue,以使用用户的管理员凭据。
  • 拥有管理标签权限的帐号管理员。

useAdminAccess

管理员必须设置 useAdminAccess 参数才能调用其管理员权限。设置 useAdminAccess 可查看和修改客户拥有的任何标签。这包括 ADMINSHARED 标签。

如果未设置 useAdminAccess,则写入请求只能用于同时具有 SHARED label type 的标签,以及对该标签具有相应 EDITOR 角色的用户。

如需了解详情,请参阅创建访问凭据