Visão geral da API Google Docs
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Com a API Google Docs, você pode criar e modificar documentos no app.
Os aplicativos podem se integrar à API Docs para criar documentos refinados com dados fornecidos pelo usuário e pelo sistema. Com a API Docs, você pode:
- Automatizar os processos
- Criar documentação em massa
- Formatar documentos
- Gerar faturas ou contratos
- Recuperar atributos específicos de objetos
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 fazem referência a 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 Documentos Google.
O formato do tipo MIME para o Google Docs é
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. Eles indicam o ajuste do início e do fim de um elemento em relação ao início do segmento que o envolve.
- 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. Um NamedRange é uma coleção de intervalos com o mesmo namedRangeId. Com os intervalos nomeados, os desenvolvedores podem associar partes de um documento a um marcador arbitrário definido pelo usuário para que o conteúdo possa ser lido ou editado de forma programática 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 dele.
- Sugestão
Mudanças em um documento sem alterar o texto original. Se o proprietário aprovar suas sugestões, elas vão substituir o texto original.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-29 UTC.
[null,null,["Última atualização 2025-08-29 UTC."],[],[],null,["# Google Docs API overview\n\nThe Google Docs API lets you create and modify documents in Google Docs.\n\nApplications can integrate with the Docs API to create polished\ndocuments from both user and system-provided data. The Docs API lets\nyou:\n\n- Automate processes\n- Create documentation in bulk\n- Format documents\n- Generate invoices or contracts\n- Retrieve specific attributes of objects\n\nThe following is a list of common terms used in the Docs API:\n\n*Document ID*\n\n: The unique identifier for a document. It's a particular string containing\n letters, numbers, and some special characters that reference a document and\n it can be derived from the document's URL. Document IDs are stable, even if\n the document name changes. For more information on how to find the ID, see\n [Document ID](/workspace/docs/api/concepts/document#document-id).\n\n https://docs.google.com/document/d/\u003cvar translate=\"no\"\u003eDOCUMENT_ID\u003c/var\u003e/edit\n\n*Element*\n\n: The structure that makes up a document. Top-level elements of a document\n include the [`Body`](/workspace/docs/api/reference/rest/v1/documents#body),\n [`DocumentStyle`](/workspace/docs/api/reference/rest/v1/documents#documentstyle), and\n [`List`](/workspace/docs/api/reference/rest/v1/documents#list).\n\n*Google Workspace document*\n\n: A file that a Google Workspace application, like Google Docs, creates.\n The MIME type format for Docs is\n `application/vnd.google-apps.document`. For a list of MIME types, see [Google Workspace and Google Drive supported MIME types](/drive/api/guides/mime-types).\n\n*Index*\n\n: Most *elements* within the content body have the `startIndex` and `endIndex`\n properties. These indicate the offset of an element's beginning and end,\n relative to the beginning of its enclosing *segment*.\n\n*Inline image*\n\n: An image that appears in the flow of text within a document. It's not an\n attachment.\n\n*Named range*\n\n: A contiguous range of text. A\n [`NamedRange`](/workspace/docs/api/reference/rest/v1/documents#namedrange) is a\n collection of ranges with the same `namedRangeId`. Named ranges allow\n developers to associate parts of a document with an arbitrary user-defined\n label so their contents can be programmatically read or edited later. A\n document can contain multiple named ranges with the same name, but every\n named range has a unique ID.\n\n*Segment*\n\n: The `Body`, [`Header`](/workspace/docs/api/reference/rest/v1/documents#header),\n [`Footer`](/workspace/docs/api/reference/rest/v1/documents#footer), or\n [`Footnote`](/workspace/docs/api/reference/rest/v1/documents#footnote) containing\n structural or content *elements* . The *indexes* of the elements within a\n segment are relative to the beginning of that segment.\n\n*Suggestion*\n\n: Changes to a document without changing the original text. If the owner\n approves your suggestions, they replace the original text.\n\nRelated topics\n--------------\n\n- To learn about developing with Google Workspace APIs, including handling\n authentication and authorization, refer to [Develop on\n Google Workspace](/workspace/guides/get-started).\n\n- To get a conceptual overview of a document, see\n [Document](/workspace/docs/api/concepts/document).\n\n- To learn how to configure and run a Docs API app, try the\n [JavaScript quickstart](/workspace/docs/api/quickstart/js)."]]
