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 reflejarán las solicitudes. Por ejemplo, si aplicaste 4 actualizaciones y la tercera tiene una respuesta, la respuesta tendrá 2 respuestas vacías, la respuesta real y otra vacía, en ese orden.

Debido a la naturaleza colaborativa de las hojas de cálculo, no se garantiza que la hoja de cálculo reflejará exactamente los cambios una vez que se complete, pero sí se garantiza que las actualizaciones de la solicitud se aplicarán juntas de forma atómica. Es posible que se modifiquen tus cambios con respecto a los cambios de los colaboradores. Si no hay colaboradores, la hoja de cálculo debería 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)

Es una lista de actualizaciones que se pueden aplicar a la hoja de cálculo. Las solicitudes se aplicarán en el orden en que se especifican. Si alguna solicitud no es válida, no se aplicará ninguna.

includeSpreadsheetInResponse

boolean

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

responseRanges[]

string

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

responseIncludeGridData

boolean

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

Cuerpo de la respuesta

La respuesta de 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)

Es la respuesta de las actualizaciones. Esto se asigna de forma individual con las actualizaciones, aunque las respuestas a algunas solicitudes pueden estar vacías.

updatedSpreadsheet

object (Spreadsheet)

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

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