- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Solicitação
- ReplaceAllTextRequest
- SubstringMatchCriteria
- InsertTextRequest
- Local
- EndOfSegmentLocation
- UpdateTextStyleRequest
- CreateParagraphBulletsRequest
- BulletGlyphPreset (em inglês)
- DeleteParagraphBulletsRequest
- CreateNamedRangeRequest
- DeleteNamedRangeRequest
- UpdateParagraphStyleRequest
- DeleteContentRangeRequest
- InsertInlineImageRequest
- InsertTableRequest
- InsertTableRowRequest
- TableCellLocation
- InsertTableColumnRequest
- DeleteTableRowRequest
- DeleteTableColumnRequest
- InsertPageBreakRequest
- DeletePositionedObjectRequest
- UpdateTableColumnPropertiesRequest
- UpdateTableCellStyleRequest
- TableRange
- UpdateTableRowStyleRequest
- ReplaceImageRequest
- ImageReplaceMethod
- UpdateDocumentStyleRequest
- MergeTableCellsRequest
- UnmergeTableCellsRequest
- CreateHeaderRequest
- HeaderFooterType
- CreateFooterRequest
- CreateFootnoteRequest
- ReplaceNamedRangeContentRequest
- UpdateSectionStyleRequest
- InsertSectionBreakRequest
- DeleteHeaderRequest
- DeleteFooterRequest
- PinTableHeaderRowsRequest
- WriteControl
- Resposta
- ReplaceAllTextResponse
- CreateNamedRangeResponse
- InsertInlineImageResponse
- InsertInlineSheetsChartResponse
- CreateHeaderResponse
- CreateFooterResponse
- CreateFootnoteResponse
- Faça um teste
Aplica uma ou mais atualizações ao documento.
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. Outras solicitações não precisam retornar informações. Cada uma delas retorna uma resposta vazia. A ordem das respostas corresponde à das solicitações.
Por exemplo, suponha que você chame batchUpdate com quatro atualizações e somente a terceira retorna informações. A resposta teria duas respostas vazias, a da terceira solicitação e outra resposta vazia, nessa ordem.
Como outros usuários podem estar editando o documento, é possível que ele não reflita exatamente as suas alterações: as suas alterações podem ser alteradas em relação às alterações dos colaboradores. Se não houver colaboradores, o documento deverá refletir as alterações. De qualquer forma, as atualizações em sua solicitação serã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 |
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 ( |
Campos | |
---|---|
requests[] |
Uma lista de atualizações a serem aplicadas ao documento. |
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 ( |
Campos | |
---|---|
documentId |
O ID do documento ao qual as atualizações foram aplicadas. |
replies[] |
A resposta das atualizações. Isso mapeia individualmente as atualizações, embora as respostas a algumas solicitações possam estar vazias. |
writeControl |
O controle de gravação atualizado após aplicar a solicitação. |
Escopos de autorização
Requer um dos seguintes escopos de 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.
GravarControle
Fornece controle sobre como as solicitações de gravação são executadas.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união control . Determina a revisão do documento em que ela será gravada e como a solicitação vai se comportar se essa revisão não for a atual. 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 |
O Quando um código de revisão necessário é retornado em uma resposta, ele indica o código de revisão do documento depois que a solicitação é aplicada. |
targetRevisionId |
O destino opcional Se as alterações do colaborador tiverem ocorrido após o documento ter sido lido usando a API, as alterações produzidas por essa solicitação de gravação serão aplicadas às alterações do colaborador. Isso resulta em uma nova revisão do documento que incorpora as alterações do colaborador e as alterações na solicitação, com o servidor do Documentos Google resolvendo as alterações conflitantes. Ao usar o ID de revisão de destino, o cliente da API pode ser considerado outro colaborador do documento. O código de 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 em relação à revisão mais recente, a solicitação não será processada e retornará um erro de solicitação inválida 400. Tente recuperar a versão mais recente do documento. Normalmente, um código de revisão permanece válido para uso como uma revisão de destino por vários minutos após a leitura, mas para documentos editados com frequência, essa janela pode ser mais curta. |