Python Google Sheets Connector
In this article you will learn how to integrate Using Google Sheets Connector you will be able to connect, read, and write data from within Python. Follow the steps below to see how we would accomplish that. 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. |
See also
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
To get data from GoogleSheets using Python we first need to create a DSN (Data Source) which will access data from GoogleSheets. We will later be able to read data using Python. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
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:
GoogleSheetsDSNGoogle 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.
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:
GoogleSheetsDSNUser Account [OAuth]https://sheets.googleapis.com/v4/spreadsheetsRequired 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... 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:
GoogleSheetsDSNService Account (Using Private Key File) [OAuth]https://sheets.googleapis.com/v4/spreadsheetsRequired 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 Python from the DSN
-
Python code to get the data:
GoogleSheetsDSN') -
When you run the code it will make the API call and read the data:
-
Here is Python program's code in text format:
import pyodbc conn = pyodbc.connect('DSN=GoogleSheetsDSN') cursor = conn.cursor() #execute query to fetch data from API service cursor.execute("SELECT * FROM value") row = cursor.fetchone() while row: print (row[1]) row = cursor.fetchone()
-
If you want to avoid to be dependent on a DSN name and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String . Then in your Python code use Connection String when initializing OdbcConnection object, for example:
conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;')
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';
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"
Conclusion
In this article we discussed how to connect to Google Sheets in Python and integrate data without any coding. Click here to Download Google Sheets Connector for Python 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 Python
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.Parameter | Description |
---|---|
Range |
|
Parameter | Description |
---|---|
Range |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
Range Type |
|
||||||
Range Start Index (starts from 0) |
|
||||||
Range End Index (starts from 0) |
|
||||||
TabId |
|
Parameter | Description |
---|---|
TabId |
|
Parameter | Description |
---|---|
NewTabName |
|
InitialRowCount |
|
InitialColumnCount |
|
TabColorRedValue |
|
TabColorGreenValue |
|
TabColorBlueValue |
|
Parameter | Description |
---|---|
Request Body |
|
TabId |
|
Parameter | Description |
---|---|
Range for Table Boundary (Including Header) |
|
Range for Data Cells |
|
Parameter | Description |
---|---|
Start Range |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
SpreadSheetId |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Other App Integration scenarios for Google Sheets
Other Connectors for Python
Download Google Sheets Connector for Python
Documentation
How to connect Google Sheets in Python?
How to get Google Sheets data in Python?
How to read Google Sheets data in Python?
How to load Google Sheets data in Python?
How to import Google Sheets data in Python?
How to pull Google Sheets data in Python?
How to push data to Google Sheets in Python?
How to write data to Google Sheets in Python?
How to POST data to Google Sheets in Python?
Call Google Sheets API in Python
Consume Google Sheets API in Python
Google Sheets Python Automate
Google Sheets Python Integration
Integration Google Sheets in Python
Consume real-time Google Sheets data in Python
Consume realtime Google Sheets API data in Python
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 Python
Load Google Sheets in Python
Load Google Sheets data in Python
Read Google Sheets data in Python
Google Sheets API Call in Python