Google Sheets Connector
Documentation
Version: 8
Documentation

Authentication Service Account


Description

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]

Instructions

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:

  1. First of all, go to Google API Console.

  2. Then click Select a project button and then click NEW PROJECT button:

    Start creating a new project in Google Cloud
  3. Name your project and click CREATE button:

    Create a new project in Google Cloud
  4. Wait until the project is created:

    Wait until project is created in Google Cloud
  5. 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:

  1. Select your project on the top bar:

    Select project in Google Cloud
  2. Then click the "hamburger" icon on the top left and access APIs & Services:

    Access APIs and services in Google Cloud
  3. Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:

    Enable API for project in Google Cloud
  4. In the search bar search for sheets and then locate and select Google Sheets API:

    Search for API in Google Cloud
  5. Then enable Google Sheets API:

    Enable Google Sheets API
  6. Again, repeat the step and enable Google Drive API as well:

    Enable Google Drive API
  7. 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:

  1. First of all, go to IAM & Admin in Google Cloud console:

    Access IAM & Admin in Google Cloud
  2. Once you do that, click Service Accounts on the left side and click CREATE SERVICE ACCOUNT button:

    Start creating service account in Google Cloud
  3. Then name your service account and click CREATE AND CONTINUE button:

    Create service account in Google Cloud
  4. Continue by clicking Select a role dropdown and start granting service account Project Viewer roles:

    Start granting service account project roles in Google Cloud
  5. Find Project group and select Viewer role:

    Grant service account project viewer role
  6. Finish adding roles by clicking CONTINUE button:

    Finish granting service account project roles in Google Cloud
    You can always add or modify permissions later in IAM & Admin.
  7. Finally, in the last step, just click button DONE:

    Finish configuring service account in Google Cloud
  8. 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 (P12 certificate) to the created Service Account:

  1. In Service Accounts open newly created service account:

    Open service account in Google Cloud
  2. Next, copy email address of your service account for the later step:

    Copy service account email address in Google Cloud
  3. Continue by selecting KEYS tab, then press ADD KEY dropdown, and click Create new key menu item:

    Start creating key for service account in Google Cloud
  4. Finally, select P12 option and hit CREATE button:

    Create P12 key for service account in Google Cloud
  5. P12 certificate downloads into your machine. We have all the data needed for authentication, let's proceed to the last step!

Step-5: Configure connection

  1. 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. *.p12) field use downloaded certificate's file path.
  2. Press Generate Token button to generate Access and Refresh Tokens.

  3. Open your Google Sheets spreadsheet in the browser, e.g.: https://docs.google.com/spreadsheets/d/1QM6WmGloHeGCliCqV3nEj8P-R1RbS59t5xJutN99rU/edit.

  4. Extract the spreadsheet Id from the URL and copy it to the clipboard, e.g. 1QM6WmGloHeGCliCqV3nEj8P-R1RbS59t5xJutN99rU.

  5. Go back to authentication configuration window and paste it into Default SpreadsheetId field.

  6. Finally, click Test Connection to confirm the connection is working.

  7. Done! Now you are ready to use Google Sheets Connector!

Parameters

Parameter Label Required Default value Options Description
ClientId Service Account Email YES This is service account email ID (e.g. some_name@my_project.iam.gserviceaccount.com)
PrivateKeyPath Service Account Private Key Path (i.e. *.p12) YES File path for p12 file (i.e. Private Key file for service account). Keep this key file secure
SpreadSheetId Default SpreadSheetId YES
Name Value
Enter Your Sheet Id
Example Sheet Id 1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms
Enter default spreadsheet Id which should be used if user do not supply when calling various operations supported by this connector. To obtain sheet Id. Open spreadsheet in browser and check URL. You will example value like 1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms that is your sheet id.
Scope Scope https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/spreadsheets
TabName Default Tab Name (i.e. Sheet1) Enter default tab name for spreadsheet Id you supplied. If you keep it blank then it will use first tab by default.
RetryMode RetryMode RetryWhenStatusCodeMatch
RetryStatusCodeList RetryStatusCodeList 403|429
RetryCountMax RetryCountMax 5
ImpersonateAs Impersonate As (Enter Email Id)