Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.
HTTP request
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClear
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
spreadsheetId
|
The ID of the spreadsheet to update. |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "ranges" : [ string ] } |
| Fields | |
|---|---|
ranges[]
|
The ranges to clear, in A1 notation or R1C1 notation . |
Response body
The response when clearing a range of values in a spreadsheet.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "spreadsheetId" : string , "clearedRanges" : [ string ] } |
| Fields | |
|---|---|
spreadsheetId
|
The spreadsheet the updates were applied to. |
clearedRanges[]
|
The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/drive -
https://www.googleapis.com/auth/drive.file -
https://www.googleapis.com/auth/spreadsheets
For more information, see the Authorization guide .
