Google Sheets Connector for PythonRead / 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 In this article you will learn how to quickly and efficiently integrate Google Sheets data in Python. We will use high-performance Google Sheets Connector to easily connect to Google Sheets and then access the data inside Python. Let's follow the steps below to see how we can accomplish that! Google Sheets Connector for Python 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 Sheets in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Google Sheets using Python we first need to create a DSN (Data Source) which will access data from Google Sheets. We will later be able to read data using Python. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
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.
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 Sheets credentials
Follow these steps on how to create Client Credentials (User Account principle) to authenticate and access Google Sheets 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 Cloud APIs
In this step we will enable Google Sheets API and Google Drive 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
sheets
and then locate and select Google Sheets API: -
Then enable Google Sheets API:
-
Again, repeat the step and enable Google Drive API as well:
- 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 useExternal
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.
-
Open your Google Sheets spreadsheet in the browser, e.g.:
https://docs.google.com/spreadsheets/d/1QM6WmGloHeGCliCqV3nEj8P-R1RbS59t5xJutN99rU/edit
. -
Extract the spreadsheet Id from the URL and copy it to the clipboard, e.g.
1QM6WmGloHeGCliCqV3nEj8P-R1RbS59t5xJutN99rU
. -
Go back to authentication configuration window and paste it into Default SpreadsheetId field.
-
Finally, click Test Connection to confirm the connection is working.
-
Done! Now you are ready to use Google Sheets Connector!
Fill in all required parameters and set optional parameters if needed:
GoogleSheetsDSNGoogle SheetsUser Account [OAuth]https://sheets.googleapis.com/v4/spreadsheetsRequired Parameters UseCustomApp Fill-in the parameter... Scope Fill-in the parameter... Default SpreadSheetId Fill-in the parameter... Optional Parameters ClientId ClientSecret Default Tab Name (i.e. Sheet1) RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 403|429 RetryCountMax 5 Redirect URL (Only for Web App) 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 Sheets credentials
Follow these steps on how to create Service Account to authenticate and access Google Sheets 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 Cloud APIs
In this step we will enable Google Sheets API and Google Drive 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
sheets
and then locate and select Google Sheets API: -
Then enable Google Sheets API:
-
Again, repeat the step and enable Google Drive API as well:
- 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 (JSON or P12 key file) 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 JSON (Engine v19+) or P12 option and hit CREATE button:
- Key file downloads into your machine. 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 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. *.json OR *.p12) field use downloaded certificate's file path.
-
Press Generate Token button to generate Access and Refresh Tokens.
-
Open your Google Sheets spreadsheet in the browser, e.g.:
https://docs.google.com/spreadsheets/d/1QM6WmGloHeGCliCqV3nEj8P-R1RbS59t5xJutN99rU/edit
. -
Extract the spreadsheet Id from the URL and copy it to the clipboard, e.g.
1QM6WmGloHeGCliCqV3nEj8P-R1RbS59t5xJutN99rU
. -
Go back to authentication configuration window and paste it into Default SpreadsheetId field.
-
Finally, click Test Connection to confirm the connection is working.
-
Done! Now you are ready to use Google Sheets Connector!
Fill in all required parameters and set optional parameters if needed:
GoogleSheetsDSNGoogle SheetsService Account [OAuth]https://sheets.googleapis.com/v4/spreadsheetsRequired Parameters Service Account Email Fill-in the parameter... Service Account Private Key Path (i.e. *.json OR *.p12) Fill-in the parameter... Default SpreadSheetId Fill-in the parameter... Optional Parameters Scope https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/spreadsheets Default Tab Name (i.e. Sheet1) RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 403|429 RetryCountMax 5 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 SheetsRead / write Google Sheets data inside your app, perform many Google Sheets operations without coding using easy to use high performance API Connector for Google SheetsGoogleSheetsDSN -
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 Python to retrieve data from Google Sheets. Hit OK button to use this query in the next step.
SELECT * FROM [Sheet1]
Some parameters configured in this window will be passed to the Google Sheets 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 datamuch 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 Python:
ZappySys API Driver - Google SheetsRead / write Google Sheets data inside your app, perform many Google Sheets operations without coding using easy to use high performance API Connector for Google SheetsGoogleSheetsDSNSELECT * FROM [Sheet1]
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Google Sheets 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 Sheets servers). -
Click OK to finish creating the data source.
Video Tutorial
Read data in Python
Using ODBC 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 id,title FROM products") row = cursor.fetchone() while row: print(row) row = cursor.fetchone() ##For loop example #for row in cursor: # print(row)
Using a full ODBC connection string
If you want to avoid being dependent on a DSN 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:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - Google SheetsRead / write Google Sheets data inside your app, perform many Google Sheets operations without coding using easy to use high performance API Connector for Google SheetsGoogleSheetsDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then in your Python code use Connection String when initializing OdbcConnection object, for example:
conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')
How to install `pyodbc` in the Python?
You would need to install pyodbc
in Python if you intend to establish connections to databases that support ODBC (Open Database Connectivity). This module facilitates communication between Python applications and various database management systems, enabling you to perform operations such as querying, retrieving data, and managing databases. Here's how you can install pyodbc
in Python:
Installation Steps:
Ensure you have Python installed on your system. If not, download it from the official Python website and follow the installation instructions.
Open your terminal or command prompt.
-
Use the following command to install
pyodbc
using pip, the Python package installer:python -m pip install "pyodbc"
Make sure you have a stable internet connection and the necessary permissions to install Python packages.
Reasons to Install:
- If pyodbc is not installed, your Python script will generate the following error:
"ModuleNotFoundError: No module named 'pyodbc'"
. Database Connectivity:
pyodbc
allows Python to connect to various databases that support ODBC, such as Microsoft SQL Server, PostgreSQL, MySQL, and more.Data Operations: It facilitates the execution of SQL queries, retrieval of data, and other database operations from within Python scripts.
Cross-Platform Support:
pyodbc
is designed to work across different operating systems, including Windows, macOS, and various Linux distributions.Simplicity and Efficiency: The module provides an intuitive interface for managing database transactions and connections, simplifying the process of working with databases in Python.
By installing pyodbc
, you can seamlessly integrate your Python applications with a wide range of ODBC-supported databases, enabling efficient and effective data management and analysis.
Actions supported by Google Sheets Connector
Learn how to perform common Google Sheets actions directly in Python with these how-to guides:
- Clear Sheet Values
- Create SpreadSheet Tab
- Delete Sheet Rows / Columns
- Delete SpreadSheet Tab
- Execute Command(s)
- Get Sheet Properties / Tab information
- Insert Sheet Data (Append at the end)
- Read Sheet Data
- Update Sheet Data (Overwrite Cells)
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Google Sheets in Python and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Google Sheets, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Google Sheets Connector for Python and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Google Sheets Connector for Python Documentation
More integrations
Other connectors for Python
Other application integration scenarios for Google Sheets
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 real-time 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