Method: documents.batchUpdate

Aplica uma ou mais atualizações ao documento.

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. Outras solicitações não precisam retornar informações. Elas retornam uma resposta vazia. A ordem das respostas corresponde à das solicitações.

Por exemplo, suponha que você chame batchUpdate com quatro atualizações e apenas a terceira retorne informações. A resposta teria duas respostas vazias, a resposta à terceira solicitação e outra resposta vazia, nessa ordem.

Como outros usuários podem estar editando o documento, ele pode não refletir exatamente suas alterações. Elas podem ser alteradas em relação às mudanças feitas pelo colaborador. Se não houver colaboradores, o documento vai refletir suas mudanças. De qualquer forma, as atualizações na sua solicitação são aplicadas atomicamente em conjunto.

Solicitação HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

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

Parâmetros de caminho

Parâmetros
documentId

string

O ID do documento a ser atualizado.

Corpo da solicitação

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

Representação JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campos
requests[]

object (Request)

Uma lista de atualizações para aplicar ao documento.
writeControl

object (WriteControl)

Fornece controle sobre como as solicitações de gravação são executadas.

Corpo da resposta

Mensagem de resposta de uma solicitação documents.batchUpdate.

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

Representação JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campos
documentId

string

O ID do documento 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.
writeControl

object (WriteControl)

O controle de gravação atualizado após a aplicação da solicitação.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

WriteControl

Fornece controle sobre como as solicitações de gravação são executadas.

Representação JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Campos
Campo de união control. Determina a revisão do documento em que será gravada e como a solicitação vai se comportar se essa revisão não for a atual do documento. Se nenhum campo for especificado, as atualizações serão aplicadas à revisão mais recente. control pode ser apenas de um dos tipos a seguir:
requiredRevisionId

string

O revision ID opcional do documento em que a solicitação de gravação é aplicada. Se essa não for a revisão mais recente do documento, a solicitação não será processada e retornará um erro 400 de solicitação inválida.

Quando um ID de revisão obrigatório é retornado em uma resposta, ele indica o ID de revisão do documento após a solicitação ter sido aplicada.
targetRevisionId

string

O revision ID de destino opcional do documento em que a solicitação de gravação é aplicada.

Se as mudanças de colaborador tiverem ocorrido após a leitura do documento usando a API, as mudanças produzidas por essa solicitação de gravação serão aplicadas às mudanças do colaborador. Isso resulta em uma nova revisão do documento que incorpora as alterações dos colaboradores e as alterações na solicitação, e o servidor do Documentos resolve as alterações conflitantes. Ao usar o ID da revisão de destino, o cliente da API pode ser considerado outro colaborador do documento.

O ID da revisão de destino só pode ser usado para gravar em versões recentes de um documento. Se a revisão de destino estiver muito atrás da revisão mais recente, a solicitação não será processada e retornará um erro 400 de solicitação inválida. Tente novamente após recuperar a versão mais recente do documento. Normalmente, um ID de revisão permanece válido para uso como revisão por vários minutos após a leitura, mas para documentos editados com frequência, essa janela pode ser menor.