スプレッドシートから 1 つ以上の値の範囲をクリアします。呼び出し元は、スプレッドシート ID と 1 つ以上の範囲を指定する必要があります。クリアされるのは値のみです。セルの他のすべてのプロパティ(書式設定やデータの入力規則など)は保持されます。
HTTP リクエスト
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClear
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
spreadsheetId |
更新するスプレッドシートの ID。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "ranges": [ string ] } |
フィールド | |
---|---|
ranges[] |
消去する範囲(A1 表記または R1C1 表記)。 |
レスポンスの本文
スプレッドシート内の値の範囲をクリアしたときのレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
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
詳細については、承認ガイドをご覧ください。