Actions10
- Document Actions
- Sheet Within Document Actions
Sheet Within Document → Clear
AI-generatedSummary
Clear data from a specified sheet within a Google Sheets document, either the entire sheet or selected rows, columns, or ranges.
Inputs
- documentId (required) — Identifies the Google Sheets document to modify, selectable by list, URL, or ID.
- sheetName (required) — Specifies the sheet within the document to clear, selectable by list, URL, ID, or sheet name.
- clear (required) — Defines the range of cells to clear: whole sheet, specific rows, specific columns, or a custom range.
- keepFirstRow — When clearing the whole sheet, optionally keep the first row intact.
- startIndex — When clearing specific rows, the starting row number (1-based). When clearing specific columns, the start column (e.g., 'A').
- rowsToDelete — Number of rows to clear starting from startIndex (applicable when clearing specific rows).
- columnsToDelete — Number of columns to clear starting from startIndex (applicable when clearing specific columns).
- range — The A1 notation string for the specific range to clear (applicable when clearing a specific range).
Output shape
a single record containing the operation result status
The operation clears values in the specified range; the result indicates success or failure. No data is returned other than confirmation of clearing.