Read all sheets from a Google Sheet.
type: "io.kestra.plugin.googleworkspace.sheets.Read"Examples
id: googleworkspace_sheets_read
namespace: company.team
tasks:
- id: read
type: io.kestra.plugin.googleworkspace.sheets.Read
spreadsheetId: "1Dkd3W0OQo-wxz1rrORLP7YGSj6EBLEg74fiTdbJUIQE"
store: true
valueRender: FORMATTED_VALUE
Properties
spreadsheetId *Requiredstring
The spreadsheet unique id
dateTimeRender string
FORMATTED_STRINGSERIAL_NUMBERFORMATTED_STRINGHow dates, times, and durations should be represented in the output
his is ignored if valueRender is FORMATTED_VALUE.
For more details, refer to the DateTimeRenderOption API
fetch booleanstring
falseWhether to Fetch the data from the query result to the task output
header booleanstring
trueSpecifies if the first line should be the header (default: false)
readTimeout integerstring
120The read timeout for the request (in seconds)
scopes array
["https://www.googleapis.com/auth/spreadsheets"]The GCP scopes to used
selectedSheetsTitle array
The sheet title to be included
If not provided all the sheets will be included.
serviceAccount string
The GCP service account key
store booleanstring
trueWhether to store the data from the query result into an ION-serialized data file
valueRender string
UNFORMATTED_VALUEFORMATTED_VALUEUNFORMATTED_VALUEFORMULADetermines how values should be rendered in the output
For more details, refer to the ValueRenderOption API.
Outputs
rows object
List containing the fetched data
Only populated if 'fetch' parameter is set to true. The key is the name of the sheet.
size integer
0The size of the rows fetched
uris object
The URI of store result
The keyOnly populated if 'store' is set to true. The key is the name of the sheet.