Visão geral da API Google Docs

A API Google Docs permite criar e modificar documentos nos Documentos Google.

Os aplicativos podem se integrar à API Docs para criar documentos de dados fornecidos pelo usuário e pelo sistema. Com a API Docs, você:

  • Automatizar os processos
  • Criar documentação em massa
  • Formatar documentos
  • Gerar faturas ou contratos
  • Recuperar atributos específicos de objetos

Esta é uma lista de termos comuns usados na API Docs:

ID do documento

O identificador exclusivo de um documento. É uma string específica que contém letras, números e alguns caracteres especiais que fazem referência a um documento e ela pode ser derivada do URL do documento. IDs de documentos são estáveis, mesmo se o nome do documento mudar. Para mais informações sobre como encontrar o ID, consulte ID do documento.

https://docs.google.com/document/d/DOCUMENT_ID/edit
Elemento

A estrutura que compõe um documento. Elementos de nível superior de um documento incluem o Body, DocumentStyle e List.

Documento do Google Workspace

Um arquivo criado por um aplicativo do Google Workspace, como o app Documentos. O formato MIME para o Google Docs é application/vnd.google-apps.document: Para obter uma lista de tipos MIME, consulte O Google Workspace e o Google Drive são compatíveis com os tipos MIME.

Índice

A maioria dos elementos no corpo do conteúdo tem startIndex e endIndex. propriedades. Elas indicam o deslocamento do início e do fim de um elemento, em relação ao início do segmento que o contém.

Imagem inline

Uma imagem que aparece no fluxo de texto de um documento. Não se trata de um anexo.

Intervalo nomeado

Um intervalo contíguo de texto. Um NamedRange é um coleção de intervalos com o mesmo namedRangeId. Com os intervalos nomeados, que os desenvolvedores associem partes de um documento a um elemento arbitrário para que o conteúdo possa ser lido ou editado programaticamente mais tarde. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas todos o intervalo nomeado tem um ID exclusivo.

Segment

Os métodos Body, Header, Footer ou Footnote contendo elementos estruturais ou de conteúdo. Os índices dos elementos em um segmento são relativos ao início desse segmento.

Sugestão

Altera um documento sem alterar o texto original. Se o proprietário aprovar suas sugestões, elas substituirão o texto original.