Visão geral da API Google Docs

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

Os aplicativos podem se integrar à API Docs para criar documentos refinados com dados fornecidos pelo usuário e pelo sistema. A API Docs permite:

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

A seguir, confira 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 referenciam um documento e podem ser derivados do URL dele. 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 aplicativo do Google Workspace, como o Google Docs. O formato do tipo MIME para o Documentos é application/vnd.google-apps.document. Para 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. Elas indicam o deslocamento do início e do fim de um elemento, em relação ao início do segmento de inclusão.

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. A 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 programaticamente mais tarde. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas cada intervalo nomeado tem um ID exclusivo.

Segmento

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

Sugestão

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