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

詳情請參閱授權指南