Read a range from a Google Sheet.

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

The spreadsheet unique id

Default FORMATTED_STRING

Possible Values

SERIAL_NUMBERFORMATTED_STRING

How 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

Default false

Whether to fetch the data from the query result to the task output

Default true

Specifies if the first line should be the header (default: false)

The range to select

Default 120

The read timeout for the request (in seconds)

SubType string

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

The GCP scopes to used

The GCP service account key

Default true

Whether to store the data from the query result into an ION-serialized data file

Default UNFORMATTED_VALUE

Possible Values

FORMATTED_VALUEUNFORMATTED_VALUEFORMULA

Determines how values should be rendered in the output

For more details, refer to the ValueRenderOption API.

List containing the fetched data

Only populated if 'fetch' parameter is set to true.

Default 0

The number of rows fetched

Format uri

The URI of the stored result

Only populated if 'store' is set to true.