From 5dcaf6a00c8159d01af325746b8332b93ae38a4e Mon Sep 17 00:00:00 2001 From: Patrick Nilan Date: Wed, 15 Nov 2023 13:48:16 -0800 Subject: [PATCH] Docs: Updates Google Search Console Source Connector Docs (Removes inapp page, adds , adds Limitations & Troubleshooting) (#32361) --- .../sources/google-search-console.inapp.md | 28 -------- .../sources/google-search-console.md | 64 +++++++++++++------ 2 files changed, 44 insertions(+), 48 deletions(-) delete mode 100644 docs/integrations/sources/google-search-console.inapp.md diff --git a/docs/integrations/sources/google-search-console.inapp.md b/docs/integrations/sources/google-search-console.inapp.md deleted file mode 100644 index 2224bd12ac60..000000000000 --- a/docs/integrations/sources/google-search-console.inapp.md +++ /dev/null @@ -1,28 +0,0 @@ -## Prerequisite - -- A verified property in Google Search Console - -- Google Search Console API enabled for your project (**Airbyte Open Source** only) - - -## Setup guide - -1. For **Source name**, enter a name to help you identify this source. -2. For **Website URL Property**, enter the specific website property in Google Seach Console with data you want to replicate. -3. For **Start Date**, by default the `2021-01-01` is set, use the provided datepicker or enter a date in the format `YYYY-MM-DD`. Any data created on or after this date will be replicated. -4. To authenticate the connection: - - - - **For Airbyte Cloud**: Select **Oauth** from the Authentication dropdown, then click **Sign in with Google** to authorize your account. More information on authentication methods can be found in our [full Google Search Console documentation](https://docs.airbyte.io/integrations/sources/google-search-console#setup-guide). - - - - (Recommended) To authenticate with a service account, select **Service Account Key Authorization** from the Authentication dropdown, then enter the **Admin Email** and **Service Account JSON Key**. For the key, copy and paste the JSON key you obtained during the service account setup. It should begin with `{"type": "service account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ...}`. - - To authenticate with OAuth, select **Oauth** from the Authentication dropdown, then enter your **Client ID**, **Client Secret**, **Access Token** and **Refresh Token**. More information on authentication methods for Airbyte Open Source can be found in our [full Google Search Console documentation](https://docs.airbyte.io/integrations/sources/google-search-console#setup-guide). - - -5. (Optional) For **End Date**, you may optionally provide a date in the format `YYYY-MM-DD`. Any data created between the defined Start Date and End Date will be replicated. Leaving this field blank will replicate all data created on or after the Start Date to the present. -6. (Optional) For **Custom Reports**, you may optionally provide a custom report representing any additional report you wish to query the API with. Refer to the [Custom reports](https://docs.airbyte.com/integrations/sources/google-search-console#custom-reports) section in our full documentation for more information on formulating these reports. -7. (Optional) For **Data Freshness**, you may choose whether to include "fresh" data that has not been finalized by Google, and may be subject to change. Please note that if you are using Incremental sync mode, we highly recommend leaving this option to its default value of `final`. Refer to the [Data Freshness](https://docs.airbyte.com/integrations/sources/google-search-console#data-freshness) section in our full documentation for more information on this parameter. -8. Click **Set up source** and wait for the tests to complete. - -For detailed information on supported sync modes, supported streams, and performance considerations, refer to the full documentation for [Google Search Console](https://docs.airbyte.com/integrations/sources/google-search-console/). diff --git a/docs/integrations/sources/google-search-console.md b/docs/integrations/sources/google-search-console.md index 843d92ccb850..12d4ba6128b1 100644 --- a/docs/integrations/sources/google-search-console.md +++ b/docs/integrations/sources/google-search-console.md @@ -1,7 +1,11 @@ # Google Search Console + + This page contains the setup guide and reference information for the Google Search Console source connector. + + ## Prerequisites - A verified property in Google Search Console (or the list of the `Site URLs` (Website URL Properties)) @@ -11,13 +15,13 @@ This page contains the setup guide and reference information for the Google Sear ## Setup guide -### Step 1: Set up Google Search Console authentication +### Step 1: Set up Google Search Console To authenticate the Google Search Console connector, you will need to use one of the following methods: -#### I: OAuth (Recommended for Airbyte Cloud) - +#### OAuth (Recommended for Airbyte Cloud) + You can authenticate using your Google Account with OAuth if you are the owner of the Google Search Console property or have view permissions. Follow [Google's instructions](https://support.google.com/webmasters/answer/7687615?sjid=11103698321670173176-NA) to ensure that your account has the necessary permissions (**Owner** or **Full User**) to view the Google Search Console property. This option is recommended for **Airbyte Cloud** users, as it significantly simplifies the setup process and allows you to authenticate the connection [directly from the Airbyte UI](#step-2-set-up-the-google-search-console-connector-in-airbyte). @@ -31,7 +35,7 @@ To authenticate with OAuth in **Airbyte Open Source**, you will need to create a More information on the steps to create an OAuth app to access Google APIs and obtain these credentials can be found [in Google's documentation](https://developers.google.com/identity/protocols/oauth2). -#### II: Google service account with JSON key file (Recommended for Airbyte Open Source) +#### Google service account with JSON key file (Recommended for Airbyte Open Source) You can authenticate the connection using a JSON key file associated with a Google service account. This option is recommended for **Airbyte Open Source** users. Follow the steps below to create a service account and generate the JSON key file: @@ -70,28 +74,32 @@ For more information on this topic, please refer to [this Google article](https: ### Step 2: Set up the Google Search Console connector in Airbyte -1. [Log in to your Airbyte Cloud](https://cloud.airbyte.com/workspaces) or Airbyte Open Source account. + +**For Airbyte Cloud:** + +1. [Log in to your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**. 3. Find and select **Google Search Console** from the list of available sources. 4. For **Source name**, enter a name to help you identify this source. 5. For **Website URL Property**, enter the specific website property in Google Seach Console with data you want to replicate. 6. For **Start Date**, by default the `2021-01-01` is set, use the provided datepicker or enter a date in the format `YYYY-MM-DD`. Any data created on or after this date will be replicated. 7. To authenticate the connection: - - - - **For Airbyte Cloud**: Select **Oauth** from the Authentication dropdown, then click **Sign in with Google** to authorize your account. - - - - **For Airbyte Open Source**: - - (Recommended) Select **Service Account Key Authorization** from the Authentication dropdown, then enter the **Admin Email** and **Service Account JSON Key**. For the key, copy and paste the JSON key you obtained during the service account setup. It should begin with `{"type": "service account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ...}` - - Select **Oauth** from the Authentication dropdown, then enter your **Client ID**, **Client Secret**, **Access Token** and **Refresh Token**. - - + +- **For Airbyte Cloud:** + - Select **Oauth** from the Authentication dropdown, then click **Sign in with Google** to authorize your account. + + +- **For Airbyte Open Source:** + - (Recommended) Select **Service Account Key Authorization** from the Authentication dropdown, then enter the **Admin Email** and **Service Account JSON Key**. For the key, copy and paste the JSON key you obtained during the service account setup. It should begin with `{"type": "service account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ...}` + - Select **Oauth** from the Authentication dropdown, then enter your **Client ID**, **Client Secret**, **Access Token** and **Refresh Token**. + 8. (Optional) For **End Date**, you may optionally provide a date in the format `YYYY-MM-DD`. Any data created between the defined Start Date and End Date will be replicated. Leaving this field blank will replicate all data created on or after the Start Date to the present. 9. (Optional) For **Custom Reports**, you may optionally provide an array of JSON objects representing any custom reports you wish to query the API with. Refer to the [Custom reports](#custom-reports) section below for more information on formulating these reports. 10. (Optional) For **Data Freshness**, you may choose whether to include "fresh" data that has not been finalized by Google, and may be subject to change. Please note that if you are using Incremental sync mode, we highly recommend leaving this option to its default value of `final`. Refer to the [Data Freshness](#data-freshness) section below for more information on this parameter. 11. Click **Set up source** and wait for the tests to complete. + + ## Supported sync modes The Google Search Console Source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): @@ -163,10 +171,6 @@ The **Data Freshness** parameter deals with the "freshness", or finality of the When using Incremental Sync mode, we recommend leaving this parameter to its default state of `final`, as the `all` option may cause discrepancies between the data in your destination table and the finalized data in Google Search Console. ::: -## Performance considerations - -This connector attempts to back off gracefully when it hits Reports API's rate limits. To find more information about limits, see [Usage Limits](https://developers.google.com/webmaster-tools/limits) documentation. - ## Data type map | Integration Type | Airbyte Type | Notes | @@ -176,6 +180,24 @@ This connector attempts to back off gracefully when it hits Reports API's rate l | `array` | `array` | | | `object` | `object` | | +## Limitations & Troubleshooting + +
+ +Expand to see details about Google Search Console connector limitations and troubleshooting. + + +### Connector limitations + +#### Rate limiting +This connector attempts to back off gracefully when it hits Reports API's rate limits. To find more information about limits, see [Usage Limits](https://developers.google.com/webmaster-tools/limits) documentation. + +### Troubleshooting + +* Check out common troubleshooting issues for the Google Search Console source connector on our [Airbyte Forum](https://github.com/airbytehq/airbyte/discussions). + +
+ ## Changelog | Version | Date | Pull Request | Subject | @@ -215,4 +237,6 @@ This connector attempts to back off gracefully when it hits Reports API's rate l | `0.1.3` | 2021-09-23 | [6405](https://github.com/airbytehq/airbyte/pull/6405) | Correct Spec File | | `0.1.2` | 2021-09-17 | [6222](https://github.com/airbytehq/airbyte/pull/6222) | Correct Spec File | | `0.1.1` | 2021-09-22 | [6315](https://github.com/airbytehq/airbyte/pull/6315) | Verify access to all sites when performing connection check | -| `0.1.0` | 2021-09-03 | [5350](https://github.com/airbytehq/airbyte/pull/5350) | Initial Release | \ No newline at end of file +| `0.1.0` | 2021-09-03 | [5350](https://github.com/airbytehq/airbyte/pull/5350) | Initial Release | + + \ No newline at end of file