Method: spreadsheets.values.batchClear
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Borra uno o más rangos de valores de una hoja de cálculo. El llamador debe especificar el ID de la hoja de cálculo y uno o más rangos. Solo se borran los valores; se conservan todas las demás propiedades de la celda (como el formato y la validación de datos).
Solicitud HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClear
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
spreadsheetId |
string
Es el ID de la hoja de cálculo que se actualizará.
|
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
| Representación JSON |
{
"ranges": [
string
]
} |
| Campos |
ranges[] |
string
Los rangos que se borrarán, en notación A1 o notación R1C1.
|
Cuerpo de la respuesta
Es la respuesta cuando se borra un rango de valores en una hoja de cálculo.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
| Representación JSON |
{
"spreadsheetId": string,
"clearedRanges": [
string
]
} |
| Campos |
spreadsheetId |
string
La hoja de cálculo a la que se aplicaron las actualizaciones.
|
clearedRanges[] |
string
Los rangos que se borraron, en notación A1. Si las solicitudes son para un rango no limitado o un rango mayor que los límites de la hoja, estos son los rangos reales que se borraron, limitados a los límites de la hoja.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.filehttps://www.googleapis.com/auth/spreadsheets
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-03-22 (UTC)
[null,null,["Última actualización: 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)."]]
