Visão geral da API Google Docs

A API Google Docs permite criar e modificar arquivos no Documentos Google.

Os aplicativos podem ser integrados à API Docs para criar documentos refinados usando dados fornecidos pelo usuário e pelo sistema. Com a API Docs, é possível:

  • 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 se referem a um documento e pode ser derivada do URL do documento. Os 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. Os elementos de nível superior de um documento incluem Body, DocumentStyle e List.

Documento do Google Workspace

Um arquivo criado por um app do Google Workspace, como o app Documentos Google. O formato do tipo MIME dos Documentos é application/vnd.google-apps.document. Veja uma lista de tipos MIME em Tipos MIME compatíveis com o Google Workspace e o Google Drive.

Índice

A maioria dos elementos no corpo do conteúdo tem as propriedades startIndex e endIndex. Eles indicam o deslocamento do início e do fim de um elemento em relação ao início do segmento dele.

Imagem inline

Uma imagem que aparece no fluxo de texto dentro de um documento. Não é um anexo.

Intervalo nomeado

Um intervalo contíguo de texto. Um NamedRange é uma coleção de intervalos com o mesmo namedRangeId. Os intervalos nomeados permitem que os desenvolvedores associem partes de um documento a um rótulo arbitrário definido pelo usuário para que o conteúdo possa ser lido ou editado de modo programático mais tarde. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas cada um tem um ID exclusivo.

Segment

O Body, Header, Footer ou Footnote que contém elementos estruturais ou de conteúdo. Os índices dos elementos de um segmento são relativos ao início dele.

Sugestão

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