Skip to content

Google：OAuth2 通用(Google: OAuth2 generic)#

本文件包含用于创建通用 OAuth2 Google 凭证以供 自定义操作 使用的说明。

🌐 This document contains instructions for creating a generic OAuth2 Google credential for use with custom operations.

Note for n8n Cloud users

For the following nodes, you can authenticate by selecting Sign in with Google in the OAuth section:

先决条件(Prerequisites)#

设置 OAuth(Set up OAuth)#

将 n8n 凭据连接到 Google 服务共有五个步骤：

🌐 There are five steps to connecting your n8n credential to Google services:

  1. 创建一个 Google Cloud 控制台项目。
  2. 启用 API。
  3. 配置您的 OAuth 同意屏幕。
  4. 创建您的 Google OAuth 客户端凭据。
  5. 完成你的 n8n 凭证。

创建 Google Cloud Console 项目(Create a Google Cloud Console project)#

首先，创建一个 Google Cloud 控制台项目。如果你已经有项目，可以跳到下一部分：

🌐 First, create a Google Cloud Console project. If you already have a project, jump to the next section:

  1. Log in to your Google Cloud Console using your Google credentials.
  2. In the top menu, select the project dropdown in the top navigation and select New project or go directly to the New Project page.
  3. Enter a Project name and select the Location for your project.
  4. Select Create.

  5. Check the top navigation and make sure the project dropdown has your project selected. If not, select the project you just created.

    The project dropdown in the Google Cloud top navigation
    Check the project dropdown in the Google Cloud top navigation

启用 API(Enable APIs)#

创建项目后，启用你需要访问的 API：

🌐 With your project created, enable the APIs you'll need access to:

  1. Access your Google Cloud Console - Library. Make sure you're in the correct project.
    The project dropdown in the Google Cloud top navigation
    Check the project dropdown in the Google Cloud top navigation
  2. Go to APIs & Services > Library.
  3. Search for and select the API(s) you want to enable. For example, for the Gmail node, search for and enable the Gmail API.

  4. Some integrations require other APIs or require you to request access:

    Google Drive API required

    The following integrations require the Google Drive API, as well as their own API:

    • Google Docs
    • Google Sheets
    • Google Slides

    Google Vertex AI API

    In addition to the Vertex AI API you will also need to enable the Cloud Resource Manager API.

  5. Select ENABLE.

如果你以前没有在谷歌云项目中使用过 OAuth，你需要配置 OAuth 同意屏幕：

🌐 If you haven't used OAuth in your Google Cloud project before, you'll need to configure the OAuth consent screen:

  1. 访问你的 Google Cloud 控制台 - 库。确保你在正确的项目中。
    Google Cloud 顶部导航中的项目下拉菜单
    检查 Google Cloud 顶部导航中的项目下拉菜单
  2. 打开左侧导航菜单，进入 APIs 与服务 > OAuth 同意屏幕。Google 会将你重定向到 Google 认证平台概览页面。
  3. 在 概览 选项卡上选择 开始使用 以开始配置 OAuth 同意。
  4. 输入 应用名称 和 用户支持邮箱 以显示在 OAuth 屏幕上。选择 下一步 继续。
  5. 对于受众，选择内部以便组织内 Google Workspace 用户访问，或选择外部以便任何拥有 Google 账户的用户访问。有关用户类型的更多信息，请参阅 Google 的用户类型文档。选择下一步以继续。
  6. 选择 Google 用于联系你有关项目更改的电子邮件地址。选择下一步继续。
  7. 阅读并接受谷歌的用户数据政策。选择 继续，然后选择 创建。
  8. 在左侧菜单中，选择 品牌。
  9. 在 授权域 部分，选择 添加域：
    • 如果你正在使用 n8n 的云服务，请添加 n8n.cloud
    • 如果你是自托管，请添加你的 n8n 实例的域名。
  10. 在页面底部选择 保存。

创建你的 Google OAuth 客户端凭据(Create your Google OAuth client credentials)#

接下来，在 Google 中创建 OAuth 客户端凭据：

🌐 Next, create the OAuth client credentials in Google:

  1. 访问你的Google Cloud 控制台。确保你处于正确的项目中。
  2. 在 APIs 和服务 部分，选择 凭据。
  3. 选择 + 创建凭据 > OAuth 客户端 ID。
  4. 在 应用类型 下拉菜单中，选择 Web 应用。
  5. Google 会自动生成一个名称。请将名称更新为你在控制台中能认出的名称。
  6. 从你的 n8n 凭证中，复制 OAuth 重定向 URL。将其粘贴到 Google 控制台的 授权重定向 URI 中。
  7. 选择 创建。

完成 n8n 凭据(Finish your n8n credential)#

完成 Google 项目和凭据配置后，完成 n8n 凭据配置：

🌐 With the Google project and credentials fully configured, finish the n8n credential:

  1. 在 Google 的 OAuth 客户端创建 弹窗中，复制 客户端 ID。将其输入到你的 n8n 凭证中。
  2. 从相同的 Google 模态中，复制 客户端密钥。在你的 n8n 凭证中输入此信息。

  3. 您必须为此凭证提供作用域。有关更多信息，请参阅 Scopes。请输入多个作用域，并以空格分隔，例如：

    1
    https://www.googleapis.com/auth/gmail.labels https://www.googleapis.com/auth/gmail.addons.current.action.compose

  4. 在 n8n 中，选择 使用 Google 登录 来完成你的 Google 身份验证。

  5. 保存你的新凭据。

视频(Video)#

以下视频演示了上述步骤：

🌐 The following video demonstrates the steps described above:

作用域(Scopes)#

谷歌服务可能有一个或多个访问范围。范围限制了用户可以执行的操作。有关所有服务范围的列表，请参阅 Google API 的 OAuth 2.0 范围。

🌐 Google services have one or more possible access scopes. A scope limits what a user can do. Refer to OAuth 2.0 Scopes for Google APIs for a list of scopes for all services.

n8n 并不支持所有的权限范围。在创建通用的 Google OAuth2 API 凭证时，你可以从下面的 支持的权限范围 列表中输入权限范围。如果你输入 n8n 尚未支持的权限范围，它将无法工作。

🌐 n8n doesn't support all scopes. When creating a generic Google OAuth2 API credential, you can enter scopes from the Supported scopes list below. If you enter a scope that n8n doesn't already support, it won't work.

Supported scopes
Service Available scopes
Gmail
  • https://www.googleapis.com/auth/gmail.labels
  • https://www.googleapis.com/auth/gmail.addons.current.action.compose
  • https://www.googleapis.com/auth/gmail.addons.current.message.action
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.compose
Google Ads
  • https://www.googleapis.com/auth/adwords
Google Analytics
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/analytics.readonly
Google BigQuery
  • https://www.googleapis.com/auth/bigquery
Google Books
  • https://www.googleapis.com/auth/books
Google Calendar
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.events
Google Cloud
Natural Language
  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform
Google Cloud
Storage
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write
Google Contacts
  • https://www.googleapis.com/auth/contacts
Google Docs
  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
Google Drive
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.photos.readonly
Google Firebase
Cloud Firestore
  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/firebase
Google Firebase
Realtime Database
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/firebase.database
  • https://www.googleapis.com/auth/firebase
Google Perspective
  • https://www.googleapis.com/auth/userinfo.email
Google Sheets
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
Google Slide
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/presentations
Google Tasks
  • https://www.googleapis.com/auth/tasks
Google Translate
  • https://www.googleapis.com/auth/cloud-translation
GSuite Admin
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.domain.readonly
  • https://www.googleapis.com/auth/admin.directory.userschema.readonly

故障排除(Troubleshooting)#

Google 尚未验证此信息应用(Google hasn't verified this app)#

If using the OAuth authentication method, you might see the warning Google hasn't verified this app. To avoid this:

  • If your app User Type is Internal, create OAuth credentials from the same account you want to authenticate.
  • If your app User Type is External, you can add your email to the list of testers for the app: go to the Audience page and add the email you're signing in with to the list of Test users.

If you need to use credentials generated by another account (by a developer or another third party), follow the instructions in Google Cloud documentation | Authorization errors: Google hasn't verified this app.

Google Cloud 应用未授权(Google Cloud app becoming unauthorized)#

For Google Cloud apps with Publishing status set to Testing and User type set to External, consent and tokens expire after seven days. Refer to Google Cloud Platform Console Help | Setting up your OAuth consent screen for more information. To resolve this, reconnect the app in the n8n credentials modal.