Google Sheets Read
CertifiedRead all sheets from a spreadsheet
Google Sheets 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
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-googleworkspace --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
spreadsheetId *string
Spreadsheet ID
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150dateTimeRender 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
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
