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
詳しくは、認可ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-03-22 UTC。
[null,null,["最終更新日 2025-03-22 UTC。"],[],[],null,["# Method: spreadsheets.values.batchClear\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchClearValuesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nClears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.\n\n### HTTP request\n\n`POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClear`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|-----------------------------------------------|\n| `spreadsheetId` | `string` The ID of the spreadsheet to update. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------|\n| ``` { \"ranges\": [ string ] } ``` |\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `ranges[]` | `string` The ranges to clear, in [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). |\n\n### Response body\n\nThe response when clearing a range of values in a spreadsheet.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------|\n| ``` { \"spreadsheetId\": string, \"clearedRanges\": [ string ] } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `spreadsheetId` | `string` The spreadsheet the updates were applied to. |\n| `clearedRanges[]` | `string` The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `https://www.googleapis.com/auth/drive.file`\n- `https://www.googleapis.com/auth/spreadsheets`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]