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 perfeccionados a partir de datos proporcionados por el usuario y por el sistema. La API de Documentos te permite hacer lo siguiente:

  • Automatización de procesos
  • Crear documentación de forma masiva
  • Cómo aplicarles formato a los documentos
  • Generar facturas o contratos
  • Recupera atributos específicos de objetos

La siguiente es 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 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 documento son estables, incluso si cambia el nombre del documento. Si quieres obtener más información para encontrar el ID, consulta ID de documento.

https://docs.google.com/document/d/DOCUMENT_ID/edit
Elemento

Es la estructura que constituye 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 principio y el final de un elemento, en relación con el comienzo de su segmento que lo contiene.

Imagen intercalada

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

Rango con nombre

Un rango de texto contiguo. Un objeto NamedRange es una colección de rangos con el mismo namedRangeId. Los rangos con nombre permiten a los desarrolladores asociar partes de un documento con una etiqueta arbitraria definida por el usuario para que su contenido se pueda leer o editar más tarde de manera programática. Un documento puede contener varios rangos con nombre con el mismo nombre, pero cada rango con nombre tiene un ID único.

Segmento

Los elementos Body, Header, Footer o Footnote que incluyen elementos de contenido o estructurales. Los índices de los elementos dentro de un segmento se relacionan con el comienzo de ese segmento.

Sugerencia

Cambios en un documento sin modificar el texto original. Si el propietario aprueba tus sugerencias, reemplazará el texto original.

  • Para obtener información sobre cómo desarrollar 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 Documento.

  • Para obtener información sobre cómo configurar y ejecutar una app de la API de Documentos, prueba la guía de inicio rápido de JavaScript.