Google Search Console Connector for JAVA

Read Google Search Console report (Organic Traffic) about site performance, ranking, clicks, ctr and impressions by date, page, country, query, country, device and searchAppearance.

In this article you will learn how to quickly and efficiently integrate Google Search Console data in JAVA. We will use high-performance Google Search Console Connector to easily connect to Google Search Console and then access the data inside JAVA.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Google Search Console Connector for JAVA is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to Google Search Console in other apps

Connect to Google Search Console in SSIS

Connect to Google Search Console in SQL Server

Connect to Google Search Console in Power BI

Connect to Google Search Console in SSRS

Connect to Google Search Console in Informatica

Connect to Google Search Console in MS Access

Connect to Google Search Console in MS Excel

Connect to Google Search Console in SSAS

Connect to Google Search Console in C#

Connect to Google Search Console in Python

Connect to Google Search Console in Tableau

Connect to Google Search Console in SAP Crystal Reports

Connect to Google Search Console in Azure Data Factory (Pipeline)

Connect to Google Search Console in Azure Data Factory (SSIS)

Connect to Google Search Console in Talend Studio

Connect to Google Search Console in UiPath

Connect to Google Search Console in PowerShell

Connect to Google Search Console in ODBC

Create Data Source in ZappySys Data Gateway based on API Driver

Download and install ODBC PowerPack.
Search for gateway in start menu and Open ZappySys Data Gateway:
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

GoogleSearchConsoleDSN
When the Configuration window appears give your data source a name if you haven't done that already, then select "Google Search Console" from the list of Popular Connectors. If "Google Search Console" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

GoogleSearchConsoleDSN

Google Search Console

Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

User Account [OAuth]

User accounts represent a developer, administrator, or any other person who interacts with Google APIs and services. User accounts are managed as Google Accounts, either with Google Workspace or Cloud Identity. They can also be user accounts that are managed by a third-party identity provider and federated with Workforce Identity Federation. [API reference]

Steps how to get and use Google Search Console credentials

Follow these steps on how to create Client Credentials (User Account principle) to authenticate and access Google Calendar API in SSIS package or ODBC data source:

WARNING: If you are planning to automate processes, we recommend that you use a Service Account authentication method. In case, you still need to use User Account, then make sure you use a system/generic account (e.g. automation@my-company.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will start to fail.

Step-1: Create project

This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

First of all, go to Google API Console.
Then click Select a project button and then click NEW PROJECT button:
Name your project and click CREATE button:
Wait until the project is created:
Done! Let's proceed to the next step.

Step-2: Enable Google Calendar API

In this step we will enable Google Calendar API:

Select your project on the top bar:
Then click the "hamburger" icon on the top left and access APIs & Services:
Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:
In the search bar search for Search Console and then locate and select Search Console API:
Enable Search Console API:
Done! Let's proceed to the next step.

Step-3: Create OAuth application

First of all, click the "hamburger" icon on the top left and then hit VIEW ALL PRODUCTS:
Then access Google Auth Platform to start creating an OAuth application:
Start by pressing GET STARTED button:
Next, continue by filling in App name and User support email fields:
Choose Internal option, if it's enabled, otherwise select External:
Optional step if you used Internal option in the previous step. Nevertheless, if you had to use External option, then click ADD USERS to add a user:
Then add your contact Email address:
Finally, check the checkbox and click CREATE button:
Done! Let's create Client Credentials in the next step.

Step-4: Create Client Credentials

In Google Auth Platform, select Clients menu item and click CREATE CLIENT button:
Choose Desktop app as Application type and name your credentials:
Continue by opening the created credentials:
Finally, copy Client ID and Client secret for the later step:
Done! We have all the data needed for authentication, let's proceed to the last step!

Step-5: Configure connection

Now go to SSIS package or ODBC data source and use previously copied values in User Account authentication configuration:
- In the ClientId field paste the Client ID value.
- In the ClientSecret field paste the Client secret value.
Press Generate Token button to generate Access and Refresh Tokens.
Finally, click Test Connection to confirm the connection is working.
Done! Now you are ready to use Google Calendar Connector!

Fill in all required parameters and set optional parameters if needed:

GoogleSearchConsoleDSN

Google Search Console

User Account [OAuth]

https://searchconsole.googleapis.com/webmasters/v3

Required Parameters
UseCustomApp	Fill-in the parameter...
Optional Parameters
ClientId
ClientSecret
Scope	https://www.googleapis.com/auth/webmasters.readonly
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	403\|429
RetryCountMax	5
RetryMultiplyWaitTime	True
Redirect URL (Only for Web App)

**Service Account (Using .json OR .p12 key file) [OAuth]**

Service accounts are accounts that do not represent a human user. They provide a way to manage authentication and authorization when a human is not directly involved, such as when an application needs to access Google Cloud resources. Service accounts are managed by IAM. [API reference]

Steps how to get and use Google Search Console credentials

Follow these steps on how to create Service Account to authenticate and access Google Calendar API in SSIS package or ODBC data source:

Step-1: Create project

This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

First of all, go to Google API Console.
Then click Select a project button and then click NEW PROJECT button:
Name your project and click CREATE button:
Wait until the project is created:
Done! Let's proceed to the next step.

Step-2: Enable Google Calendar API

In this step we will enable Google Calendar API:

Select your project on the top bar:
Then click the "hamburger" icon on the top left and access APIs & Services:
Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:
In the search bar search for Search Console and then locate and select Search Console API:
Enable Search Console API:
Done! Let's proceed to the next step.

Step-3: Create Service Account

Use the steps below to create a Service Account in Google Cloud:

First of all, go to IAM & Admin in Google Cloud console:
Once you do that, click Service Accounts on the left side and click CREATE SERVICE ACCOUNT button:
Then name your service account and click CREATE AND CONTINUE button:
Continue by clicking Select a role dropdown and start granting service account Project Viewer roles:
Find Project group and select Viewer role:
Finish adding roles by clicking CONTINUE button:

You can always add or modify permissions later in IAM & Admin.
Finally, in the last step, just click button DONE:
Done! We are ready to add a Key to this service account in the next step.

Step-4: Add Key to Service Account

We are ready to add a Key (P12 certificate) to the created Service Account:

In Service Accounts open newly created service account:
Next, copy email address of your service account for the later step:
Continue by selecting KEYS tab, then press ADD KEY dropdown, and click Create new key menu item:
Finally, select P12 option and hit CREATE button:
P12 certificate downloads into your machine. We have all the data needed for authentication, let's proceed to the last step!

Step-5: Grant Access in Google Search Console

Now it's time to grant Google Search Console read/write permissions to the created service account:

Go to Google Search Console.
Open your verified site property (e.g., https://example.com).
In the left-hand menu, click Settings.
Under Users and permissions, click it to open the user management panel.
Click the Add user button.
In the email field, enter the service account email, e.g., my-bot@your-project-id.iam.gserviceaccount.com.
Choose the permission level:
- Full – can view all data and take actions.
- Restricted – can only view data.
Click Add to save.

Note: This is required so the API calls from the service account can access your site's data.

Step-6: Configure connection

Now go to SSIS package or ODBC data source and configure these fields in Service Account authentication configuration:
- In the Service Account Email field paste the service account Email address value you copied in the previous step.
- In the Service Account Private Key Path (i.e. *.p12) field use downloaded certificate's file path.
Done! Now you are ready to use Google Search Connector!

Fill in all required parameters and set optional parameters if needed:

GoogleSearchConsoleDSN

Google Search Console

Service Account (Using *.json OR *.p12 key file) [OAuth]

https://searchconsole.googleapis.com/webmasters/v3

Required Parameters
Service Account Email	Fill-in the parameter...
Service Account Private Key Path (i.e. *.p12)	Fill-in the parameter...
Optional Parameters
Scope	https://www.googleapis.com/auth/webmasters.readonly
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	403\|429
RetryCountMax	5
RetryMultiplyWaitTime	True
Impersonate As (Enter Email Id)

Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

ZappySys API Driver - Google Search Console

Read Google Search Console report (Organic Traffic) about site performance, ranking, clicks, ctr and impressions by date, page, country, query, country, device and searchAppearance.

GoogleSearchConsoleDSN
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in JAVA to retrieve data from Google Search Console. Hit OK button to use this query in the next step.
```
SELECT * FROM Sites
```
Some parameters configured in this window will be passed to the Google Search Console API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in JAVA:
ZappySys API Driver - Google Search Console

Read Google Search Console report (Organic Traffic) about site performance, ranking, clicks, ctr and impressions by date, page, country, query, country, device and searchAppearance.

GoogleSearchConsoleDSN
```
SELECT * FROM Sites
```
You can also access data quickly from the tables dropdown by selecting <Select table>.

A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Google Search Console API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Google Search Console servers).
Click OK to finish creating the data source.
Most Important Step: Now, After creating or modifying a data source in ZappySys Data Gateway, make sure to click the SAVE button to preserve your changes.
Then, RESTART the Data Gateway service to ensure all changes are properly applied.

Skipping either step may result in the new settings not taking effect.

Read data in Java from the DSN

Java code to get the data:

"jdbc:sqlserver://localhost:5000;databasename=GoogleSearchConsoleDSN;user=tdsuser;password=test"
When you run the code it will make the API call and read the data:

Here is Java program's code in text format:


//Step-1: Install ZappySys ODBC PowerPack and Configure Data Gateway

//Step-2:Assuming the Microsoft SQL Server JDBC Driver is in below folder
//C:\Program Files\Microsoft Jdbc Driver 6.0 for SQL Server\sqljdbc_6.0\enu\auth\x64
package padaone;

import java.sql.*;

public class zappy {

    public static void main(String[] args) {

        // Create a variable for the connection string.
        String connectionUrl = "jdbc:sqlserver://localhost:5000;databasename=GoogleSearchConsoleDSN;user=test;password=test";

        // Declare the JDBC objects.
        Connection con = null;
        Statement stmt = null;
        ResultSet rs = null;

            try {
                // Establish the connection.
                Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
                con = DriverManager.getConnection(connectionUrl);

                // Create and execute an SQL statement that returns some data.
                String SQL = "SELECT Country , SUM(UnitPrice * Quantity) Total " 
                           + "FROM value " 
                           + "GROUP BY Country "
                           + "WITH (SRC='https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json')";
                stmt = con.createStatement();
                rs = stmt.executeQuery(SQL);

                // Iterate through the data in the result set and display it.
                while (rs.next()) {
                    System.out.println(rs.getString(1) + " " + rs.getString(2));
                }
            }

        // Handle any errors that may have occurred.
        catch (Exception e) {
            e.printStackTrace();
        } 
        
        finally {
            if (rs != null) try { rs.close(); } catch (Exception e) {}
            if (stmt != null) try { stmt.close(); } catch (Exception e) {}
            if (con != null) try { con.close(); } catch (Exception e) {}
        }
    }
}