/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter

POST

spreadsheets

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://sheets.googleapis.com//v4/spreadsheets//values:batchClearByDataFilter' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dataFilters": [
        {
            "a1Range": "string",
            "developerMetadataLookup": {},
            "gridRange": {}
        }
    ]
}'

Response Example

{
    "clearedRanges": [
        "string"
    ],
    "spreadsheetId": "string"
}

Request

Path Params

spreadsheetId

string

required

The ID of the spreadsheet to update.

Body Params application/json

The request for clearing more than one range selected by a DataFilter in a spreadsheet.

dataFilters

array[object (DataFilter) {3}]

optional

The DataFilters used to determine which ranges to clear.

a1Range

string

optional

Selects data that matches the specified A1 range.

developerMetadataLookup

object

optional

gridRange

object

optional

Examples

Responses

🟢200Successful response

application/json

Body

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

clearedRanges

array[string]

optional

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.

spreadsheetId

string

optional

The spreadsheet the updates were applied to.

/v4/spreadsheets/{spreadsheetId}/values:batchClear

/v4/spreadsheets/{spreadsheetId}/values:batchGet