Method: spreadsheets.values.batchUpdateByDataFilter

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

string

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 (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Campos
valueInputOption

enum (ValueInputOption)

Cómo se deben interpretar los datos de entrada
data[]

object (DataFilterValueRange)

Los nuevos valores que se aplicarán a la hoja de cálculo. Si el DataFilter especificado coincide más de un rango, los valores especificados se aplican a todos esos rangos.
includeValuesInResponse

boolean

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 updatedData dentro de cada BatchUpdateValuesResponse.responses contiene los valores actualizados. Si el rango que se debe escribir era mayor que el rango realmente escrito, la respuesta incluye todos los valores del rango solicitado (excluyendo las filas y columnas vacías finales).
responseValueRenderOption

enum (ValueRenderOption)

Determina cómo se deben renderizar los valores en la respuesta. La opción de renderización predeterminada es FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Determina cómo se deben renderizar las fechas, las horas y las duraciones en la respuesta. Se ignora si responseValueRenderOption es FORMATTED_VALUE. La opción de renderización predeterminada de dateTime es SERIAL_NUMBER.

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 (UpdateValuesByDataFilterResponse)
    }
  ]
}
Campos
spreadsheetId

string

La hoja de cálculo a la que se aplicaron las actualizaciones.
totalUpdatedRows

integer

La cantidad total de filas en las que se actualizó al menos una celda de la fila.
totalUpdatedColumns

integer

La cantidad total de columnas en las que se actualizó al menos una celda de la columna.
totalUpdatedCells

integer

Cantidad total de celdas actualizadas.
totalUpdatedSheets

integer

La cantidad total de hojas en las que se actualizó al menos una celda de la hoja.
responses[]

object (UpdateValuesByDataFilterResponse)

Se actualizó la respuesta para cada rango.

Alcances de autorización

Se necesita uno de los siguientes alcances 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 (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Campos
dataFilter

object (DataFilter)

Es el filtro de datos que describe la ubicación de los valores en la hoja de cálculo.
majorDimension

enum (Dimension)

Es la dimensión principal de los valores.
values[]

array (ListValue format)

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, los valores existentes en los rangos coincidentes no se verán afectados.

UpdateValuesByDataFilterResponse

Es la respuesta cuando se actualiza un rango de valores mediante un filtro de datos en una hoja de cálculo.

Representación JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Campos
updatedRange

string

Es el rango (en notación A1) al que se aplicaron las actualizaciones.
updatedRows

integer

La cantidad de filas en las que se actualizó al menos una celda de la fila.
updatedColumns

integer

La cantidad de columnas en las que se actualizó al menos una celda de la columna.
updatedCells

integer

La cantidad de celdas actualizadas.
dataFilter

object (DataFilter)

Indica el filtro de datos que seleccionó el rango que se actualizó.
updatedData

object (ValueRange)

Son los valores de las celdas en el rango que coinciden con dataFilter después de aplicar todas las actualizaciones. Esto solo se incluye si el campo includeValuesInResponse de la solicitud era true.