SheetBaseInstall

Summary

Perform spreadsheet operations on Google Sheets either via a public URL in Simple mode or through a secured Google Apps Script backend API in Advanced mode. Supports actions such as reading sheet data, searching, appending, updating, deleting rows, managing sheets, and webhook registration.

Inputs

• mode (required) — Choose between Simple mode (reads public Google Sheets by URL with optional keyword filtering) and Advanced mode (full API operations via secured Apps Script backend).
• sheetUrl (required) — In Simple mode, the public Google Sheet URL to read as CSV.
• simpleQuery — Optional case-insensitive keyword to filter results in Simple mode.
• simpleReturn (required) — In Simple mode, choose the return style: matching cells, matching rows, or all rows raw.
• includeFullRow (required) — In Simple mode, whether to include the entire row object alongside matches.
• simpleLimit (required) — Maximum number of items to return in Simple mode.
• action (required) — In Advanced mode, select the backend operation such as get sheet data, search, append rows, update row, delete row, set cell, create or delete sheet, manage webhooks, and others.
• sheet — In Advanced mode, the Google Sheet tab name for most read/write actions (case-sensitive).
• q — Keyword for the Search action in Advanced mode.
• limit — Row limit for read/search/monitoring operations in Advanced mode.
• offset — Row offset (pagination) for read/search operations in Advanced mode.
• rows — For append and update operations in Advanced mode: JSON string or array of rows (objects or arrays).
• row — Row number for update or delete row actions in Advanced mode (1-based, header is 1).
• updates — For Update Row in Advanced mode: partial JSON updates mapping column names to new values.
• rowCell — Row index for Set Cell action in Advanced mode.
• colCell — Column index for Set Cell action in Advanced mode.
• valueCell — Value to write for Set Cell action in Advanced mode.
• newSheetName (required) — Name for creating a new sheet in Advanced mode.
• columns — Optional header columns when creating a new sheet in Advanced mode.
• confirmName — Confirmation text (sheet name) required to delete a sheet in Advanced mode.
• webhookUrl — Webhook URL for register/unregister webhook actions in Advanced mode.
• secret — Optional secret token sent as Authorization bearer header for webhook registration in Advanced mode.
• options — Additional flags in Advanced mode, including whether to include coordinates in responses, bypass cache, and set a global offset for pagination.

Output shape

a list of JSON objects representing results or status per input item.

Outputs JSON objects that vary depending on mode and action. Simple mode returns success status, headers, data rows or matches, with count metadata. Advanced mode returns action-specific JSON data or arrays of objects. Errors include success=false and error message. Pagination is supported by limit and offset parameters where applicable.

Examples

Example 1: Simple mode reading a public sheet URL and getting matching rows for a keyword.

mode='simple', sheetUrl='public_sheet_url', simpleQuery='mouse', simpleReturn='rows', includeFullRow=true, simpleLimit=50

Example 2: Advanced mode appending rows to a named sheet with API key.

mode='advanced', action='appendrows', sheet='Products', rows='[{"ID":"P101","Name":"Keyboard","Price":49.99}]', with SheetBase API credentials set.