Google Sheets

Reads and writes Google Sheets data by using a Google service account connection.

Revision History

0.0.0.1 - 2026/05/20 - Initial release with spreadsheet discovery, workbook metadata, value read, value update, and append support.
0.0.0.3 - 2026/05/21 - Added bounded transient retry handling, hid internal connection-only settings from the designer, and improved pasted service-account private key handling.
0.0.0.4 - 2026/05/26 - Removed the legacy status, statusMessage, and errorMessage output fields and documented the normalized error detail fields now returned instead.

Connection

Use this connection to store the Google service-account settings used by all Google Sheets methods.

Property Type Description
Client Email String Google service-account email used for authentication.
Private Key Masked String Google service-account private key used to request access tokens.
Scopes String Space-delimited Google scopes used for supported spreadsheet and discovery operations.
Access Token Masked String Cached Google access token managed by the node at runtime.

Setup Notes

  • Use a Google service-account JSON key and copy its client_email and private_key values into the connection.
  • The connector accepts the private_key value exactly as copied from the Google JSON key, including JSON-style escaped newlines.
  • Share the target spreadsheets with the service-account email when you want the node to discover, read, or write them.
  • The default scopes support spreadsheet reads, spreadsheet writes, and Drive metadata-based spreadsheet discovery.
  • Connection test validates the configured credentials by calling Google Drive spreadsheet discovery.

Methods

The node exposes methods for spreadsheet discovery, workbook metadata, cell value reads, cell value updates, and row appends.

ListSpreadsheets

Lists spreadsheets that are visible to the configured service account.

Parameter Type Description
Connection Connection Google Sheets connection details including service-account credentials.
NameContains String Optional case-sensitive name filter used to narrow spreadsheet discovery.
Return Type Description
Spreadsheets Array One row per discovered spreadsheet, including normalized fields such as spreadsheetId, name, mimeType, and raw.

GetSpreadsheet

Gets workbook metadata for one spreadsheet.

Parameter Type Description
Connection Connection Google Sheets connection details including service-account credentials.
Request Object Metadata request containing SpreadsheetId and optional Ranges and IncludeGridData values.
Return Type Description
Spreadsheet Object One normalized workbook row including spreadsheetId, title, sheetCount, sheets, and raw.

GetValues

Reads one or more spreadsheet ranges and returns one output row per returned range item.

Parameter Type Description
Connection Connection Google Sheets connection details including service-account credentials.
Request Object Values request containing SpreadsheetId, Ranges, and optional MajorDimension, ValueRenderOption, and DateTimeRenderOption values. Ranges must contain at least one range.
Return Type Description
Rows Array One normalized row per returned inner array, including spreadsheetId, range, majorDimension, itemIndex, values, and raw.

UpdateValues

Updates one or more spreadsheet ranges.

Parameter Type Description
Connection Connection Google Sheets connection details including service-account credentials.
Request Object Update request containing SpreadsheetId, optional response settings, and Data with one or more range entries. Each range entry includes Range, optional MajorDimension, and Rows, where each row contains Values.
Return Type Description
Result Object One normalized result row including spreadsheetId, update counters such as updatedRows, updatedColumns, updatedCells, optional aggregate totals, and raw.

AppendValues

Appends rows to a spreadsheet range.

Parameter Type Description
Connection Connection Google Sheets connection details including service-account credentials.
Request Object Append request containing SpreadsheetId, Range, optional value and response settings, and Rows, where each row contains Values.
Return Type Description
Result Object One normalized result row including spreadsheetId, tableRange, update counters, nested updates, and raw.

Usage Notes

  • Success and failure outputs omit the status, statusMessage, and errorMessage fields.
  • Failure outputs return a normalized message field and include providerCode, providerStatus, providerReason, and httpStatusCode when that detail is available from Google or the HTTP layer.
  • ListSpreadsheets and GetValues return arrays because the node emits one business row per discovered spreadsheet or per returned value row.
  • GetSpreadsheet, UpdateValues, and AppendValues return one normalized wrapper object for the requested operation.

Known Issues

  • This v1 node is service-account-first and does not implement delegated end-user OAuth or domain-wide impersonation.
  • Live template discovery depends on the service account already having access to the target spreadsheets.
  • Structural workbook operations such as spreadsheets:batchUpdate, sheet creation, formatting, and protection management are not supported in this version.