ReadRange
Read a range from a Google Sheet.
type: "io.kestra.plugin.googleworkspace.sheets.ReadRange"Examples
id: googleworkspace_sheets_readrange
namespace: company.team
tasks:
- id: read_range
type: io.kestra.plugin.googleworkspace.sheets.ReadRange
spreadsheetId: "1Dkd3W0OQo-wxz1rrORLP7YGSj6EBLEg74fiTdbJUIQE"
range: "Second One!A1:I"
store: true
valueRender: FORMATTED_VALUE
Properties
spreadsheetId*Requiredstring
The spreadsheet unique id
dateTimeRenderstring
FORMATTED_STRINGSERIAL_NUMBERFORMATTED_STRINGHow dates, times, and durations should be represented in the output
This is ignored if valueRender is FORMATTED_VALUE.
For more details, refer to the DateTimeRenderOption API
fetchbooleanstring
falseWhether to fetch the data from the query result to the task output
headerbooleanstring
trueSpecifies if the first line should be the header (default: false)
rangestring
The range to select
readTimeoutintegerstring
120The read timeout for the request (in seconds)
scopesarray
["https://www.googleapis.com/auth/spreadsheets"]The GCP scopes to used
serviceAccountstring
The GCP service account key
storebooleanstring
trueWhether to store the data from the query result into an ION-serialized data file
valueRenderstring
UNFORMATTED_VALUEFORMATTED_VALUEUNFORMATTED_VALUEFORMULADetermines how values should be rendered in the output
For more details, refer to the ValueRenderOption API.
Outputs
rowsarray
List containing the fetched data
Only populated if 'fetch' parameter is set to true.
sizeinteger
0The number of rows fetched
uristring
uriThe URI of the stored result
Only populated if 'store' is set to true.
Metrics
rowscounter
countNumber of rows fetched across all sheets
