Docs: update Google search console docs #29416
Conversation
octavia-squidington-iii
added
the
area/documentation
| * Enable Google Search Console API | ||
| | ||
| - A verified property in Google Search Console | ||
| - Google Search Console API enabled for your project |
There was a problem hiding this comment.
this is only true for OSS
There was a problem hiding this comment.
Gotcha, added in the env tags and an (OSS only) note
| - **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). | ||
| <!-- /env:cloud --> | ||
| <!-- env:oss --> | ||
| - **For Airbyte Open Source**: 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, ...}`. More information on setting up a service account and generating the JSON key can be found in our [full Google Search Console documentation](https://docs.airbyte.io/integrations/sources/google-search-console#setup-guide). |
There was a problem hiding this comment.
for reference they can still use oauth in oss but they need to create their own oauth app. IDK if we need to list out the setup process for them, but let's at least mention that
There was a problem hiding this comment.
Good call, I added the option to both docs pages and a link to Google's setup guide for creating the auth app
|
|
||
| ### Creating a Google service account | ||
| #### II: Google service account with JSON key file (Recommended for Airbyte Open Source) |
There was a problem hiding this comment.
can we hide this for cloud?
There was a problem hiding this comment.
I've gone ahead and added the tags just in case, but I don't think they have any effect on the main page when an in-app page exists, since the latter is the one that gets displayed in the Airbyte UI
| @@ -121,6 +105,52 @@ Parameter `data_state='all'` should not be used with Incremental Sync mode as it | |||
| - [Analytics site report by site](https://developers.google.com/webmaster-tools/search-console-api-original/v3/searchanalytics/query) | |||
| - Analytics report by custom dimensions | |||
|
|
|||
| ## Connector-specific configurations | |||
|
|
|||
| ### Custom reports | |||
|
|
||
| You can use the [Google APIS Explorer](https://developers.google.com/webmaster-tools/v1/searchanalytics/query) to build and test the reports you want to use. | ||
|
|
||
| ### Data State |
There was a problem hiding this comment.
should this option and section be called data freshness instead?
There was a problem hiding this comment.
great addition on this section btw, nice work!
There was a problem hiding this comment.
Thanks! Yeah I think data freshness makes sense, I've made the changes here and added the new title to the spec PR
* add sections for data state and custom reports * service account edits * full rework of setup steps * edits * edits * quick fix * add auth links to inapp page * add oauth for oss, data state to data freshness
What
Updated the in-app and main docs pages for GSC source connector
How