Read all sheets from a Google Sheet.

yaml
type: "io.kestra.plugin.googleworkspace.sheets.read"

yaml
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

Dynamic YES

The spreadsheet unique id

Dynamic YES

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

Dynamic NO

Default false

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

Dynamic NO

Default true

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

Dynamic NO

Default 120

The read timeout for the request (in seconds)

SubType string

Dynamic YES

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

The GCP scopes to used

SubType string

Dynamic YES

The sheet title to be included

If not provided all the sheets will be included.

Dynamic YES

The GCP service account key

Dynamic NO

Default true

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

Dynamic YES

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.

SubType array

List containing the fetched data

Only populated if 'fetch' parameter is set to true. The key is the name of the sheet.

Default 0

The size of the rows fetched

SubType string

The URI of the stored result

Only populated if 'store' is set to true. The key is the name of the sheet.