Google Workspace Read
CertifiedRead all sheets from a spreadsheet
Google Workspace Read
Read all sheets from a spreadsheet
Reads every sheet (or selected sheets) with render options. Can return data directly or store to kestra://; metrics report rows and sheet count.
type: io.kestra.plugin.googleworkspace.sheets.ReadExamples
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
Spreadsheet ID
dateTimeRender string
FORMATTED_STRINGSERIAL_NUMBERFORMATTED_STRINGDate/time render option
SERIAL_NUMBER or FORMATTED_STRING (default); ignored if valueRender=FORMATTED_VALUE
fetch booleanstring
falseFetch results
If true, data is returned in output; otherwise written to storage
header booleanstring
trueTreat first row as header
When true, maps rows to objects using first row keys; default true
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
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
Sheet titles to include
Optional list of sheet names; empty reads all sheets
serviceAccount string
The GCP service account key
store booleanstring
trueStore results
If true, writes ION file to storage; default true
valueRender string
UNFORMATTED_VALUEFORMATTED_VALUEUNFORMATTED_VALUEFORMULAValue render option
FORMATTED_VALUE, UNFORMATTED_VALUE (default), or FORMULA
Outputs
rows object
Fetched rows by sheet
Only when fetch=true; keyed by sheet title
size integer
0Total rows fetched
uris object
Stored result URIs
Only when store=true; keyed by sheet title
Metrics
rows counter
countNumber of rows fetched across all sheets
sheets counter
countNumber of sheets processed in the spreadsheet
