How to read data from Google Sheets in SSIS (Export data)

In this section we will learn how to configure and use Google Sheets Connector in API Source to extract data from Google Sheets.

Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
In the new SSIS project screen you will find the following:
1. SSIS ToolBox on left side bar
2. Solution Explorer and Property Window on right bar
3. Control flow, data flow, event Handlers, Package Explorer in tab windows
4. Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
Select New Connection to create a new connection:
Use a preinstalled Google Sheets Connector from Popular Connector List or press Search Online radio button to download Google Sheets Connector. Once downloaded simply use it in the configuration:

Google Sheets

Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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. Later on you can use this information now to configure Connection with UseCustomApp=true.
NOTE: If you are planning to use your current data connection/token for automated processes, we recommend that you use a generic account for token generation when the login box appears (e.g. sales_automation@mycompany.com instead of bob_smith@mycompany.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 fail. Another potentially unwanted effect of using a personal token is incorrect logging; the API calls (e.g. Read, Edit, Delete, Upload) made with that token will record the specific user as performing the calls instead of an automated process.
Go to OAuth Consent Screen tab. Under Publishing Status click PUBLISH APP to ensure your refresh token doesnt expire often. If you planning to use App for Private use then do not have to worry about Verification Status after Publish.

Google Sheets

User Account [OAuth]

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

Required Parameters
UseCustomApp	Fill in the parameter...
Default SpreadSheetId	Fill in the parameter...
Optional Parameters
ClientId	Fill in the parameter...
ClientSecret	Fill in the parameter...
Scope	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...
Redirect URL (Only for Web App)	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)

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...
Default SpreadSheetId	Fill in the parameter...
Optional Parameters
Scope	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...

Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

API Source - 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
That's it! We are done! Just in a few clicks we configured the call to Google Sheets using Google Sheets Connector.

You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)