Skip to main content

gsheets.getvaluesprops

Home > @runlightyear/gsheets > GetValuesProps

GetValuesProps interface

Signature:
interface GetValuesProps 

Required Properties

PropertyModifiersTypeDescription
rangestringThe A1 notation or R1C1 notation of the range to retrieve values from.
spreadsheetIdstringThe ID of the spreadsheet to retrieve data from.

Optional Properties

PropertyModifiersTypeDescription
dateTimeRenderOption?DateTimeRenderOptionHow dates, times, and durations should be represented in the output. This is ignored if valueRenderOption is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
majorDimension?Dimension

The major dimension that results should use.

For example, if the spreadsheet data in Sheet1 is: A1=1,B1=2,A2=3,B2=4, then requesting range=Sheet1!A1:B2?majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting range=Sheet1!A1:B2?majorDimension=COLUMNS returns [[1,3],[2,4]].

valueRenderOption?ValueRenderOptionHow values should be represented in the output. The default render option is FORMATTED_VALUE.