スプレッドシートから 1 つ以上の値の範囲をクリアします。呼び出し元は、スプレッドシート ID と 1 つ以上の DataFilters
を指定する必要があります。指定したデータフィルタのいずれかに一致する範囲はクリアされます。クリアされるのは値のみです。セルのその他すべてのプロパティ(書式設定やデータの入力規則など)は保持されます。
HTTP リクエスト
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
spreadsheetId |
更新するスプレッドシートの ID。 |
リクエスト本文
リクエストの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"dataFilters": [
{
object ( |
フィールド | |
---|---|
dataFilters[] |
クリアする範囲を決定するために使用される |
レスポンスの本文
スプレッドシートで DataFilters
で選択された値の範囲をクリアしたときのレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "spreadsheetId": string, "clearedRanges": [ string ] } |
フィールド | |
---|---|
spreadsheetId |
更新が適用されたスプレッドシート。 |
clearedRanges[] |
クリアされた範囲(A1 表記)。制限なしの範囲またはシートの境界よりも大きい範囲に対するリクエストの場合、これは実際の範囲で、シートの上限に制限されます。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
詳しくは、認可ガイドをご覧ください。