Method: spreadsheets.values.batchClearByDataFilter

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. 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:batchClearByDataFilter

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
spreadsheetId

string

The ID of the spreadsheet to update.

Request body

The request body contains data with the following structure:

JSON representation
{
  "dataFilters": [
    {
      object(DataFilter)
    }
  ],
}
Fields
dataFilters[]

object(DataFilter)

The DataFilters used to determine which ranges to clear.

Response body

If successful, the response body contains data with the following structure:

The response when clearing a range of values selected with DataFilters in a spreadsheet.

JSON representation
{
  "spreadsheetId": string,
  "clearedRanges": [
    string
  ],
}
Fields
spreadsheetId

string

The spreadsheet the updates were applied to.

clearedRanges[]

string

The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.)

Authorization

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 Auth Guide.

Send feedback about...