Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters
    ActiveCampaign
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Bing Search
    ConstantContact
    CouchbaseDB
    CSV
    DB (RDBMS)
    Dropbox
    Files
    Flight Aware
    FreshBooks
    FTP
    Geonames
    GoogleDrive
    GoogleSearch
    GoogleSheet
    GreenMile
    GpsInsight
    HttpEndpoint (REST)
    Intacct
    Insteon
    Loggly
    MailChimp
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    OneDrive
    OneDrive365 (Business)
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    Slack
    SQL Server
    SQLX
    Sudoku
    Teams
    Threading
    Twilio
    Twitter
    VellemanDMX
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/googlesheet




GoogleSheet


Allows you to read from and write to GoogleSheet documents.

Download the GoogleSheet configuration instructions

Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String accessToken The access token when not redirect to browser for authentication
String refreshToken The refresh token used when accessToken is expired
String clientID The client ID to be used for token generate and authenticate. When using OAuth, specifies the clientId
String clientSecret The Client Secret to be used for token generate and authenticate.
String spreadsheetId The spreadsheet id to be used for default value, if paramters is not provided in query
String headers The headers to be used when haders is not provided in sheet
Boolean hasHeaders Set to 1 if headers are expected by default False
String area sheet area to be used when location is not specified

Handlers



clearArea
This command should clear the area specified. details 

Arguments

Name Description Default
configName
sId 0
location

SQL Call

EXEC GoogleSheet.ClearArea 'config2',@sid='1791963987',@location='Sheet1!A4'


Http Call

/bsc/googlesheet/cleararea

Output Columns

This call does not return data.

createSpreadsheet
Spreadsheet
Use to create new spreadsheet details 

Arguments

Name Description Default
configName
title r

SQL Call

EXEC GoogleSheet.createSpreadsheet 'mainfnl'


Http Call

/bsc/googlesheet/createspreadsheet

Output Columns

String spreadSheetId
String title
defineArea
Use to define area in sheet details 

Arguments

Name Description Default
configName
configOverride
location

SQL Call

EXEC GoogleSheet.defineArea 'config2',@location='Sheet1!A2'


Http Call

/bsc/googlesheet/definearea

Output Columns

String outputoutput
deleteSheet
sheets
Use to delete the sheet details 

Arguments

Name Description Default
configName r
sheetId

SQL Call

EXEC GoogleSheet.deleteSheet 'config2',@sheetId='816331976'
DELETE from GoogleSheet.sheets where configName='config2' and sheetId='816331976'


Http Call

/bsc/googlesheet/deletesheet

Output Columns

String outputoutput
getSheets
sheets
Use to read sheets and return sheetId and sheetname details 

Arguments

Name Description Default
configName

SQL Call

EXEC GoogleSheet.getsheets
SELECT * FROM GoogleSheet.sheets where configName='config2'
SELECT * FROM GoogleSheet.[sheets@config2]


Http Call

/bsc/googlesheet/getsheets

Output Columns

String configName
String sheetId
String sheetName
insertArea
sheet
This command insert data to spreadsheet. details 

Arguments

Name Description Default
configName
data
location

SQL Call

EXEC GoogleSheet.insertarea 'config','','Sheet1!A1'
insert into GoogleSheet.sheet@config (name,age,status) values('jim1',29,'FS')


Http Call

/bsc/googlesheet/insertarea

Output Columns

This call does not return data.

insertSheet
sheets
Inserts a new sheet into the spreadsheet, using a default sheet name. details 

Arguments

Name Description Default
configName
title r

SQL Call

EXEC GoogleSheet.insertSheet 'Title1'


Http Call

/bsc/googlesheet/insertsheet

Output Columns

String outputoutput
listColumns
columns
Returns a list of columns defined for the spreadsheet. details 

Arguments

Name Description Default
configName

SQL Call

EXEC GoogleSheet.listColumns 
SELECT * FROM GoogleSheet.columns
SELECT * FROM GoogleSheet.[columns@config2]


Http Call

/bsc/googlesheet/listcolumns

Output Columns

String configName
String spId
String result
listSpreadsheets
files
Returns a list of spreadsheets from a folder location (default location: root) details 

Arguments

Name Description Default
configName
path

SQL Call

EXEC GoogleSheet.listSheets
SELECT * FROM GoogleSheet.files
SELECT * FROM GoogleSheet.[files@config2]


Http Call

/bsc/googlesheet/listspreadsheets

Output Columns

String path
String name
String spreadsheetId
overrideArea
overridesheet
This command override data to spreadsheet. details 

Arguments

Name Description Default
configName
data
location

SQL Call

EXEC GoogleSheet.overrideArea 'config2',@data='[{"name":"Alexandra1","age":32,"Hire Date":"1581323858","stateCode":"CA"},{"name":"Andrew","age":20,"Hire Date":"1581323881","stateCode":"SD"}]'


Http Call

/bsc/googlesheet/overridearea

Output Columns

This call does not return data.

readArea
sheet
Reads an area from a GoogleSheet details 

Arguments

Name Description Default
configName
area
headers
sheetIndex 0
sheetTitle
hasHeaders

SQL Call

EXEC GoogleSheet.readArea  @area='Sheet1!A1:C
SELECT a, d FROM GoogleSheet.sheet@configName WHERE b <> ''
SELECT a, d FROM GoogleSheet.[sheet@configName] WHERE b <> ''


Http Call

/bsc/googlesheet/readarea

Output Columns

This call does not return data.

readArea2
sheet2
Use to be read an area and return result in json or xml format details 

Arguments

Name Description Default
configName
area
headers
sheetIndex 0
sheetTitle
hasHeaders
outputType json

SQL Call

EXEC GoogleSheet.readArea2 'config2','Sheet1!A1'
SELECT * from GoogleSheet.sheet2 where configName='config2' and @location='Sheet1!A1'
SELECT * FROM GoogleSheet.[sheet2@config2] WHERE location='Sheet1!A1'


Http Call

/bsc/googlesheet/readarea2

Output Columns

String outputType
readProperties
properties
This command should read all the properties of spreadsheet. details 

Arguments

Name Description Default
configName
cols

SQL Call

EXEC GoogleSheet.readProperties 'config2','Title,SpreadSheetId'
SELECT * FROM GoogleSheet.properties where configName='config2' and cols='Title,SpreadSheetId'
SELECT * FROM GoogleSheet.[properties@config2] WHERE cols='Title,SpreadSheetId'


Http Call

/bsc/googlesheet/readproperties

Output Columns

This call does not return data.

updateSheet
sheets
use to update sheet title by passing sheet id and title details 

Arguments

Name Description Default
configName
sId r
title r

SQL Call

EXEC GoogleSheet.updateSheet ,'410617325','title1'
update GoogleSheet.sheets set title='title1' where configName= 'config2' and sId='1791963987'


Http Call

/bsc/googlesheet/updatesheet

Output Columns

String outputoutput
writeAreaObject
This command writes data to spreadsheet. details 

Arguments

Name Description Default
configName
data

SQL Call

EXEC GoogleSheet.writeAreaObject 'config2',@data='[{"name":"Alexandra1","age":32,"Hire Date":"1581323858","stateCode":"CA"},{"name":"Andrew","age":20,"Hire Date":"1581323881","stateCode":"SD"}]'


Http Call

/bsc/googlesheet/writeareaobject

Output Columns

This call does not return data.