Method: spreadsheets.values.batchClear

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
spreadsheetId

string

更新するスプレッドシートの ID。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "ranges": [
    string
  ]
}
フィールド
ranges[]

string

クリアする範囲の A1 表記または R1C1 表記。

レスポンスの本文

スプレッドシートで値の範囲をクリアしたときのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

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