Method: spreadsheets.batchUpdate

Aplica uma ou mais atualizações à planilha.

Cada request é validado antes de ser aplicado. Se alguma solicitação não for válida, toda a solicitação vai falhar e nada será aplicado.

Algumas solicitações têm replies para dar informações sobre como elas são aplicadas. As respostas vão refletir as solicitações. Por exemplo, se você aplicou quatro atualizações e a terceira tinha uma resposta, a resposta vai ter duas respostas vazias, a resposta real e outra resposta vazia, nessa ordem.

Devido à natureza colaborativa das planilhas, não é garantido que a planilha reflita exatamente suas mudanças após a conclusão. No entanto, é garantido que as atualizações na solicitação serão aplicadas juntas de forma atômica. Suas mudanças podem ser alteradas em relação às mudanças do colaborador. Se não houver colaboradores, a planilha vai refletir suas mudanças.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
spreadsheetId

string

A planilha em que as atualizações serão aplicadas.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
Campos
requests[]

object (Request)

Uma lista de atualizações a serem aplicadas à planilha. As solicitações serão aplicadas na ordem em que forem especificadas. Se alguma solicitação não for válida, nenhuma será aplicada.
includeSpreadsheetInResponse

boolean

Determina se a resposta de atualização deve incluir o recurso de planilha.
responseRanges[]

string

Limita os intervalos incluídos na planilha de resposta. Só é relevante se includeSpreadsheetInResponse for "true".
responseIncludeGridData

boolean

Verdadeiro se os dados da grade devem ser retornados. Só é relevante se includeSpreadsheetInResponse for "true". Esse parâmetro será ignorado se uma máscara de campo tiver sido definida na solicitação.
commentsViewMode

enum (CommentsViewMode)

O modo de visualização de comentários a ser aplicado à planilha. Isso permite visualizar a planilha com ou sem comentários. Se nenhum for especificado, COMMENTS_VIEW_MODE_OMITTED será usado. Só é relevante se includeSpreadsheetInResponse for "true".

Corpo da resposta

A resposta para a atualização em lote de uma planilha.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
Campos
spreadsheetId

string

A planilha em que as atualizações foram aplicadas.
replies[]

object (Response)

A resposta das atualizações. Isso mapeia 1:1 com as atualizações, embora as respostas a algumas solicitações possam estar vazias.
updatedSpreadsheet

object (Spreadsheet)

A planilha após a aplicação das atualizações. Isso só será definido se BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response for true.
commentUpdateState

enum (CommentUpdateState)

Indica se as atualizações de comentários foram aplicadas na solicitação em lote.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Para mais informações, consulte o guia de autorização.

CommentUpdateState

O status das atualizações de comentários na solicitação em lote.

Tipos enumerados
COMMENT_UPDATE_STATE_UNSPECIFIED O status das atualizações de comentários não foi especificado.
NO_UPDATES_REQUESTED Nenhuma atualização de comentário foi solicitada na solicitação em lote.
ALL_SAVED Todas as atualizações de comentários solicitadas foram aplicadas na solicitação em lote.
ALL_FAILED_UNKNOWN_REASON Falha em todas as atualizações de comentários solicitadas.