Google Sheets Connector
Documentation
Version: 6
Documentation

Authentication :: User Account [OAuth]


Description

No description available [API Help..]

Instructions

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

Parameters

Parameter Label Required Options Description Help
UseCustomApp UseCustomApp YES Use your own app credentials or inbuilt app provided by ZappySys for ease of use. If you choose UseCustomApp=true then make sure to obtain your own ClientId and Secret using steps provided (Click [Steps to Configure] link found next to Authentication Type dropdown)
ClientId ClientId NO
ClientSecret ClientSecret NO
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 see 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
ReturnUrl Redirect URL (Only for Web App) NO
Option Value
https://zappysys.com/oauth/ https://zappysys.com/oauth/
Only specifiy this if you have created Credential as Web Application rather than Desktop. In Desktop App you dont have to supply Return URL (its always localhost). When you keep this blank it uses default value http://localhost:[some_random_port_each_time] for redirect_url)