JAVA Google Sheets Connector

In this article you will learn how to integrate Google Sheets data to JAVA (live / bi-directional connection to Google Sheets). Read / write Google Sheets data inside your app, perform many Google Sheets operations without coding using easy to use high performance API Connector for Google Sheets.

Using Google Sheets Connector you will be able to connect, read, and write data from within JAVA. Follow the steps below to see how we would accomplish that.

Download Help File Buy

Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.

If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.

Create Data Source in ZappySys Data Gateway based on ZappySys API Driver

Download and install ZappySys 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.

GoogleSheetsDSN
When the Configuration window appears give your data source a name if you haven't done that already, then select "Google Sheets" from the list of Popular Connectors. If "Google Sheets" 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:

GoogleSheetsDSN

Google Sheets

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]

Steps to get Google Sheets Credentials
This connection can be configured in two ways. Use Default App (Created by ZappySys) OR Use Custom App created by you.
To use minimum settings you can start with the ZappySys created App. Just change UseCustomApp=false on the properties grid so you dont need ClientID / Secret. When you click Generate Token you might see a warning about App is not trusted (Simply Click Advanced Link to expand hidden section and then click Go to App link to Proceed).

To register a custom app, perform the following steps (Detailed steps found in the help link at the end):

Go to Google API Console.
From the Project Dropdown (usually found at the top bar) click Select Project.
On the Project Popup click CREATE PROJECT.
Once the project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown).
Click ENABLE APIS AND SERVICES.
Now we need to Enable two APIs one by one (Sheets API and Drive API).
Search Sheets. Select and click ENABLE.
Search Drive. Select and click ENABLE.
Go back to the main screen of the Google API Console
Click the OAuth Consent Screen tab. Enter necessary details and Save.
Click the Credentials tab.
Click CREATE CREDENTIALS (some where in topbar) and select OAuth Client ID option.
When prompted Select Application Type as Desktop App and click Create to receive your ClientID and Secret. You can use this information now to configure Connection with UseCustomApp=true.

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

GoogleSheetsDSN

Google Sheets

User Account [OAuth]

https://sheets.googleapis.com/v4/spreadsheets

Required Parameters
UseCustomApp	Fill in the parameter...
Optional Parameters
ClientId	Fill in the parameter...
ClientSecret	Fill in the parameter...
Scope	Fill in the parameter...
Default SpreadSheetId	Fill in the parameter...
Default Tab Name (i.e. Sheet1)	Fill in the parameter...
RetryMode	Fill in the parameter...
RetryStatusCodeList	Fill in the parameter...
RetryCountMax	Fill in the parameter...

Service Account (Using Private Key File) [OAuth]

Steps to get Google Sheets Credentials
Use these steps to authenticate as service account rather than Google / GSuite User. Learn more about service account here

Basically to call Google API as Service account we need to perform following steps listed in 3 sections (Detailed steps found in the help link at the end)

Create Project

First thing is create a Project so we can call Google API. Skip this section if you already have Project (Go to next section)

Go to Google API Console
From the Project Dropdown (usually found at the top bar) click Select Project
On Project Propup click CREATE PROJECT
Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
Click ENABLE APIS AND SERVICES
Now we need to Enable two APIs one by one (Sheets API and Drive API).
Search Sheets. Select and click ENABLE
Search Drive. Select and click ENABLE

Create Service Account

Once Project is created and APIs are enabled we can now create a service account under that project. Service account has its ID which looks like some email ID (not to confuse with Google /Gmail email ID)

Go to Create Service Account
From the Project Dropdown (usually found at the top bar) click Select Project
Enter Service account name and Service account description
For Role, do not select anything for now and Click Continue and then click Done. Next we will create Key.

Create Key

Once service account is created we need to create key file (i.e. credentials).

In the Cloud Console, click the email address for the service account that you created.
Click Keys.
Click Add key, then click Create new key.
Click Create and select P12 format. A P12 key file is downloaded to your computer. We will use this file in our API connection.
Click Close.
Now you may use downloaded *.p12 key file as secret file and Service Account Email as Client ID (e.g. some-service-account-name@your-project-id.iam.gserviceaccount.com ).

Add Permission

Now last thing is give read/write permission to Service Account. Basically you can create or open Google Sheet and add the Service Account as an editor to it as below.

Copy the email address of your service account we created in previous step (its usually like this some-service-account-name@your-project-id.iam.gserviceaccount.com).
Create or select an existing Google Sheet.
Navigate to Sheet for which you like to give read/write access to Service Account.
Click on the Share button in the top right, and add the email address of the service account as an editor. Here is how to share file(s) with specific people. Juse share with Service Account (use Service Account Email found on previous section)

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

GoogleSheetsDSN

Google Sheets

Service Account (Using Private Key File) [OAuth]

https://sheets.googleapis.com/v4/spreadsheets

Required Parameters
Service Account Email	Fill in the parameter...
Service Account Private Key Path (i.e. *.p12)	Fill in the parameter...
Optional Parameters
Scope	Fill in the parameter...
Default SpreadSheetId	Fill in the parameter...
Default Tab Name (i.e. Sheet1)	Fill in the parameter...
RetryMode	Fill in the parameter...
RetryStatusCodeList	Fill in the parameter...
RetryCountMax	Fill in the parameter...

Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
Click OK to finish creating the data source.

Read data in Java from the DSN

Java code to get the data:

"jdbc:sqlserver://localhost:5000;databasename=GoogleSheetsDSN;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=GoogleSheetsDSN;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) {}
        }
    }
}

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
```
CREATE PROCEDURE [usp_get_orders]
    @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
 AS
    SELECT * FROM Orders where OrderDate >= '<@fromdate>';
```
That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
```
Exec usp_get_orders '1996-01-01';
```
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
```
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
```
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
```
SELECT
  "ShipCountry",
  "OrderID",
  "CustomerID",
  "EmployeeID",
  "OrderDate",
  "RequiredDate",
  "ShippedDate",
  "ShipVia",
  "Freight",
  "ShipName",
  "ShipAddress",
  "ShipCity",
  "ShipRegion",
  "ShipPostalCode"
FROM "Orders"
Where "ShipCountry"='USA'
```
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
```
SELECT * FROM "vt__usa_orders_only"
```
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
```
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
```
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.

Conclusion

In this article we discussed how to connect to Google Sheets in JAVA and integrate data without any coding. Click here to Download Google Sheets Connector for JAVA and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Google Sheets Connector for JAVA Documentation

Actions supported by Google Sheets Connector

Google Sheets Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.

Read Sheet Data

Read google spreadsheet data from desired tab / cell location (i.e. start/end range)

Parameter	Description
Range

Clear Sheet Values

Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

Parameter	Description
Range

Delete Sheet Rows / Columns

Deletes rows / columns based on startIndex / endIndex range (Index is zero based). For example to delete First 5 rows specify startIndex=0 and endIndex=4

Parameter

Description

Range Type

Specifies what would you like to delete (i.e. Rows or Columns)

Option	Value
ROWS	ROWS
COLUMNS	COLUMNS

Range Start Index (starts from 0)

Range Start Index (Zero based) for operation. For Column Operation translate Alpha value to zero based index. Example: Column D = Index 3. Column AA=26

Range End Index (starts from 0)

Range End Index (Zero based) for operation. For Column Operation translate Alpha value to zero based index. Example: Column D = Index 3. Column AA=26

TabId

Numeric ID of SpreadSheet Tab for which you like to delete rows/columns. For first tab its 0. You can find this ID from Sheet URL in browser. Get Number after edit#gid= (thats your Tab ID)

Delete SpreadSheet Tab

Deletes specified tab from spreadsheet

Parameter	Description
TabId	Numeric ID of SpreadSheet Tab for which you like to delete rows/columns. For first tab its 0. You can find this ID from Sheet URL in browser. Get Number after edit#gid= (thats your Tab ID)

Create SpreadSheet Tab

Creates new tab for specified spreadsheet.

Parameter	Description
NewTabName	Name for new Tab you like to add
InitialRowCount	Initial row count for new sheet
InitialColumnCount	Initial column count for new sheet
TabColorRedValue	Tab Color - Red Value for RGB
TabColorGreenValue	Tab Color - Green Value for RGB
TabColorBlueValue	Tab Color - Blue Value for RGB

Execute Command(s)

Perform various operations available in online editor such as copy, paste, format, merge. Add multiple JSON command by adding comma after first command (e.g. requests : [ {..cmd1..} , {..cmd2..}, {..cmd3..} ] ) Refer to example requests on help link.

Parameter	Description
Request Body
TabId	Numeric ID of SpreadSheet Tab for which you like to delete rows/columns. For first tab its 0. You can find this ID from Sheet URL in browser. Get Number after edit#gid= (thats your Tab ID)

Update Sheet Data (Overwrite Cells)

Update data to spreadsheet on desired tab / cell location (i.e. start/end range)

Parameter	Description
Range for Table Boundary (Including Header)	Enter Range to detect Table column names and datatypes. Example: enter A1:C if you have table of 3 columns starting from Cell A1
Range for Data Cells	Cell Range which needs to be update. Example: Enter A2 if you like to start update from cell A2

Insert Sheet Data (Append at the end)

Append data to spreadsheet on desired tab. Data is appended after last non-empty row/cell location. You can supply cell offset to start scan to find non-empty cell.

Parameter	Description
Start Range	This is the range in which next row location is detected based on first empty cell and row (Examples: A1, A1:GR, A1:GR200). This range is also used to detect metadata. Values are appended after the last row of the table.

Get Sheet Properties / Tab information

Read read sheet properties (e.g. list of tabs on sheet and its properties)

Parameter

Description

SpreadSheetId

Option	Value
Enter SpreadSheet Id
Example SpreadSheet Id	1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms

Generic Request

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameter	Description
Url	API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body	Request Body content goes here
IsMultiPart	Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter	Enter filter to extract array from response. Example: $.rows[] --OR-- $.customers[].orders[*]. Check your response document and find out hierarchy you like to extract
Headers	Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Other App Integration scenarios for Google Sheets

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

Tableau

SAP Crystal Reports

Azure Data Factory (ADF)

ODBC

Other Connectors for JAVA

Zendesk

Azure DevOps

ManagedEngine ServiceDesk Plus (Zoho)

Zoho CRM

Hubspot

Google Sheets

Stripe

YouTube

Google BigQuery

OneDrive

OData

Amazon Ads

Mailchimp

Jira

Outlook Mail (Office 365)

Zoom

Cosmos DB

Shopify

Nativo

Google Drive

SharePoint Online

Amazon MWS

ServiceNow

ElasticSearch

Google Calendar

DropBox

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Download Google Sheets Connector for JAVA Documentation

Common Searches:

How to connect Google Sheets in JAVA?
How to get Google Sheets data in JAVA?
How to read Google Sheets data in JAVA?
How to load Google Sheets data in JAVA?
How to import Google Sheets data in JAVA?
How to pull Google Sheets data in JAVA?
How to push data to Google Sheets in JAVA?
How to write data to Google Sheets in JAVA?
How to POST data to Google Sheets in JAVA?
Call Google Sheets API in JAVA
Consume Google Sheets API in JAVA
Google Sheets JAVA Automate
Google Sheets JAVA Integration
Integration Google Sheets in JAVA
Consume real-time Google Sheets data in JAVA
Consume realtime Google Sheets API data in JAVA
Google Sheets ODBC Driver | ODBC Driver for Google Sheets | ODBC Google Sheets Driver | SSIS Google Sheets Source | SSIS Google Sheets Destination
Connect Google Sheets in JAVA
Load Google Sheets in JAVA
Load Google Sheets data in JAVA
Read Google Sheets data in JAVA
Google Sheets API Call in JAVA

JAVA Google Sheets Connector

How to Read/Write Google Sheets data in JAVA

JAVA Google Sheets Connector

Create Data Source in ZappySys Data Gateway based on ZappySys API Driver

User Account [OAuth]

Service Account (Using Private Key File) [OAuth]

Create Project

Create Service Account

Create Key

Add Permission

Read data in Java from the DSN

Create Custom Store Procedure in ZappySys Driver

Create Custom Virtual Table in ZappySys Driver

Conclusion

Actions supported by Google Sheets Connector

Other App Integration scenarios for Google Sheets

Other Connectors for JAVA

How to connect Google Sheets in JAVA?

How to get Google Sheets data in JAVA?

How to read Google Sheets data in JAVA?

How to load Google Sheets data in JAVA?

How to import Google Sheets data in JAVA?

How to pull Google Sheets data in JAVA?

How to push data to Google Sheets in JAVA?

How to write data to Google Sheets in JAVA?

How to POST data to Google Sheets in JAVA?

Call Google Sheets API in JAVA

Consume Google Sheets API in JAVA

Google Sheets JAVA Automate

Google Sheets JAVA Integration

Integration Google Sheets in JAVA

Consume real-time Google Sheets data in JAVA

Consume realtime Google Sheets API data in JAVA

Google Sheets ODBC Driver | ODBC Driver for Google Sheets | ODBC Google Sheets Driver | SSIS Google Sheets Source | SSIS Google Sheets Destination

Connect Google Sheets in JAVA

Load Google Sheets in JAVA

Load Google Sheets data in JAVA

Read Google Sheets data in JAVA

Google Sheets API Call in JAVA