Solicitudes por lotes

En este documento, se muestra cómo agrupar llamadas a la API para reducir la cantidad de conexiones que debe hacer el cliente. La agrupación en lotes puede mejorar la eficiencia de una aplicación, ya que disminuye los recorridos de ida y vuelta de la red y aumenta la capacidad de procesamiento.

Descripción general

Cada conexión que realiza el cliente genera una cierta cantidad de sobrecarga. La API de Documentos de Google admite el procesamiento por lotes para permitir que tu cliente coloque varios objetos de solicitud, cada uno de los cuales especifica un solo tipo de solicitud para realizar, en una sola solicitud por lotes. Una solicitud por lotes puede mejorar el rendimiento, ya que combina varias subsolicitudes en una sola llamada al servidor y recupera una sola respuesta.

Recomendamos a los usuarios que siempre acumule varias solicitudes juntas. Estos son algunos ejemplos de situaciones en las que puedes usar el procesamiento por lotes:

• Recién comienzas a usar la API y tienes muchos datos para subir.
• Debes actualizar metadatos o propiedades, como el formato, en varios objetos.
• Debes borrar muchos objetos.

Consideraciones sobre límites, autorización y dependencias

Esta es una lista de otros elementos que se deben considerar cuando se emplee la actualización por lotes:

• Cada solicitud por lotes, incluidas todas las subsolicitudes, se cuenta como una solicitud a la API respecto de tu límite de uso.
• Una solicitud por lotes se autentica una vez. Esta autenticación única se aplica a todos los objetos de actualización por lotes en la solicitud.
• El servidor procesa las subsolicitudes en el mismo orden en el que aparecen en la solicitud por lotes. Las últimas subsolicitudes pueden depender de las acciones realizadas durante las subsolicitudes anteriores. Por ejemplo, en la misma solicitud por lotes, los usuarios pueden insertar texto en un documento existente y, luego, diseñar el estilo.

Detalles del lote

Una solicitud por lotes consta de una llamada al método batchUpdate con varias subsolicitudes, por ejemplo, para agregar un documento y darle formato.

Cada solicitud se valida antes de aplicarse. Todas las subsolicitudes de la actualización por lotes se aplican de forma atómica. Es decir, si alguna solicitud no es válida, la actualización completa no se realiza correctamente y no se aplica ninguno de los cambios (potencialmente dependientes).

Algunas solicitudes proporcionan respuestas con información sobre las solicitudes aplicadas. Por ejemplo, todas las solicitudes de actualización por lotes para agregar objetos muestran respuestas a fin de que puedas acceder a los metadatos del objeto recién agregado, como el ID o el título.

Con este enfoque, puedes compilar un documento de Google completo mediante una solicitud de actualización por lotes de la API con varias solicitudes secundarias.

Formato de una solicitud por lotes

Una solicitud es una solicitud JSON única que contiene varias subsolicitudes anidadas con una propiedad obligatoria: requests. Las solicitudes se construyen en un arreglo de solicitudes individuales. Cada solicitud usa JSON para representar el objeto de la solicitud y contener sus propiedades.

Formato de una respuesta por lotes

El formato de respuesta para una solicitud por lotes es similar al formato de solicitud. La respuesta del servidor contiene una respuesta completa del único objeto de respuesta.

La propiedad principal del objeto JSON se llama replies. Las respuestas se muestran en un array, y cada respuesta a una de las solicitudes ocupa el mismo orden de índice que la solicitud correspondiente. Algunas solicitudes no tienen respuestas, y la respuesta en ese índice del array está vacía.

Ejemplo

En el siguiente ejemplo, se muestra el uso del procesamiento por lotes con la API de Documentos.

Solicitud

En esta solicitud por lotes de ejemplo, se muestra cómo realizar las siguientes acciones:

• Inserta el texto "Hello World" al comienzo de un documento existente, con un índice Location de 1, mediante InsertTextRequest.
• Actualiza la palabra "Hello" con UpdateTextStyleRequest. startIndex y endIndex definen la range del texto con formato dentro del segmento.
• Con textStyle, establece el estilo de fuente en negrita y el color en azul.

{
   "requests":[
      {
         "insertText":{
            "location":{
               "index":1
            },
            "text":"Hello World"
         }
      },
      {
         "updateTextStyle":{
            "range":{
               "startIndex":1,
               "endIndex":6
            },
            "textStyle":{
               "bold":true,
               "foregroundColor":{
                  "color":{
                     "rgbColor":{
                        "blue":1
                     }
                  }
               }
            },
            "fields":"bold,foreground_color"
         }
      }
   ]
}

Respuesta

En esta respuesta por lotes de ejemplo, se muestra información sobre cómo se aplicó cada subsolicitud dentro de la solicitud por lotes. Ten en cuenta que InsertTextRequest y UpdateTextStyleRequest no contienen una respuesta, por lo que los valores de índice del array en [0] y [1] consisten en llaves vacías. La solicitud por lotes sí muestra WriteControl, que muestra cómo se ejecutaron las solicitudes de escritura.

{
   "replies":[
      {
         
      },
      {
         
      }
   ],
   "writeControl":{
      "requiredRevisionId":`REVISION_ID`
   },
   "documentId":`DOCUMENT_ID`
}