En esta guía, se presentan los métodos de solicitud y respuesta principales que conforman la API de Documentos de Google y cómo actualizar un documento en lotes.
Puedes invocar a la API de Documentos de Google usando una solicitud HTTP o un método en una biblioteca cliente específica del lenguaje. Son equivalentes en términos generales.
La API de Documentos de Google devuelve una respuesta HTTP, que generalmente incluye el resultado de la invocación de la solicitud. Cuando se usa una biblioteca cliente para hacer solicitudes, el las respuestas se muestran de manera específica para cada lenguaje.
Métodos de la solicitud
La API de Documentos admite los siguientes métodos:
documents.create: Crea un un archivo de Documentos de Google en blanco.documents.get: Muestra un instancia completa del documento especificado. Puedes analizar el JSON que se muestra para extraer el contenido, el formato y otras funciones del documento.documents.batchUpdateEnvía una lista de solicitudes de edición para aplicarlas automáticamente al documento. devolverá una lista de resultados.
Los métodos documents.get y documents.batchUpdate requieren una documentId
como parámetro para especificar el documento de destino. El método documents.create
devuelve una instancia del documento creado, desde donde puedes leer el
documentId Para obtener más información sobre documentId, consulta Documento
correcto.
Actualizaciones por lotes
La documents.batchUpdate
toma una lista de
request objetos, cada uno
especificando una única solicitud para realizar. Por ejemplo, dale formato a un párrafo y, luego,
agregar una imagen intercalada. Cada solicitud se valida antes de aplicarse y el
Las solicitudes se procesan según el orden en el que aparecen en la solicitud por lotes.
Todas las solicitudes de la actualización por lotes se aplican de forma atómica. Es decir, si cualquier solicitud no es válida, significa que no se realizará correctamente la actualización y ninguna de las (posiblemente dependientes).
Algunos métodos documents.batchUpdate proporcionan respuestas con información sobre
las solicitudes aplicadas. Estos métodos devuelven una respuesta
body que
contiene una lista de response
objetos. No es necesario que otras solicitudes devuelvan información ni muestren un
respuesta. Los objetos de la lista de respuesta ocupan el mismo orden de índice que el
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:
cómo agrupar por lotes las llamadas a la API de Documentos
documents.batchUpdate
documentación de referencia
para los tipos de solicitud y respuesta.
Operaciones de actualización por lotes
Existen varios tipos de solicitudes de actualización por lotes. Este es un desglose de tipos de solicitud, agrupados en categorías diferentes.
Temas relacionados
- Estructura de un archivo de Documentos de Google
- Comportamiento y reglas de edición de estructuras
- Solicitudes en lotes