Method: spreadsheets.values.clear

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 request

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}:clear

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
spreadsheetId

string

The ID of the spreadsheet to update.
range

string

The A1 notation or R1C1 notation of the values to clear.

Request body

The request body must be empty.

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,
  "clearedRange": string
}
Fields
spreadsheetId

string

The spreadsheet the updates were applied to.
clearedRange

string

The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual range that was 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.