Google Sheets

Provides integration with Google Sheets using a Google service account for spreadsheet discovery, metadata reads, value reads, value updates, and row appends.

Revision History

0.0.0.1 - Initial release with spreadsheet discovery, workbook metadata, value reads, value updates, and row appends.
0.0.0.3 - Improved retry handling, simplified the public Connection surface, and improved pasted service-account private-key handling.
0.0.0.4 - Removed the legacy status, statusMessage, and errorMessage output fields and added normalized error detail fields.

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 as the JWT issuer.
Private Key Masked Google service-account private key used to sign JWT assertions.
Scopes String Space-delimited scopes requested during service-account token minting.
Default Spreadsheet Id String Optional default spreadsheet ID used when preconfigured requests omit SpreadsheetId.
Default Sheet Title String Optional default sheet title used when preconfigured ranges omit an A1 sheet prefix.
Access Token Masked Cached access token minted from the Google service-account flow.

Setup Notes

  1. Use a Google service-account JSON key, then copy its client_email and private_key values into the Connection.
  2. Paste Private Key exactly as copied from the Google JSON key, including JSON-style escaped newlines when they are present.
  3. Share target spreadsheets with the service-account email when you want the Node to discover spreadsheets, expand templates, read values, or write values.
  4. Set Default Spreadsheet Id when you want requests to use a fallback spreadsheet target when SpreadsheetId is omitted.
  5. Set Default Sheet Title when you want ranges without an A1 sheet prefix to resolve automatically to a default sheet.
  6. Run the Connection's Test to validate the configured credentials with a lightweight Google Drive spreadsheet-discovery call.

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 fragment used to narrow spreadsheet discovery.
Return Type Description
Spreadsheets Array One row per discovered spreadsheet, including normalized fields such as spreadsheetId, name, mimeType, webViewLink, trashed, 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 metadata controls, such as Ranges and IncludeGridData.
Return Type Description
Spreadsheet Object One normalized workbook row including spreadsheetId, title, sheetCount, sheets, and raw.

GetValues

Reads one or more spreadsheet ranges and emits one normalized row per returned inner array.

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 include at least one range. MajorDimension defaults to ROWS.
Return Type Description
Rows Array One normalized row per returned inner array, including spreadsheetId, range, majorDimension, itemIndex, values, and raw.

UpdateValues

Updates spreadsheet values for one or more ranges.

Parameter Type Description
Connection Connection Google Sheets Connection details including service-account credentials.
Request Object Update request containing SpreadsheetId, ValueInputOption, optional response settings, and Data with one or more range entries. Each Data item includes Range, optional MajorDimension, and Rows, where each row contains Values. ValueInputOption defaults to RAW.
Return Type Description
Result Object One normalized result row including spreadsheetId, updatedRange, updatedRows, updatedColumns, updatedCells, aggregate totals, such as totalUpdatedRows, totalUpdatedColumns, totalUpdatedCells, totalUpdatedSheets, responses, and raw.

AppendValues

Appends rows to a spreadsheet table range.

Parameter Type Description
Connection Connection Google Sheets Connection details including service-account credentials.
Request Object Append request containing SpreadsheetId, Range, Rows, optional MajorDimension, and optional value and response settings. Each row contains Values. MajorDimension defaults to ROWS, ValueInputOption defaults to RAW, and InsertDataOption defaults to INSERT_ROWS.
Return Type Description
Result Object One normalized result row including spreadsheetId, tableRange, updatedRange, update counters, such as updatedRows, updatedColumns, and updatedCells, nested updates, and raw.

Usage Notes

  • 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.
  • Drive spreadsheet discovery handles pagination internally.
  • ListSpreadsheets and GetValues emit 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 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 currently supported.