En esta guía, se presentan los principales métodos de solicitud y respuesta que componen la API de Google Docs, y se explica cómo puedes actualizar un documento en lotes.
Puedes invocar la API de Google Docs con una solicitud HTTP o con una invocación de método en una biblioteca cliente específica del lenguaje. Estos son equivalentes en términos generales.
La API de Google Docs devuelve una respuesta HTTP, que generalmente incluye el resultado de la invocación de la solicitud. Cuando se usa una biblioteca cliente para realizar solicitudes, las respuestas se muestran de una manera específica para cada idioma.
Métodos de la solicitud
La API de Docs admite los siguientes métodos:
documents.create: Crea un documento en blanco de Documentos de Google.documents.get: Devuelve una instancia completa del documento especificado. Puedes analizar el JSON devuelto para extraer el contenido, el formato y otras funciones del documento.documents.batchUpdate: Envía una lista de solicitudes de edición para aplicar de forma atómica al documento y devuelve una lista de resultados.
Los métodos documents.get y documents.batchUpdate requieren un documentId como parámetro para especificar el documento de destino. El método documents.create devuelve una instancia del documento creado, desde la que puedes leer el documentId. Para obtener más información sobre documentId, consulta ID del documento.
Ten en cuenta que no puedes usar el método documents.get para recuperar documentos publicados. Una vez publicados, los documentos públicos usan un formato de URL diferente. Los intentos de usar el nuevo documentId de la URL con el método documents.get devuelven una respuesta con el código de estado HTTP 404. No hay métodos para recuperar el documentId original de la URL publicada. Para solucionar este problema, puedes usar la API de Drive para copiar el documento publicado en un documento compartido y, luego, acceder a este archivo. Para obtener más información, consulta Cómo publicar archivos de Documentos, Hojas de cálculo, Presentaciones y Formularios de Google.
Actualizaciones por lotes
El método documents.batchUpdate toma una lista de objetos request, cada uno de los cuales especifica una sola solicitud para realizar. Por ejemplo, puedes darle formato a un párrafo y, luego, agregar una imagen intercalada. Cada solicitud se valida antes de aplicarse y se procesa según el orden en que aparece en la solicitud por lotes.
Todas las solicitudes en la actualización por lotes se aplican de forma atómica. Es decir, si alguna solicitud no es válida, toda la actualización no se realiza correctamente y no se aplican los cambios (que podrían ser dependientes).
Algunos métodos de documents.batchUpdate proporcionan respuestas con información sobre las solicitudes aplicadas. Estos métodos devuelven un cuerpo de respuesta que contiene una lista de objetos response.
Otras solicitudes no necesitan devolver información y muestran una respuesta vacía. Los objetos de la lista de respuestas ocupan el mismo orden de índice que la solicitud correspondiente.
Un patrón popular para realizar solicitudes por lotes se ve de la siguiente manera:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Consulta las prácticas recomendadas para las solicitudes por lotes para obtener todos los detalles sobre cómo agrupar por lotes tus llamadas a la API de Docs y la documentación de referencia de documents.batchUpdate para los tipos de solicitudes y respuestas.
Operaciones de actualización por lotes
Existen varios tipos de solicitudes de actualización por lotes. A continuación, se presenta un desglose de los tipos de solicitudes, agrupados en diferentes categorías.
Temas relacionados
- Estructura de un documento de Documentos de Google
- Reglas y comportamiento de la edición estructural
- Solicitudes en lotes