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

詳情請參閱授權指南。