SheetBase AI ToolInstall

Summary

Access and manipulate Google Sheets data either by reading a public sheet URL (Simple Mode) or using a secured Apps Script backend API (Advanced Mode) with various actions like reading, searching, appending, updating, deleting rows, managing sheets, and webhooks.

Inputs

• mode (required) — Choose access method: 'simple' to read a public Google Sheet via URL without credentials, or 'advanced' to perform full database-like operations via secured Apps Script backend using an API key.
• sheetUrl (required) — In Simple Mode, provide a public Google Sheet URL; the node auto-converts it to a CSV export URL for reading.
• simpleQuery — In Simple Mode, an optional case-insensitive keyword to search across all cells. Leave empty to return unfiltered data.
• simpleReturn — In Simple Mode, choose result return style when a keyword is provided: matching individual cells, matching rows, or all rows raw.
• includeFullRow — In Simple Mode; if true, includes the full row data alongside match results.
• simpleLimit — In Simple Mode, maximum number of matching items to return.
• action (required) — In Advanced Mode, select the backend action to perform (e.g., ping, validateApiKey, list sheets, get data, search, append, update, delete rows/cells, manage sheets, and webhooks).
• sheet — In Advanced Mode, target sheet/tab name (case-sensitive) required for most read/write actions.
• q — In Advanced Mode, keyword for searching cells.
• limit — In Advanced Mode, max number of rows to return for read, search, or monitoring operations.
• offset — In Advanced Mode, number of rows to skip for pagination in reading and searching.
• rows — In Advanced Mode for append or update, JSON string representing an array of objects or 2D array of rows to add or update.
• row — Row number (1-based; header is 1) used for update or delete operations.
• updates — For updating a row partially, JSON string representing field-value pairs matching column headers.
• rowCell — Row index (1-based) of the single cell to set when using setcell action.
• colCell — Column index (1-based) of the cell to set when using setcell action.
• valueCell — Value to write to the cell at specified row and column.
• newSheetName (required) — For creating a new sheet, the unique name of the sheet to create.
• columns — Optional column headers for the new sheet as JSON array or comma-separated list.
• confirmName — Safety confirmation for deleting a sheet; must exactly match the sheet name.
• webhookUrl — URL to register or unregister for webhook events (create, update, delete).
• secret — Optional secret string sent as Authorization Bearer token with webhook requests.
• options.includeCoords — Advanced Mode option to include row and column coordinates in responses where applicable.
• options.bypassCache — Advanced Mode option to force fresh data reads by skipping backend caches.
• options.globalOffset — Advanced Mode option to apply additional offset to list or read operations for pagination support.

Output shape

a list of JSON objects representing the result of the chosen operation

In Simple Mode, returns a single JSON object with success status, mode, headers, data (matching cells, rows, or all rows), and counts according to search and return style. In Advanced Mode, returns one or multiple JSON objects per backend action response, including sheet data, status, or error information. Supports pagination via limit and offset parameters.

Examples

Example 1: Simple Mode reading public Google Sheet without credentials

Set Mode to 'Simple (Public URL)', provide a valid public Google Sheets URL, optionally set Search Keyword to filter cells, choose Return Style ('cells', 'rows', or 'all'), configure Include Full Row and Limit parameters. Nodes returns rows or cells matching criteria.

Example 2: Advanced Mode performing a sheet data read

Set Mode to 'Advanced (Apps Script API)', ensure valid API credentials are set, choose Action 'Get Sheet Data', specify the Sheet Name to read, and optionally set Limit and Offset for pagination. Returns header and rows data from the secured spreadsheet.