Este guia apresenta 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.
Invoque 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. Elas 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 maneira específica para a linguagem.
Métodos de solicitação
A API Docs oferece suporte aos seguintes métodos:
documents.create: crie um arquivo do Documentos Google em branco.documents.get: retorna uma instância completa do documento especificado. Você pode analisar o JSON retornado para extrair o conteúdo, a formatação e outros recursos do documento.documents.batchUpdate: envia uma lista de solicitações de edição para aplicar 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, do qual você pode ler o
documentId. Para mais informações sobre documentId, consulte o 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 é processada 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 será malsucedida e nenhuma das alterações (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
da resposta que
contém uma lista de objetos
response. Outras solicitações não precisam retornar informações e mostrar uma resposta
vazia. Os objetos na lista de resposta ocupam a mesma ordem de índice que a
solicitação correspondente.
Este é um padrão comum para fazer solicitações em lote:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Consulte as práticas recomendadas de solicitação em lote para ver 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. Veja abaixo os detalhes 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