Skip to main content

Write Google Sheets

Synopsis​

This operator writes a data table to a Google Sheets spreadsheet.

Description​

The operator can be used to either append values to the end of of a sheet or to update cells with new data values. Furthermore, it allows to add new sheets to the given spreadsheet.

When using the append mode, Google Sheets will automatically find the last non-empty row in the sheet and insert the new values below. Please take note that the new data need not match the format of the existing data in the sheet.

When using the update mode, Google Sheets will insert the new values starting at the position provided by the user and optionally blank all subsequent cells. By default, the operator will write to the first cell in the sheet and blank subsequent cells, effectively overwriting the entire sheet. Both the start position and the blanking behavior can be configured in the advanced parameters of the operator.

By default, date and time columns will be converted to their corresponding types in Google Sheets using the time zone of the spreadsheet. Custom time zones can be configured in the advanced parameters of the operator.

Input​

input​

Tha data table to write to Google Sheets.

Output​

through​

Pass through of the input data table.

Parameters​

Connection entry​

This parameter is used to specify a repository location that represents a connection entry.

Spreadsheet id​

The id of the Google Sheets spreadsheet. The id is part of the spreadsheet URL.

Sheet​

The name of the sheet to write to.

Create sheet if missing​

Whether to create a new sheet if no sheet with the given name exists in the spreadsheet.

Write column names​

Whether to write the column names as first row.

Mode​

Specifies whether to append the data to the given sheet or update the given sheet.

Start column​

The column to start the update from (zero-indexed, update mode only).

Start row​

The row to start the update from (zero-indexed, update mode only).

Blank cells​

Whether to blank subsequent cells (update mode only).

Time zone​

The time zone used for converting Google Sheets calendar types to RapidMiner date time types (instants of time without a time zone). By default the operator will use the time zone specified in the spreadsheet. However, this time zone can be overridden in case the user input does not match the spreadsheet settings.

Request timeout​

Specifies how long to wait for the Google Sheets API to respond to a request (in seconds).