Descripción general de la API de Documentos de Google
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La API de Google Docs te permite crear y modificar documentos en Documentos de Google.
Las aplicaciones pueden integrarse con la API de Docs para crear documentos pulidos a partir de datos proporcionados por el usuario y el sistema. La API de Docs te permite hacer lo siguiente:
- Automatización de procesos
- Cómo crear documentación de forma masiva
- Cómo dar formato a documentos
- Generar facturas o contratos
- Recupera atributos específicos de objetos
A continuación, se incluye una lista de términos comunes que se usan en la API de Docs:
- ID de documento
Es el identificador único de un documento. Es una cadena específica que contiene letras, números y algunos caracteres especiales que hacen referencia a un documento, y se puede derivar de la URL del documento. Los IDs de documentos son estables, incluso si cambia el nombre del documento. Para obtener más información sobre cómo encontrar el ID, consulta ID del documento.
https://docs.google.com/document/d/DOCUMENT_ID/edit
- Elemento
Es la estructura que conforma un documento. Los elementos de nivel superior de un documento incluyen Body
, DocumentStyle
y List
.
- Documento de Google Workspace
Es un archivo que crea una aplicación de Google Workspace, como Documentos de Google.
El formato del tipo de MIME para Documentos es application/vnd.google-apps.document
. Para obtener una lista de los tipos de MIME, consulta
Tipos de MIME compatibles con Google Workspace y Google Drive.
- Índice
La mayoría de los elementos dentro del cuerpo del contenido tienen las propiedades startIndex
y endIndex
. Indican el desplazamiento del inicio y el final de un elemento, en relación con el inicio de su segmento envolvente.
- Imagen intercalada
Imagen que aparece en el flujo de texto dentro de un documento. No es un archivo adjunto.
- Rango con nombre
Es un rango contiguo de texto. Un NamedRange
es una colección de rangos con el mismo namedRangeId
. Los rangos con nombre permiten que los desarrolladores asocien partes de un documento con una etiqueta arbitraria definida por el usuario para que su contenido se pueda leer o editar de forma programática más adelante. Un documento puede contener varios rangos con nombre que tengan el mismo nombre, pero cada rango con nombre tiene un ID único.
- Segmento
El Body
, Header
, Footer
o Footnote
que contiene elementos estructurales o de contenido Los índices de los elementos dentro de un segmento son relativos al comienzo de ese segmento.
- Sugerencia
Cambios en un documento sin modificar el texto original. Si el propietario aprueba tus sugerencias, estas reemplazarán el texto original.
Para obtener información sobre el desarrollo con las APIs de Google Workspace, incluido el manejo de la autenticación y la autorización, consulta Desarrolla en Google Workspace.
Para obtener una descripción general conceptual de un documento, consulta Document.
Para aprender a configurar y ejecutar una app de la API de Docs, prueba la guía de inicio rápido de JavaScript.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-29 (UTC)
[null,null,["Última actualización: 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)."]]