Read
type: "io.kestra.plugin.googleworkspace.sheets.Read"
Read all sheets from a google Sheets
Examples
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
dateTimeRender
- Type: string
- Dynamic: ❌
- Required: ✔️
- Default:
FORMATTED_STRING
- Possible Values:
SERIAL_NUMBER
FORMATTED_STRING
How dates, times, and durations should be represented in the output.
his is ignored if valueRender is
FORMATTED_VALUE
. More details here
spreadsheetId
- Type: string
- Dynamic: ✔️
- Required: ✔️
The spreadsheet unique id
valueRender
- Type: string
- Dynamic: ❌
- Required: ✔️
- Default:
UNFORMATTED_VALUE
- Possible Values:
FORMATTED_VALUE
UNFORMATTED_VALUE
FORMULA
Determines how values should be rendered in the output.
More details here
fetch
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether to Fetch the data from the query result to the task output
header
- Type: boolean
- Dynamic: ❓
- Required: ❌
- Default:
true
Specifies if the first line should be the header (default: false)
readTimeout
- Type: integer
- Dynamic: ✔️
- Required: ❌
- Default:
120
The read timeout for the request (in seconds)
scopes
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
- Default:
[https://www.googleapis.com/auth/spreadsheets]
The GCP scopes to used
selectedSheetsTitle
- Type: array
- SubType: string
- Dynamic: ❓
- Required: ❌
The sheet title to be included
If not provided all the sheets will be included.
serviceAccount
- Type: string
- Dynamic: ✔️
- Required: ❌
The GCP service account key
store
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Whether to store the data from the query result into an ion serialized data file
Outputs
rows
- Type: object
- SubType: array
- Required: ❌
List containing the fetched data
Only populated if 'fetch' parameter is set to true. The key is the name of the sheet
size
- Type: integer
- Required: ❌
- Default:
0
The size of the rows fetch
uris
- Type: object
- SubType: string
- Required: ❌
The uri of store result
The keyOnly populated if 'store' is set to true. The key is the name of the sheet
Was this page helpful?