本文档包含针对 Gmail API 的授权和 身份验证信息。在阅读本文档之前,请务必阅读 Google Workspace 的常规身份验证和授权信息,请访问 了解身份验证和授权。
配置 OAuth 2.0 以进行授权
配置 OAuth 权限请求页面并选择范围 指定向用户显示哪些信息,以及注册 以便日后发布
Gmail API 范围
要定义向您的应用授予的访问权限级别,您需要确定并 声明授权范围。授权范围是 OAuth 2.0 URI 字符串 包含 Google Workspace 应用名称、应用访问的数据类型,以及 访问权限级别范围是您的应用为处理 Google Workspace 数据而发出的请求,包括 用户的Google 账号数据。
安装应用时,系统会要求用户验证使用的范围 。通常,您应选择范围最狭窄的范围 尽可能避免请求您的应用不需要的范围。用户数更多 随时向有限且明确说明的范围授予访问权限。
Gmail API 支持以下范围:
范围代码 | 说明 | 用法 |
---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
在您与以下人员互动时管理草稿和发送电子邮件 插件。 | 不敏感 |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
当您与 插件。 | 不敏感 |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
使用该插件时,查看您的电子邮件元数据 正在运行。 | 敏感内容 |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
在该插件处于以下状态时查看您的电子邮件 。 | 敏感内容 |
https://www.googleapis.com/auth/gmail.labels |
只能创建、读取、更新和删除标签。 | 不敏感 |
https://www.googleapis.com/auth/gmail.send |
仅发送消息。没有读取或修改邮箱的权限。 | 敏感内容 |
https://www.googleapis.com/auth/gmail.readonly |
读取所有资源及其元数据 - 无写入操作。 | 受限 |
https://www.googleapis.com/auth/gmail.compose |
创建、读取、更新和删除草稿。发送邮件和草稿。 | 受限 |
https://www.googleapis.com/auth/gmail.insert |
只能插入和导入邮件。 | 受限 |
https://www.googleapis.com/auth/gmail.modify |
除直接、永久删除以下项之外的所有读/写操作 会话和邮件,绕过“已删除邮件” | 受限 |
https://www.googleapis.com/auth/gmail.metadata |
读取资源元数据,包括标签、历史记录和电子邮件 而不是邮件正文或附件。 | 受限 |
https://www.googleapis.com/auth/gmail.settings.basic |
管理基本邮件设置。 | 受限 |
https://www.googleapis.com/auth/gmail.settings.sharing |
管理敏感邮件设置,包括转发规则和别名。
注意:受此范围保护的操作仅限于 仅限管理使用。这些功能仅适用于 Google Workspace 客户 使用启用了全网域委派功能的服务账号。 |
受限 |
https://mail.google.com/ |
拥有对该账号邮箱的完全访问权限,包括永久删除 线程和消息。只有在您的应用 需要立即永久删除会话和邮件, 回收站;所有其他操作均可在较宽松的作用域内执行。 | 受限 |
上表中的“用量”列指明了每个范围的敏感度 。
非敏感 - 这些范围提供的是最小范围 只需进行基本的应用验证即可。相关信息 请参阅 验证准备工作的步骤。
敏感 - 这些范围允许访问 Google 用户数据,并且需要 敏感范围验证流程有关此要求的信息,请参阅 Google API 服务:用户数据政策。 这些范围不需要进行安全评估。
受限 - 在这些范围中,用户可以广泛访问 Google 用户数据和 要求您完成受限范围内的验证流程。对于 请参阅 Google API 服务:用户数据政策和 针对特定 API 范围的其他要求。 如果您将受限范围的数据存储在服务器上(或传输),则需要 进行安全评估
规范您在您使用和访问 Gmail API 时 访问用户数据的请求可在 Gmail API 服务用户数据和开发者政策。
如果您的应用需要访问任何其他 Google API,您可以将 这些作用域。有关 Google API 作用域的详细信息 请参阅 使用 OAuth 2.0 访问 Google API。
OAuth 验证
如果使用某些敏感的 OAuth 范围,您的应用可能需要通过 Google 的 OAuth 验证流程。 阅读 OAuth 验证常见问题解答 来确定您的应用应在何时进行验证, 需要验证。另请参阅 Google API 服务:用户数据政策。