Visão geral da API Google Docs

A API Google Docs permite criar e modificar documentos no app Documentos Google.

Os aplicativos podem ser integrados à API Docs para criar documentos aprimorados com dados fornecidos pelo usuário e pelo sistema. Com a API Docs, você pode fazer o seguinte:

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

Confira a seguir 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 pode ser derivada do URL do documento. Os IDs de documentos são estáveis, mesmo que o nome do documento mude. 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 os Documentos Google. O formato de tipo MIME para documentos é application/vnd.google-apps.document. Para conferir uma lista de tipos MIME, consulte 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 que o contém.

Imagem inline

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

Intervalo nomeado

Um intervalo contíguo de texto. Uma 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 mais tarde de forma programática. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas cada intervalo nomeado tem um ID exclusivo.

Segment

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

Sugestão

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