Descripción general de la API de Documentos de Google

La API de Documentos de Google te permite crear y modificar documentos en Documentos de Google.

Las aplicaciones pueden integrarse con la API de Documentos para crear documentos mejorados a partir de datos proporcionados por el usuario y el sistema. La API de Documentos te permite hacer lo siguiente:

  • Automatización de procesos
  • Crea documentación de forma masiva
  • Dar formato a documentos
  • Genera facturas o contratos
  • Cómo recuperar atributos específicos de objetos

A continuación, se incluye una lista de términos comunes que se usan en la API de Documentos:

ID de documento

Es el identificador único de un documento. Es una cadena particular que contiene letras, números y algunos caracteres especiales que hacen referencia a un documento y se puede obtener 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 de 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 de tipo MIME de 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. Estos indican el desplazamiento del inicio y el final de un elemento, en relación con el inicio de su segmento envolvente.

Imagen intercalada

Es una imagen que aparece en el flujo de texto de un documento. No es un archivo adjunto.

Rango con nombre

Es un rango contiguo de texto. Un NamedRange es una recopilación de rangos con el mismo namedRangeId. Los rangos nombrados 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 el mismo nombre, pero cada rango tiene un ID único.

Segmento

Body, Header, Footer o Footnote que contengan elementos estructurales o de contenido Los índices de los elementos dentro de un segmento son relativos al comienzo de ese segmento.

Sugerencia

Se realizan 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, incluida la administración de la autenticación y la autorización, consulta Desarrollo en Google Workspace.

  • Para obtener una descripción general conceptual de un documento, consulta Documento.

  • Para aprender a configurar y ejecutar una app de la API de Documentos, consulta la guía de inicio rápido de JavaScript.