Google Sheets

The Google Sheets component is a data component that allows users to connect to and interact with Google Sheets spreadsheets to read and write data. It can carry out the following tasks:

• Create Spreadsheet
• Delete Spreadsheet
• Add Sheet
• Delete Sheet
• Create Spreadsheet Column
• Delete Spreadsheet Column
• List Rows
• Lookup Rows
• Get Row
• Get Multiple Rows
• Insert Row
• Insert Multiple Rows
• Update Row
• Update Multiple Rows
• Delete Row
• Delete Multiple Rows

Release Stage

Alpha

Configuration

The component definition and tasks are defined in the definition.yaml and tasks.yaml files respectively.

Setup

In order to communicate with Google, the following connection details need to be provided. You may specify them directly in a pipeline recipe as key-value pairs within the component's setup block, or you can create a Connection from the Integration Settings page and reference the whole setup as setup: ${connection.<my-connection-id>}.

Supported Tasks

Create Spreadsheet

Create a new Google Sheets spreadsheet with multiple sheets.

Input Objects in Create Spreadsheet

Sheets

Configuration for sheets to create.

Field	Field ID	Type	Note
Headers	headers	array	Column headers for the sheet.
Sheet Name	name	string	Name of the sheet.

Delete Spreadsheet

Delete a Google Sheets spreadsheet.

Add Sheet

Add a new sheet to an existing Google Sheets spreadsheet.

Delete Sheet

Remove a sheet from a Google Sheets spreadsheet.

Create Spreadsheet Column

Add a new column to a Google Sheets spreadsheet.

Delete Spreadsheet Column

Delete a column from a Google Sheets spreadsheet.

List Rows

List all rows in a Google Sheets spreadsheet.

Output Objects in List Rows

Rows Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Lookup Rows

Find multiple rows based on column value in a Google Sheets spreadsheet.

Output Objects in Lookup Rows

Rows Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Get Row

Get a single row from a Google Sheets spreadsheet.

Output Objects in Get Row

Row Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Get Multiple Rows

Get multiple rows from a Google Sheets spreadsheet.

Output Objects in Get Multiple Rows

Rows Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Insert Row

Insert a single row into a Google Sheets spreadsheet.

Output Objects in Insert Row

Row Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Insert Multiple Rows

Insert multiple rows into a Google Sheets spreadsheet.

Output Objects in Insert Multiple Rows

Rows Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Update Row

Update a row in a Google Sheets spreadsheet.

Input Objects in Update Row

Row Data

Row data with row number and data.

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Output Objects in Update Row

Row Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Update Multiple Rows

Update multiple rows in a Google Sheets spreadsheet.

Input Objects in Update Multiple Rows

Rows Data

Multiple rows data with row numbers and data.

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Output Objects in Update Multiple Rows

Rows Data

Field	Field ID	Type	Note
Row Number	row-number	number	Row number to update (1-based index)
Row Data	row-value	json	Row data in JSON format where keys are column names and values are the corresponding cell values

Delete Row

Delete a row from a Google Sheets spreadsheet.

Delete Multiple Rows

Delete multiple rows from a Google Sheets spreadsheet.