Endpoint

Get Sheet Properties / Tab information

Name

get_sheet_properties

Description

Read read sheet properties (e.g. list of tabs on sheet and its properties) [API reference]

Related Tables

SheetDetails

Parameters

Parameter

Label

Required

Options

Description

SpreadSheetId

YES

Option	Value
Enter SpreadSheet Id
Example SpreadSheet Id	1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

If the column you are looking for is missing, consider customizing Google Sheets Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Google Sheets Connector in API Source component to read data or in API Destination component to read/write data:

Read from SheetDetails table using API Destination

This Endpoint belongs to SheetDetails table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Google Sheets

SheetDetails

Select, Lookup

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get sheet properties / tab information

SELECT * FROM get_sheet_properties
WITH
(
    "SpreadSheetId" = 'abcd-1234-spreadsheetid'
)

get_sheet_properties endpoint belongs to SheetDetails table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get sheet properties / tab information

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_sheet_properties
WITH
(
    "SpreadSheetId" = ''abcd-1234-spreadsheetid''
)';

EXEC (@MyQuery) AT [LS_TO_GOOGLE_SHEETS_IN_GATEWAY];

get_sheet_properties endpoint belongs to SheetDetails table(s), and can therefore be used via those table(s).