Google Sheets ReadRange

Google Sheets ReadRange

Certified

Read a range from a spreadsheet

Reads a specific A1 range with render options. Can return data or store to kestra://; metrics report row count.

yaml
type: io.kestra.plugin.googleworkspace.sheets.ReadRange
yaml
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
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

Spreadsheet ID

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
DefaultFORMATTED_STRING
Possible Values
SERIAL_NUMBERFORMATTED_STRING

Date/time render option

SERIAL_NUMBER or FORMATTED_STRING (default); ignored if valueRender=FORMATTED_VALUE

Defaultfalse

Fetch results

If true, data is returned in output; otherwise written to storage

Defaulttrue

Treat first row as header

When true, maps rows to objects using first row keys; default true

Range

A1 notation range (e.g., Sheet1!A1: D10); required

Default120

The read timeout for the request (in seconds)

SubTypestring
Default["https://www.googleapis.com/auth/spreadsheets"]

The GCP scopes to used

The GCP service account key

Defaulttrue

Store results

If true, writes ION file to storage; default true

DefaultUNFORMATTED_VALUE
Possible Values
FORMATTED_VALUEUNFORMATTED_VALUEFORMULA

Value render option

FORMATTED_VALUE, UNFORMATTED_VALUE (default), or FORMULA

Fetched rows

Only when fetch=true

Default0

Rows fetched

Formaturi

Stored result URI

Only when store=true

Unitcount

Number of rows fetched across all sheets

More Plugins in this Category

Firecrawl
Firecrawl

Tasks that scrape and crawl websites into clean, LLM-ready content with Firecrawl.

Data

2 tasks

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

8 blueprints