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

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