sheets.spreadsheets.values.clear
Clear only the values in a specified spreadsheet range while keeping formatting, validation, and other cell properties intact; requires the spreadsheet ID and range.
Instructions
Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ClearValuesRequest object; pass it via params or whole via body_file Siblings over the same resource: append, batchClear, batchClearByDataFilter, batchGet, batchGetByDataFilter, batchUpdate, batchUpdateByDataFilter, get, update.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| range | Yes | [URL path segment] The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON ClearValuesRequest object. | |
| request_body | No | Request body of type ClearValuesRequest: pass it via `params` (merged into the built body) or whole via `body_file`. | |
| spreadsheetId | Yes | [URL path segment] The ID of the spreadsheet to update. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clearedRange | No | ||
| spreadsheetId | No |