This integration is powered by Singer's Google Search Console tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Google Search Console integration summary
Stitch’s Google Search Console integration replicates data using the Google Search Console API. Refer to the Schema section for a list of objects available for replication.
Google Search Console feature snapshot
A high-level look at Stitch's Google Search Console (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on September 2, 2020 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Google Search Console
Google Search Console setup requirements
To set up Google Search Console in Stitch, you need:
-
Admin access in Google Search Console. Admin access is required in your Google Search Console account to change settings required to connect Stitch.
Step 1: Set up your Google Search Console
- Login to your Google account and navigate to Google Search Console.
- Add the domains or websites for your organization. If adding a domain, it will cover all URLs across all of its subdomains. If adding a website, only the entered websites will be counted for.
- Verify your site ownership by clicking CONTINUE. Depending on your verification method, this can take up to a day.
- Once your link(s) are verified, add them to the
sitemap.xml
files in the Sitemaps section of your Google Search Console account. Click Submit.
Step 2: Create a Google Search Console project
- Login to your Google Cloud Console.
- Click Create New Project.
- Enter a Project name and select a project Location.
- Click CREATE.
Step 3: Enable Google Search Console API
- Login to your Google Cloud Platform account. Make sure you’re in the project that you want to use for your Google Search Console integration.
- Select APIs & Services from the left-hand menu panel. This will take you to the APIs & Services dashboard.
- In the dashboard, click ENABLE APIS AND SERVICES. You will be redirected to the API Library.
- Search for Google Search Console and select
Google Search Console API
. - Click ENABLE.
Step 4: Verify API domain
- Staying in the APIs & Services section, click on Domain verification in the left-hand menu panel.
- Click Add domain.
- Add the domain you’re using for this project.
Step 5: API OAuth consent
- Staying in the APIs & Services section, click on the OAuth consent screen in the left-hand menu panel.
- Select your project.
- Make the Application type
Public
. - Make the Application name
tap-google-search-console
. - Optionally, you can add an image for a logo to help you identify your app.
- In the Support email field, enter your email that you will use for this app.
- In the Scope section, click Add scope.
- Add the following scope:
Google Search Console API ../auth/webmasters.readonly
. - In the Authorized domains section, add the domains that you added to Google Search Console in step 1.
- Click SAVE.
- You will be taken to a screen that says OAuth grant limits. The default limit is 100 grants per minute, per day. You can request to raise the grant limit for your project by clicking Raise limit. You can also change the time interval grant resets. The options for time intervals are:
1h
,6h
,1d,
,7d
, and30d
.
Step 6: Create OAuth credentials
- Staying in the APIs & Services section, click on Credentials in the left-hand menu panel.
- Click on the Create credentials dropdown menu.
- Select OAuth client ID.
- In the Create OAuth client ID page, select Web application for the Application type.
- In the Name field, enter
tap-google-search-console
. - In the Authorized redirect URIs section, add the domains that you added in step 1.
- Click CREATE.
Step 7: Add Google Search Console as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Google Search Console icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Google Search Console” would create a schema called
stitch_google_search_console
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Site Urls field, enter the URLs you added to your sitemap file in step 1. The URLs should be comma delimited and begin with
https://
orhttp://
. Example:https://yoursite.com, http://yourothersite.com
.
Note: If you get an error saying that the user doesn’t have sufficient permissions or that the URL is not a verified Google Search Console site, try replacing https://
or http://
with sc-domain:
. Example: sc-domain:yoursite.com
.
Step 8: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Google Search Console integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Google Search Console’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 9: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Google Search Console integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 10: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Google Search Console integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Google Search Console, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Google Search Console table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Google Search Console integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
performance_report_country
Replication Method : |
Key-based Incremental |
Replication Key |
date |
Primary Key |
site_url : search_type : country : date |
API endpoint : |
The performance_report_country
table contains information about the performance of your sites in Google searches. This particular table is filtered and grouped by country.
site_url
The site URL. Reference: |
search_type
The search type to filter for. Acceptable values are: Reference: |
country
The country that the search came from. |
date
The date and time your site appeared in a Google search. |
clicks
The amount of clicks from a Google search that lead that landed a user on your site. |
ctr
The click-through rate. |
impressions
The amount of links to your sites that exist in a google search. |
position
The average position of your site in the search result. |
performance_report_custom
Replication Method : |
Key-based Incremental |
Replication Key |
date |
Primary Key |
search_type : site_url : dimensions_hash_key : date |
API endpoint : |
The performance_report_custom
table contains information about the performance of your sites in Google searches. This particular table is filtered and grouped by your custom dimensions.
search_type
The search type to filter for. Acceptable values are: Reference: |
site_url
The site URL. Reference: |
dimensions_hash_key
The MD5 hash key of your selected dimension values. |
date
The date and time your site appeared in a Google search. |
clicks
The amount of clicks from a Google search that lead that landed a user on your site. |
country
The country that the search came from. |
ctr
The click-through rate. |
device
The type of device the user was using to search. |
impressions
The amount of links to your sites that exist in a google search. |
page
The final URL linked by a Search result after any skip redirects. |
position
The average position of your site in the search result. |
query
The query strings that the user searched for on Google. Only searches that returned your site are shown. |
performance_report_date
Replication Method : |
Key-based Incremental |
Replication Key |
date |
Primary Key |
search_type : site_url : date |
API endpoint : |
The performance_report_date
table contains information about the performance of your sites in Google searches. This particular table is filtered and grouped by date.
search_type
The search type to filter for. Acceptable values are: Reference: |
site_url
The site URL. Reference: |
date
The date and time your site appeared in a Google search. |
clicks
The amount of clicks from a Google search that lead that landed a user on your site. |
ctr
The click-through rate. |
impressions
The amount of links to your sites that exist in a google search. |
position
The average position of your site in the search result. |
performance_report_device
Replication Method : |
Key-based Incremental |
Replication Key |
date |
Primary Key |
search_type : site_url : device : date |
API endpoint : |
The performance_report_device
table contains information about the performance of your sites in Google searches. This particular table is filtered and grouped by the user’s device type.
search_type
The search type to filter for. Acceptable values are: Reference: |
site_url
The site URL. Reference: |
device
The type of device the user was using to search. |
date
The date and time your site appeared in a Google search. |
clicks
The amount of clicks from a Google search that lead that landed a user on your site. |
ctr
The click-through rate. |
impressions
The amount of links to your sites that exist in a google search. |
position
The average position of your site in the search result. |
performance_report_page
Replication Method : |
Key-based Incremental |
Replication Key |
date |
Primary Key |
search_type : site_url : page : date |
API endpoint : |
The performance_report_page
table contains information about the performance of your sites in Google searches. This particular table is filtered and grouped by your landing page URLs that show up in Google search results.
search_type
The search type to filter for. Acceptable values are: Reference: |
site_url
The site URL. Reference: |
page
The final URL linked by a Search result after any skip redirects. |
date
The date and time your site appeared in a Google search. |
clicks
The amount of clicks from a Google search that lead that landed a user on your site. |
ctr
The click-through rate. |
impressions
The amount of links to your sites that exist in a google search. |
position
The average position of your site in the search result. |
performance_report_query
Replication Method : |
Key-based Incremental |
Replication Key |
date |
Primary Key |
search_type : site_url : query : date |
API endpoint : |
The performance_report_query
table contains information about the performance of your sites in Google searches. This particular table is filtered and grouped by the users’ search queries that resulted in your sites appearing in the search results.
search_type
The search type to filter for. Acceptable values are: Reference: |
site_url
The site URL. Reference: |
query
The query strings that the user searched for on Google. Only searches that returned your site are shown. |
date
The date and time your site appeared in a Google search. |
clicks
The amount of clicks from a Google search that lead that landed a user on your site. |
ctr
The click-through rate. |
impressions
The amount of links to your sites that exist in a google search. |
position
The average position of your site in the search result. |
sitemaps
Replication Method : |
Full Table |
Primary Key |
site_url : path : last_submitted |
API endpoint : |
The sitemaps
table contains information about the sitemap entries in your Google Search Console.
site_url
The site URL. Reference: |
path
The URL of the sitemap. |
last_submitted
The time the sitemap was last downloaded. |
contents
The type of content in the sitemap. Acceptable values are:
|
errors
The number of errors in the sitemap. |
is_pending
Whether or not the sitemap has been processed. If |
is_sitemaps_index
Whether or not this is a sitemap index file. If |
last_downloaded
The time the sitmap was last downloaded. |
type
The type of sitemap. Acceptable values are:
|
warnings
The number of warnings for the sitemap. |
Replication Method : |
Full Table |
Primary Key |
site_url |
API endpoint : |
The sites
contains information about your Google Search Console sites at a permission level.
site_url
The site URL. Reference: |
permission_level
The user’s permission level for the site. Acceptable values are:
|
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.