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, a solicitação inteira falhará e nada será aplicado.

Algumas solicitações têm replies para fornecer informações sobre como elas são aplicadas. As respostas vão ser semelhantes às solicitações. Por exemplo, se você aplicar quatro atualizações e a terceira tiver uma resposta, ela terá duas respostas vazias, a real e outra vazia, nessa ordem.

Devido à natureza colaborativa das planilhas, não é possível garantir que elas refletirão exatamente as alterações após a conclusão, mas é garantido que as atualizações na solicitação serão aplicadas em conjunto atomicamente. Suas alterações podem ser alteradas com relação às alterações dos colaboradores. Se não houver colaboradores, a planilha deverá refletir suas 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 na qual 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 das atualizações que serão aplicadas à planilha. As solicitações serão aplicadas na ordem em que forem especificadas. Se alguma solicitação não for válida, nenhuma solicitação será aplicada.
includeSpreadsheetInResponse

boolean

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

string

Limita os intervalos incluídos na planilha de respostas. Relevante apenas se includeSpreadsheetInResponse for "verdadeiro".
responseIncludeGridData

boolean

Verdadeiro se for necessário retornar dados de grade. Relevante apenas se includeSpreadsheetInResponse for "verdadeiro". Esse parâmetro será ignorado se uma máscara de campo tiver sido definida na solicitação.

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

string

A planilha à qual as atualizações foram aplicadas.
replies[]

object (Response)

A resposta das atualizações. Ele mapeia 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 foram aplicadas. Isso só 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.