Google Sheets Connector
Google Sheets Connector Help
Version 4
ZappySys Logo File Version: v4
Supported Engine: 9

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. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the 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
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and 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