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

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