diff --git a/_snippets/integrations/builtin/credentials/google/app-becoming-unauthorized.md b/_snippets/integrations/builtin/credentials/google/app-becoming-unauthorized.md new file mode 100644 index 000000000..9933ff721 --- /dev/null +++ b/_snippets/integrations/builtin/credentials/google/app-becoming-unauthorized.md @@ -0,0 +1 @@ +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](https://support.google.com/cloud/answer/10311615?hl=en#zippy=%2Ctesting){:target=_blank .external-link} for more information. To resolve this, reconnect the app in the n8n credentials modal. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/google/oauth-generic.md b/docs/integrations/builtin/credentials/google/oauth-generic.md index e4a7882a7..59281f7c2 100644 --- a/docs/integrations/builtin/credentials/google/oauth-generic.md +++ b/docs/integrations/builtin/credentials/google/oauth-generic.md @@ -11,11 +11,11 @@ This document contains instructions for creating a generic OAuth2 Google credent ## Prerequisites -* [Google Cloud](https://cloud.google.com/){:targe=_blank .external-link} account -* [Google Cloud Platform project](https://developers.google.com/workspace/marketplace/create-gcp-project){:targe=_blank .external-link} +* [Google Cloud](https://cloud.google.com/){:target=_blank .external-link} account +* [Google Cloud Platform project](https://developers.google.com/workspace/marketplace/create-gcp-project){:target=_blank .external-link} * If you haven't used OAuth in your Google Cloud project before, you need to [configure the OAuth consent screen](https://developers.google.com/workspace/guides/configure-oauth-consent){:target=_blank .external-link}. -* If using Google Perspective: [Request API Access](https://developers.perspectiveapi.com/s/docs-get-started){:targe=_blank .external-link} -* If using Google Ads: [Developer Token](https://developers.google.com/google-ads/api/docs/first-call/dev-token){:targe=_blank .external-link} +* If using Google Perspective: [Request API Access](https://developers.perspectiveapi.com/s/docs-get-started){:target=_blank .external-link} +* If using Google Ads: [Developer Token](https://developers.google.com/google-ads/api/docs/first-call/dev-token){:target=_blank .external-link} ## Set up OAuth @@ -49,6 +49,8 @@ This document contains instructions for creating a generic OAuth2 Google credent 5. Select **CREATE**. 6. Enable each Google service API that you want to use: + + 1. If using Google Perspective or Google Ads: [Request API Access for Perspective](https://developers.perspectiveapi.com/s/docs-get-started){:target=_blank .external-link} or a [Developer Token for Ads](https://developers.google.com/google-ads/api/docs/first-call/dev-token){:target=_blank .external-link}. --8<-- "_snippets/integrations/builtin/credentials/google/enable-apis.md" ### Create and test your connection @@ -61,6 +63,8 @@ In n8n: The following video demonstrates the steps described above: +## Video +
@@ -100,3 +104,6 @@ n8n doesn't support all scopes. When creating a generic Google OAuth2 API creden --8<-- "_snippets/integrations/builtin/credentials/google/unverified-app.md" +### Google Cloud app becoming unauthorized + +--8<-- "_snippets/integrations/builtin/credentials/google/app-becoming-unauthorized.md" \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/google/oauth-single-service.md b/docs/integrations/builtin/credentials/google/oauth-single-service.md index 9c45816e7..6cc34ac08 100644 --- a/docs/integrations/builtin/credentials/google/oauth-single-service.md +++ b/docs/integrations/builtin/credentials/google/oauth-single-service.md @@ -19,7 +19,16 @@ This document contains instructions for creating a Google credential for a singl ## Set up OAuth -In Google Cloud: +### Create a new credential in n8n + +1. Follow the steps to [Create a credential](/credentials/add-edit-credentials/). If you create a credential by selecting **Create new** in the credentials dropdown in a node, n8n automatically creates the correct credential type for that node. If you select **Credentials > New**, you must browse for the credential type. To create a credential for a [custom API call](/integrations/custom-operations/), select **Google OAuth2 API**. This allows you to create a generic credential, then set its scopes. +2. Note the **OAuth Redirect URL** from the node credential modal. You'll need this in the next section. + + ??? Details "View screenshot" + ![OAuth Callback URL](/_images/integrations/builtin/credentials/google/oauth_callback.png) + + +### Set up OAuth in Google Cloud 1. Go to [Google Cloud Console | APIs and services](https://console.cloud.google.com/apis/credentials){:target=_blank .external-link} and make sure you're in the project you want to use. @@ -30,7 +39,7 @@ In Google Cloud: ??? Details "View detailed steps" 1. Select **OAuth consent screen**. - 2. For **User Type**, select **Internal**. + 2. For **User Type**, select **Internal** for user access within your organization's Google workspace or **External** for any user with a Google account. 3. Select **Create**. 4. Enter the essential information: **App name**, **User support email**, and the **Email addresses** field in **Developer contact information**. 5. Add an authorized domain: select **+ ADD DOMAIN**. Enter `n8n.cloud` if using n8n's Cloud service, or the domain of your n8n instance if you're self-hosting. @@ -57,9 +66,11 @@ In Google Cloud: 6. Select **CREATE**. 7. Enable each Google service API that you want to use: - 1. If using Google Perspective or Google Ads: [Request API Access for Perspective](https://developers.perspectiveapi.com/s/docs-get-started){:targe=_blank .external-link} or a [Developer Token for Ads](https://developers.google.com/google-ads/api/docs/first-call/dev-token){:targe=_blank .external-link}. + 1. If using Google Perspective or Google Ads: [Request API Access for Perspective](https://developers.perspectiveapi.com/s/docs-get-started){:target=_blank .external-link} or a [Developer Token for Ads](https://developers.google.com/google-ads/api/docs/first-call/dev-token){:target=_blank .external-link}. --8<-- "_snippets/integrations/builtin/credentials/google/enable-apis.md" +### Create and test your connection + In n8n: 1. Enter your new **Client ID** and **Client Secret** from Google Cloud Console in the credentials modal. @@ -72,7 +83,6 @@ In n8n: - ## Troubleshooting ### Google hasn't verified this app @@ -81,5 +91,5 @@ In n8n: ### 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](https://support.google.com/cloud/answer/10311615?hl=en#zippy=%2Ctesting){:target=_blank .external-link} for more information. To resolve this, reconnect the app in the n8n credentials modal. +--8<-- "_snippets/integrations/builtin/credentials/google/app-becoming-unauthorized.md" diff --git a/mkdocs.yml b/mkdocs.yml index a24c4600b..77adf1e39 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,8 +38,6 @@ theme: - navigation.footer # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages - navigation.indexes - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading - - navigation.instant # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path - navigation.path # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections