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 falhará e nada será aplicado.

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

Devido à natureza colaborativa das planilhas, não é possível garantir que a planilha refletirá exatamente suas alterações após a conclusão. No entanto, é garantido que as atualizações na solicitação serão aplicadas atomicamente em conjunto. Suas alterações podem ser alteradas de acordo com as alterações dos colaboradores. Se não houver colaboradores, a planilha refletirá as alterações.

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 a 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
}
Campos
requests[]

object (Request)

Uma lista de atualizações para aplicar à planilha. As solicitações serão aplicadas na ordem especificada. Se alguma solicitação for inválida, nenhuma solicitação 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 respostas. Relevante apenas se includeSpreadsheetInResponse for "true".
responseIncludeGridData

boolean

Verdadeiro se os dados da grade precisarem ser retornados. Relevante apenas se includeSpreadsheetInResponse for "true". Esse parâmetro será ignorado se uma máscara de campo tiver sido definida na solicitação.

Corpo da resposta

A resposta para 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)
  }
}
Campos
spreadsheetId

string

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

object (Response)

A resposta das atualizações. Isso é mapeado individualmente com as atualizações, embora as respostas a algumas solicitações possam estar vazias.
updatedSpreadsheet

object (Spreadsheet)

A planilha após as atualizações serem aplicadas. Isso só vai ser definido se BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response for true.

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.