スプレッドシートから 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
詳しくは、認可ガイドをご覧ください。