SSIS Google Sheets Connector

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
You can use this connector to integrate REST API data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

Video Tutorial - Read Google Sheets data in SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Google Sheets integration in SSIS
  • How to configure connection for Google Sheets
  • How to Read data from Google Sheets
  • Features about SSIS API Source
  • Using Google Sheets Connector in SSIS

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 the API Source to extract data from the Google Sheets.

  1. Prerequisite: you must have downloaded and installed SSIS PowerPack. Check Getting started section for more information.

  2. Begin with opening Visual Studio and creating new SSIS package Project.

  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox.
    SSIS Data Flow Task - Drag and Drop

  4. Double click on the Data Flow Task to see Data Flow designer.

  5. From the SSIS toolbox drag and drop API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. 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
    Google Sheets Connector Selection

  8. 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.

    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):

    1. Go to Google API Console.
    2. From the Project Dropdown (usually found at the top bar) click Select Project.
    3. On the Project Popup click CREATE PROJECT.
    4. 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).
    5. Click ENABLE APIS AND SERVICES.
    6. Now we need to Enable two APIs one by one (Sheets API and Drive API).
    7. Search Sheets. Select and click ENABLE.
    8. Search Drive. Select and click ENABLE.
    9. Go back to the main screen of the Google API Console
    10. Click the OAuth Consent Screen tab. Enter necessary details and Save.
    11. Click the Credentials tab.
    12. Click CREATE CREDENTIALS (some where in topbar) and select OAuth Client ID option.
    13. 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.
    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...
    ZappySys OAuth Connection
    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)
    1. Go to Google API Console
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. On Project Propup click CREATE PROJECT
    4. Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
    5. Click ENABLE APIS AND SERVICES
    6. Now we need to Enable two APIs one by one (Sheets API and Drive API).
    7. Search Sheets. Select and click ENABLE
    8. 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)
    1. Go to Create Service Account
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. Enter Service account name and Service account description
    4. 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).
    1. In the Cloud Console, click the email address for the service account that you created.
    2. Click Keys.
    3. Click Add key, then click Create new key.
    4. Click Create and select P12 format. A P12 key file is downloaded to your computer. We will use this file in our API connection.
    5. Click Close.
    6. 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.
    1. 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).
    2. Create or select an existing Google Sheet.
    3. Navigate to Sheet for which you like to give read/write access to Service Account.
    4. 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...
    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...
    ZappySys OAuth Connection

  9. 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
    API Source - Select Endpoint

  10. That's it; we are done. In a few clicks we configured the call to Google Sheets using ZappySys Google Sheets Connector

Load Google Sheets data in SQL Server using Upsert Destination (Insert or Update)

Once you read data from the desired source, now let's see how to Load Google Sheets data in SQL Server using Upsert Destination. Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.

  1. From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface

  2. Connect our Source component to Upsert Destination

  3. Double click on Upsert Destination component to configure it.

  4. Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS

  5. Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
    SSIS SQL Upsert option

  6. Click on OK to save Upsert Destination settings UI.

  7. That's it; we are done. Run the SSIS Package and it will read the data from the Google Sheets and load the the data in the SQL Server/PostgreSql/Redshift.

Video Tutorial - Write or lookup data to Google Sheets using SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Google Sheets integration in SSIS
  • How to configure connection for Google Sheets
  • How to Write or lookup data to Google Sheets
  • Features about SSIS API Destination
  • Using Google Sheets Connector in SSIS

How to write or lookup data to Google Sheets in SSIS (Import data)

In upper section we learned how to read data, now in this section we will learn how to configure Google Sheets in the API Source to Post data to the Google Sheets.

  1. Prerequisite: you must have downloaded and installed SSIS PowerPack. Check Getting started section for more information.

  2. Firstly, open Visual Studio and create a new SSIS Package Project.

  3. Now, drag and drop SSIS Data Flow Task from SSIS Toolbox.
    SSIS Data Flow Task - Drag and Drop

  4. Double click on the Data Flow Task to see Data Flow Designer view.

  5. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  6. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  7. Select New Connection to create a new connection:

    API Destination - 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
    API Destination - New Connection

  8. 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
    Google Sheets Connector Selection

  9. 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.

    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):

    1. Go to Google API Console.
    2. From the Project Dropdown (usually found at the top bar) click Select Project.
    3. On the Project Popup click CREATE PROJECT.
    4. 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).
    5. Click ENABLE APIS AND SERVICES.
    6. Now we need to Enable two APIs one by one (Sheets API and Drive API).
    7. Search Sheets. Select and click ENABLE.
    8. Search Drive. Select and click ENABLE.
    9. Go back to the main screen of the Google API Console
    10. Click the OAuth Consent Screen tab. Enter necessary details and Save.
    11. Click the Credentials tab.
    12. Click CREATE CREDENTIALS (some where in topbar) and select OAuth Client ID option.
    13. 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.
    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...
    ZappySys OAuth Connection
    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)
    1. Go to Google API Console
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. On Project Propup click CREATE PROJECT
    4. Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
    5. Click ENABLE APIS AND SERVICES
    6. Now we need to Enable two APIs one by one (Sheets API and Drive API).
    7. Search Sheets. Select and click ENABLE
    8. 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)
    1. Go to Create Service Account
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. Enter Service account name and Service account description
    4. 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).
    1. In the Cloud Console, click the email address for the service account that you created.
    2. Click Keys.
    3. Click Add key, then click Create new key.
    4. Click Create and select P12 format. A P12 key file is downloaded to your computer. We will use this file in our API connection.
    5. Click Close.
    6. 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.
    1. 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).
    2. Create or select an existing Google Sheet.
    3. Navigate to Sheet for which you like to give read/write access to Service Account.
    4. 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...
    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...
    ZappySys OAuth Connection

  10. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - 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
    API Destination - Select Endpoint

  11. Finally, map the the desired columns:

    API Destination - 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
    API Destination - Columns Mapping

  12. That's it; we successfully configured the POST API Call. In a few clicks we configured the Google Sheets API call using ZappySys Google Sheets Connector

Conclusion

In this article we discussed how to connect to Google Sheets in SSIS and integrate data without any coding. Click here to Download Google Sheets Connector for SSIS 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).

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. 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

Other Connectors for SSIS


Documentation 

  • How to connect Google Sheets in SSIS?

  • How to get Google Sheets data in SSIS?

  • How to read Google Sheets data in SSIS?

  • How to load Google Sheets data in SSIS?

  • How to import Google Sheets data in SSIS?

  • How to pull Google Sheets data in SSIS?

  • How to push data to Google Sheets in SSIS?

  • How to write data to Google Sheets in SSIS?

  • How to POST data to Google Sheets in SSIS?

  • Call Google Sheets API in SSIS

  • Consume Google Sheets API in SSIS

  • Google Sheets SSIS Automate

  • Google Sheets SSIS Integration

  • Integration Google Sheets in SSIS

  • Consume real-time Google Sheets data in SSIS

  • Consume realtime Google Sheets API data in SSIS

  • 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 SSIS

  • Load Google Sheets in SSIS

  • Load Google Sheets data in SSIS

  • Read Google Sheets data in SSIS

  • Google Sheets API Call in SSIS