Method: spreadsheets.values.clear

スプレッドシートから値をクリアします。呼び出し元は、スプレッドシート ID と範囲を指定する必要があります。値のみがクリアされ、セルの他のすべてのプロパティ(書式設定、データの入力規則など)は保持されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
spreadsheetId

string

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

range

string

消去する値の A1 表記または R1C1 表記

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

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

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

JSON 表現
{
  "spreadsheetId": string,
  "clearedRange": string
}
フィールド
spreadsheetId

string

更新が適用されたスプレッドシート。

clearedRange

string

消去された範囲(A1 表記)。(制限なしの範囲またはシートの境界よりも大きい Ranger のリクエストがあった場合、これはシートの制限内でクリアされた実際の範囲になります)。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

詳細については、承認ガイドをご覧ください。