Method: spreadsheets.values.batchClearByDataFilter

清除电子表格中的一个或多个值范围。调用方必须指定电子表格 ID 以及一个或多个 DataFilters。与任何指定数据过滤器匹配的范围将被清除。只有值会被清除,而单元格的所有其他属性(如格式设置和数据验证等)会保留下来。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

要更新的电子表格的 ID。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
字段
dataFilters[]

object (DataFilter)

DataFilters 用于确定要清除的范围。

响应正文

清除电子表格中使用 DataFilters 选择的一系列值时的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "spreadsheetId": string,
  "clearedRanges": [
    string
  ]
}
字段
spreadsheetId

string

应用更新所应用到的电子表格。

clearedRanges[]

string

已清除的范围(采用 A1 表示法)。如果请求是针对无界限范围或大于工作表边界的,则此为实际清除的范围(以工作表的限制为准)。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

有关详情,请参阅授权指南