- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- DataFilterValueRange
- UpdateValuesByDataFilterResponse
- Pruébalo
Establece valores en uno o más rangos de una hoja de cálculo. El llamador debe especificar el ID de la hoja de cálculo, un valueInputOption
y uno o más DataFilterValueRanges
.
Solicitud HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
spreadsheetId |
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 |
---|
{ "valueInputOption": enum ( |
Campos | |
---|---|
valueInputOption |
Indica cómo se deben interpretar los datos de entrada. |
data[] |
Los valores nuevos que se aplicarán a la hoja de cálculo. Si el |
includeValuesInResponse |
Determina si la respuesta de actualización debe incluir los valores de las celdas que se actualizaron. De forma predeterminada, las respuestas no incluyen los valores actualizados. El campo |
responseValueRenderOption |
Determina cómo se deben renderizar los valores en la respuesta. La opción de renderización predeterminada es |
responseDateTimeRenderOption |
Determina cómo se deben renderizar las fechas, las horas y las duraciones en la respuesta. Se ignora si |
Cuerpo de la respuesta
Es la respuesta cuando se actualiza 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,
"totalUpdatedRows": integer,
"totalUpdatedColumns": integer,
"totalUpdatedCells": integer,
"totalUpdatedSheets": integer,
"responses": [
{
object ( |
Campos | |
---|---|
spreadsheetId |
La hoja de cálculo a la que se aplicaron las actualizaciones. |
totalUpdatedRows |
Es la cantidad total de filas en las que se actualizó al menos una celda. |
totalUpdatedColumns |
Es la cantidad total de columnas en las que se actualizó al menos una celda. |
totalUpdatedCells |
Es la cantidad total de celdas actualizadas. |
totalUpdatedSheets |
Es la cantidad total de hojas en las que se actualizó al menos una celda. |
responses[] |
La respuesta de cada rango se actualizó. |
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
Para obtener más información, consulta la Guía de autorización.
DataFilterValueRange
Es un rango de valores cuya ubicación se especifica con un DataFilter
.
Representación JSON |
---|
{ "dataFilter": { object ( |
Campos | |
---|---|
dataFilter |
El filtro de datos que describe la ubicación de los valores en la hoja de cálculo. |
majorDimension |
Es la dimensión principal de los valores. |
values[] |
Los datos que se escribirán. Si los valores proporcionados superan cualquiera de los rangos que coincide con el filtro de datos, la solicitud fallará. Si los valores proporcionados son menores que los rangos coincidentes, solo se escriben los valores especificados, y los valores existentes en los rangos coincidentes no se ven afectados. |
UpdateValuesByDataFilterResponse
Es la respuesta que se obtiene cuando se actualiza un rango de valores con un filtro de datos en una hoja de cálculo.
Representación JSON |
---|
{ "updatedRange": string, "updatedRows": integer, "updatedColumns": integer, "updatedCells": integer, "dataFilter": { object ( |
Campos | |
---|---|
updatedRange |
Es el rango (en notación A1) al que se aplicaron las actualizaciones. |
updatedRows |
Es la cantidad de filas en las que se actualizó al menos una celda. |
updatedColumns |
Es la cantidad de columnas en las que se actualizó al menos una celda. |
updatedCells |
Es la cantidad de celdas actualizadas. |
dataFilter |
El filtro de datos que seleccionó el rango que se actualizó. |
updatedData |
Los valores de las celdas del rango que coincide con el filtro de datos después de aplicar todas las actualizaciones. Esto solo se incluye si el campo |