Google Sheets Connector
Version: 5

Authentication :: Service Account (Using Private Key File) [OAuth]


No description available [API Help..]


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

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


Parameter Label Required Options Description Help
ClientId Service Account Email YES This is service account email ID (e.g.
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
Scope Scope NO
SpreadSheetId Default SpreadSheetId YES
Option 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.
TabName Default Tab Name (i.e. Sheet1) NO Enter default tab name for spreadsheet Id you supplied. If you keep it blank then it will use first tab by default.
RetryMode RetryMode NO
RetryStatusCodeList RetryStatusCodeList NO
RetryCountMax RetryCountMax NO