Method: spreadsheets.batchUpdate

Aplica una o más actualizaciones a la hoja de cálculo.

Cada request se valida antes de aplicarse. Si alguna solicitud no es válida, fallará toda la solicitud y no se aplicará nada.

Algunas solicitudes tienen replies para brindarte información sobre cómo se aplican. Las respuestas duplicarán las solicitudes. Por ejemplo, si aplicaste 4 actualizaciones y la tercera tuvo una respuesta, la respuesta tendrá 2 respuestas vacías, la respuesta real y otra respuesta vacía, en ese orden.

Debido a la naturaleza colaborativa de las hojas de cálculo, no podemos garantizar que estas reflejen exactamente los cambios una vez finalizado este proceso. Sin embargo, podemos garantizar que las actualizaciones de la solicitud se aplicarán juntas automáticamente. Es posible que tus cambios se modifiquen con respecto a los cambios del colaborador. Si no hay colaboradores, la hoja de cálculo debe reflejar los cambios.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
spreadsheetId

string

La hoja de cálculo a la que se aplicarán las actualizaciones.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
Campos
requests[]

object (Request)

Lista de actualizaciones que se aplicarán a la hoja de cálculo. Las solicitudes se aplicarán en el orden en que se especifiquen. Si alguna solicitud no es válida, no se aplicará ninguna solicitud.

includeSpreadsheetInResponse

boolean

Determina si la respuesta de actualización debe incluir el recurso de hoja de cálculo.

responseRanges[]

string

Limita los rangos incluidos en la hoja de cálculo de respuesta. Es significativo solo si includeSpreadsheetInResponse es “true”.

responseIncludeGridData

boolean

Es verdadero si se deben mostrar los datos de cuadrícula. Es significativo solo si includeSpreadsheetInResponse es “true”. Este parámetro se ignora si se configuró una máscara de campo en la solicitud.

Cuerpo de la respuesta

La respuesta para la actualización por lotes de 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,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
Campos
spreadsheetId

string

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

replies[]

object (Response)

La respuesta de las actualizaciones. Esto asigna 1:1 con las actualizaciones, aunque las respuestas a algunas solicitudes pueden estar vacías.

updatedSpreadsheet

object (Spreadsheet)

La hoja de cálculo después de la aplicación de las actualizaciones. Esto solo se establece si BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response es true.

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.