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 elas são aplicadas. As respostas serão iguais às solicitações. Por exemplo, se você aplicou quatro atualizações e a terceira teve uma resposta, a resposta terá duas respostas vazias, a resposta real e outra resposta vazia, nessa ordem.

Devido à natureza colaborativa das planilhas, não é garantido que as planilhas refletirão exatamente as suas alterações após a conclusão, mas é garantido que as atualizações na solicitação serão aplicadas atomicamente juntas. Suas alterações podem ser alteradas em relação às alterações do colaborador. Se não houver colaboradores, a planilha deverá 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 à 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 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 solicitação será aplicada.

includeSpreadsheetInResponse

boolean

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

responseRanges[]

string

Limita os intervalos incluídos na planilha de respostas. Significativo somente se includeSpreadsheetInResponse for "true".

responseIncludeGridData

boolean

Verdadeiro se os dados da grade forem retornados. Significativo somente 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 à qual as atualizações foram aplicadas.

replies[]

object (Response)

A resposta das atualizações. Isso mapeia individualmente 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.

Escopos de autorização

Requer um dos seguintes escopos de 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.