Method: spreadsheets.values.batchUpdate

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 ValueRanges.

Solicitud HTTP

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

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 (ValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Campos
valueInputOption

enum (ValueInputOption)

Cómo se deben interpretar los datos de entrada

data[]

object (ValueRange)

Los nuevos valores que se aplicarán a la hoja de cálculo.

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 para escribir es mayor que el rango realmente escrito, la respuesta incluye todos los valores en el rango solicitado (excluyendo las filas y columnas vacías finales).

responseValueRenderOption

enum (ValueRenderOption)

Determina cómo se deben renderizar los valores de 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 predeterminada de renderización 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 (UpdateValuesResponse)
    }
  ]
}
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

Se actualizó la cantidad total de celdas.

totalUpdatedSheets

integer

Cantidad total de hojas en las que se actualizó al menos una celda de la hoja.

responses[]

object (UpdateValuesResponse)

Una UpdateValuesResponse por rango solicitado, en el mismo orden en que aparecieron las solicitudes.

Alcances 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.