Method: spreadsheets.values.batchClearByDataFilter

スプレッドシートから 1 つ以上の値の範囲をクリアします。詳細については、メタデータの読み取り、書き込み、検索をご覧ください。

呼び出し元は、スプレッドシート ID と 1 つ以上の DataFilters を指定する必要があります。指定したデータフィルタのいずれかに一致する範囲はクリアされます。値のみがクリアされ、セルの他のすべてのプロパティ（書式設定、データ検証など）は保持されます。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

詳しくは、承認ガイドをご覧ください。