Solicitações e respostas

Este guia apresenta os principais métodos de solicitação e resposta que compõem os API Google Docs e como atualizar um documento em lotes.

Você pode invocar a API Google Docs usando uma solicitação HTTP ou um 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, a as respostas são retornadas de uma forma específica da linguagem.

Métodos de solicitação

A API Docs é compatível com os seguintes métodos:

  • documents.create: crie um documento em branco no Documentos Google.
  • documents.get: retorna um 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 para aplicar de forma atômica ao documento e retorne uma lista de resultados.

Os métodos documents.get e documents.batchUpdate exigem um documentId. como parâmetro para especificar o documento de destino. Método documents.create retorna uma instância do documento criado, a partir do qual é possível ler o documentId. Para mais informações sobre documentId, consulte ID do documento.

Atualizações em lote

O documents.batchUpdate pega uma lista de Objetos request, cada um especificando uma única solicitação a ser executada. Por exemplo, formate um parágrafo e adicionar uma imagem inline. Cada solicitação é validada antes de ser aplicada, e o 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 falhará e nenhuma das (possivelmente dependentes) serão aplicadas.

Alguns métodos documents.batchUpdate fornecem respostas com informações sobre as solicitações aplicadas. Esses métodos retornam uma resposta corpo que contém uma lista de response objetos. Outras solicitações não precisam retornar informações e exibir uma resposta responder. Os objetos na lista de resposta ocupam a mesma ordem de índice que o 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 mais detalhes sobre como agrupar as chamadas da API Docs e documents.batchUpdate documentação de referência 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. Aqui está um detalhamento tipos de solicitação, agrupados em em diferentes categorias.

Objeto ADICIONAR / INSERIR ATUALIZAR / SUBSTITUIR EXCLUIR
Texto InsertTextRequest ReplaceAllTextRequest
Estilos CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
Intervalos nomeados CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
Imagens InsertInlineImageRequest ReplaceImageRequest
Tabelas InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
Objetos de página (incluindo cabeçalhos e rodapés) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest