Gmail 身份验证

使用 OAuth 2.0 授权代码、您自己的 OAuth 2.0 应用程序或服务帐户将 UiPath 连接到 Gmail。

先决条件

根据您选择的身份验证类型，您可能需要以下凭据之一：

• OAuth 2.0 授权代码：您的 Google 电子邮件地址以及与您 Google 帐户关联的密码。
• 自带 OAuth 2.0 应用程序: 应用程序的客户端 ID 和客户端密码，以及作用域。
• 服务帐户：“服务帐户密钥”、“帐户电子邮件”。

如果 Google 未启用您的帐户：

• 请您的管理员批准创建连接。
• 通过选中允许创建连接的可用选项来启用权限。

备注：

有关不同身份验证类型的更多详细信息，请参阅如何连接到 Google Workspace 365 活动指南。

有关 Gmail 的更多信息，请访问Gmail 文档网站。

作用域

连接器请求以下权限/作用域：

• UiPath 公共应用程序默认作用域： openid 、 https://www.googleapis.com/auth/userinfo.email 、 https://www.googleapis.com/auth/userinfo.profile 、 https://mail.google.com/ 、 https://www.googleapis.com/auth/calendar和https://www.googleapis.com/auth/gmail.settings.basic 。
• Google 服务帐户默认作用域： openid 、 https://www.googleapis.com/auth/userinfo.email 、 https://www.googleapis.com/auth/userinfo.profile 、 https://mail.google.com/ 、 https://www.googleapis.com/auth/calendar和https://www.googleapis.com/auth/gmail.settings.basic 。
• 自带 OAuth 2.0 应用程序:
  • 必需作用域： openid 、 https://www.googleapis.com/auth/userinfo.email 、 https://mail.google.com/
  • 创建连接的最小作用域： openid和https://www.googleapis.com/auth/gmail.readonly 。
  • Gmail 触发器所需的最小作用域列表:
    • openid 、 https://www.googleapis.com/auth/gmail.readonly – 适用于邮箱事件。
    • openid 、 https://www.googleapis.com/auth/calendar.readonly – 适用于日历上的事件。

备注：

如果您使用“自带 OAuth 2.0 应用程序”进行身份验证，则默认情况下，您可以受益于创建应用程序时配置的作用域。如果要使用默认的应用程序权限，可以声明common作用域。这意味着您只能使用为该应用程序配置的权限。您还可以在创建连接时使用“作用域”字段声明其他作用域。然后，系统在登录期间会要求您授予其他同意。

连接可允许 UiPath 产品代表您与 Gmail 数据交互。这可能包括读取、写入、修改和删除数据，具体取决于您的 Gmail 权限。您始终可以删除Google 帐户中的任何访问权限。

设置 Google Cloud 项目

备注：

仅当您使用“自带 OAuth 2.0 应用程序”身份验证类型时，本部分才适用。如果您使用OAuth 2.0 授权代码，请跳至“添加 Gmail 连接” 。

在使用自带 OAuth 2.0 应用程序创建连接之前，请配置一个 Google Cloud 项目，以授权与 Gmail 进行 OAuth 通信。

1. 转到Google Cloud 控制台并创建一个项目，或选择现有项目。填写基本项目详细信息，然后选择保存并继续。
2. 在导航菜单中，选择“API 和服务” ，然后选择“库” 。
3. 搜索“Gmail API” ，然后选择“启用” 。
4. 选择“凭据” ，然后选择“+创建凭据” ，然后选择“OAuth 客户端 ID” 。
5. 在“应用程序类型”下，选择“网页应用程序” ，然后输入名称。
6. 在“授权重定向 URI”下，添加https://{baseURL}/provisioning_/callback ，然后选择“创建” 。
7. 将“客户端 ID”和“客户端密码”保存在安全的位置。
8. 选择OAuth 同意屏幕并配置应用程序设置。应用程序是内部应用程序还是外部应用程序取决于您组织的安全策略。
9. 选择“编辑应用程序” ，转到“作用域”部分，然后选择“添加或删除作用域” 。
10. 搜索邮件并选择适当的 Gmail API 作用域。有关最低要求，请参阅“作用域”部分。如果您为其他 API 添加作用域（例如 Google 云端硬盘），请确保它们符合公司的政策。
11. 保存更改。如果您的应用程序是外部应用程序，则在返回到项目仪表板之前，您可以选择在测试用户步骤中添加测试用户。

在 Integration Service 中创建 Gmail 连接时，您的客户端 ID 和客户端密码现在可以使用。

备注：

要在组织级别管理 API 访问限制或 Apps 权限，请参阅Google 的第三方和自定义 Apps 文档。

添加 Gmail 连接

1. 从产品启动器中选择“Orchestrator”。

2. 选择一个文件夹，然后导航到“连接”选项卡。

3. 选择“添加连接”。

4. 要打开连接创建页面，请从列表中选择连接器。您可以使用搜索栏查找连接器。

5. 选择您的首选身份验证类型。

   如果您选择“自带 OAuth 2.0 应用程序” ，请选择齿轮图标，然后选择“自带 OAuth 2.0 应用程序” ，并提供 Google Cloud 项目设置中的客户端 ID 和客户端密码。还必须提供计划使用的活动所需的作用域。查看每个活动的文档，了解它需要的作用域。

6. 输入所需的凭据，然后选择“连接” 。

   在可用的情况下，选择字段旁边的菜单，然后选择“使用凭据资产”或“使用 Orchestrator 资产”以引用 Orchestrator 资产，而不是直接输入值。有关更多信息，请参阅使用凭据资产进行连接。

在 Studio 桌面版中使用连接

在 Integration Service 中创建 Gmail 连接后，请配置 Studio 或 StudioX 自动化以使用该连接。

1. 在 Studio 中，打开管理包，然后安装Google Workspace包。

2. 在自动化中，您可以通过选择“已安装” ，然后选择“集成”、 “Google” 、 “Workspace” ，然后选择“Gmail”来添加 Gmail 活动。

   备注：

   使用“集成”部分中的 Gmail 活动，而不是旧版“使用 Gmail”活动。旧版活动不支持 Integration Service 连接，并且仅限于单个硬编码用户帐户。

3. 在每个活动的属性中，选择您在 Integration Service 中创建的 Gmail 连接。

如果并非在您的 Google Cloud 项目中启用了所有 Gmail 作用域，则某些活动可能会失败。请查看每个活动的文档，了解其所需的作用域。

自带 OAuth 2.0 应用程序

在 Integration Service 中，当创建与某个基于 Google API 的连接器的连接时，您可以在两个身份验证选项之间进行选择：

• OAuth 2.0 授权代码– 连接到 UiPath 公共应用程序。
• 自带 OAuth 2.0 应用程序– 连接到您创建的私有 Google Cloud 应用程序。

配置作用域

使用自带的 OAuth 2.0 应用程序创建连接时，您可以选择自定义应用程序作用域。

OAuth 应用程序的刷新令牌

Google 对单个 OAuth 2.0 客户端 ID 具有刷新令牌限制。如果达到限制，则创建新的刷新令牌会自动使最旧的刷新令牌失效，而不会发出警告。此限制不适用于服务帐户（请参阅将 OAuth 2.0 用于服务器到服务器应用程序）。如需了解详情，请参阅 Google 官方文档。

可能导致令牌过期的原因列表：

• 您已撤销应用程序的访问权限。
• 刷新令牌已六个月未使用。
• 您需要更改密码，并且刷新令牌包含 Gmail 作用域。
• 您的帐户已超过授予的 (实时) 刷新令牌的最大数量。
  • 如果您在超出限制后请求新令牌，则基于先前授予的令牌的旧连接将过期。 只有新连接或最新编辑/重新进行身份验证的连接（使用最新的令牌）才能正常工作。
• 管理员已将您应用程序作用域内请求的任何服务设置为“受限” （错误为admin_policy_enforced ）。
• 对于Google Cloud Platform API ：可能已超过管理员设置的会话时长。

备注：

当前限制为每个 Google 帐户每个 OAuth 2.0 客户端 ID 使用 100 个刷新令牌。此数字可能会发生变化。有关最新信息，请随时查看 Google 文档。

一个用户帐户或服务帐户可以在所有客户端上拥有的刷新令牌总数有一个更大的限制。 普通用户不会超过此限制，但用于测试实施的开发者帐户可能会超过此限制。

为确保不超过此限制，UiPath 允许用户创建自己的 OAuth 应用程序并使用自带应用程序身份验证类型进行连接。创建 OAuth 应用程序时，请务必遵循 Google 的最佳实践。有关如何创建 OAuth 应用程序的详细信息，请参阅 Google 官方文档。

备注：

令牌失效会导致连接失败，并且在不修复连接的情况下，自动化将无法运行。