Neste guia, apresentamos os principais métodos de solicitação e resposta que compõem a API Google Docs e como você pode atualizar um documento em lotes.
É possível invocar a API Google Docs usando uma solicitação HTTP ou uma invocação de método em uma biblioteca de cliente específica da linguagem. Esses são amplamente equivalentes.
A API Google Docs retorna uma resposta HTTP, que geralmente inclui o resultado da invocação da solicitação. Ao usar uma biblioteca de cliente para fazer solicitações, as respostas são retornadas de uma maneira específica da linguagem.
Métodos de solicitação
A API Docs é compatível com os seguintes métodos:
documents.create: crie um arquivo em branco do Documentos Google.documents.get: retorna uma instância completa do documento especificado. É possível analisar o JSON retornado para extrair o conteúdo, a formatação e outros recursos do documento.documents.batchUpdate: envie uma lista de solicitações de edição a serem aplicadas atomicamente ao documento e retorna uma lista de resultados.
Os métodos documents.get e documents.batchUpdate exigem um documentId
como parâmetro para especificar o documento de destino. O método documents.create
retorna uma instância do documento criado, em que é possível ler o
documentId. Para mais informações sobre documentId, consulte ID do
documento.
Atualizações em lote
O método documents.batchUpdate
usa uma lista de objetos
request, cada um
especificando uma única solicitação a ser executada. Por exemplo, formate um parágrafo
e adicione uma imagem inline. Cada solicitação é validada antes de ser aplicada e
as solicitações são processadas de acordo com a ordem em que aparecem na solicitação em lote.
Todas as solicitações na atualização em lote são aplicadas atomicamente. Ou seja, se alguma solicitação não for válida, toda a atualização não será concluída e nenhuma das mudanças (possivelmente dependentes) será aplicada.
Alguns métodos documents.batchUpdate fornecem respostas com informações sobre
as solicitações aplicadas. Esses métodos retornam um corpo
de resposta que
contém uma lista de objetos
response. Outras solicitações não precisam retornar informações e exibir uma resposta
vazia. Os objetos na lista de resposta ocupam a mesma ordem de índice que a
solicitação correspondente.
Um padrão popular para fazer solicitações em lote tem a seguinte aparência:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Consulte as práticas recomendadas de solicitações em lote para detalhes completos sobre como agrupar as chamadas da API Docs e a documentação de referência de documents.batchUpdate para tipos de solicitação e resposta.
Operações de atualização em lote
Há vários tipos de solicitações de atualização em lote. Confira abaixo um detalhamento dos tipos de solicitação agrupados em diferentes categorias.
Temas relacionados
- Estrutura de um arquivo do Documentos Google
- Regras e comportamento de edição estrutural
- Solicitações em lote