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 3ª tenía 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 se garantiza que la hoja de cálculo refleje exactamente tus cambios después de que se complete esta acción, pero sí se garantiza que las actualizaciones de la solicitud se aplicarán juntas de forma atómica. Es posible que tus cambios se modifiquen en relación con los cambios de los colaboradores. Si no hay colaboradores, la hoja de cálculo debería reflejar tus 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

Parámetros
spreadsheetId

string

Es la hoja de cálculo en 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,
  "commentsViewMode": enum (CommentsViewMode)
}
Campos
requests[]

object (Request)

Es una 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.
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. Solo tiene sentido si includeSpreadsheetInResponse es "verdadero".
responseIncludeGridData

boolean

Es verdadero si se deben devolver los datos de la cuadrícula. Solo tiene sentido si includeSpreadsheetInResponse es "verdadero". Este parámetro se ignora si se estableció una máscara de campo en la solicitud.
commentsViewMode

enum (CommentsViewMode)

Es el modo de vista de comentarios que se aplicará a la hoja de cálculo. Esto permite ver la hoja de cálculo con los comentarios omitidos o incluidos. Si no se especifica uno, se usa COMMENTS_VIEW_MODE_OMITTED. Solo tiene sentido si includeSpreadsheetInResponse es "verdadero".

Cuerpo de la respuesta

Es 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)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
Campos
spreadsheetId

string

Es la hoja de cálculo en la que se aplicaron las actualizaciones.
replies[]

object (Response)

Es la respuesta de las actualizaciones. Esto se correlaciona 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 que se aplicaron las actualizaciones. Solo se establece si BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response es true.
commentUpdateState

enum (CommentUpdateState)

Indica si se aplicaron actualizaciones de comentarios en la solicitud por lotes.

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.

CommentUpdateState

Es el estado de las actualizaciones de comentarios en la solicitud por lotes.

Enums
COMMENT_UPDATE_STATE_UNSPECIFIED No se especifica el estado de las actualizaciones de comentarios.
NO_UPDATES_REQUESTED No se solicitaron actualizaciones de comentarios en la solicitud por lotes.
ALL_SAVED Todas las actualizaciones de comentarios solicitadas se aplicaron en la solicitud por lotes.
ALL_FAILED_UNKNOWN_REASON No se pudieron realizar todas las actualizaciones de comentarios solicitadas.