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. El procesamiento por 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 tu cliente genera una cierta cantidad de sobrecarga. La API de Presentaciones 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 solicitudes secundarias en una sola llamada al servidor y recupera una sola respuesta.

Recomendamos a los usuarios que siempre agrupen varias solicitudes. 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.
• Si necesitas actualizar metadatos o propiedades, como el formato, en varios objetos.
• Debes borrar muchos objetos.

Consideraciones sobre los límites, las autorizaciones y las dependencias

Esta es una lista de otros elementos que se deben tener en cuenta cuando se implementa la actualización por lotes:

• Cada solicitud por lotes, incluidas todas las subsolicitudes, se cuenta como una solicitud a la API para 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 solicitudes secundarias en el mismo orden en el que aparecen en la solicitud por lotes. Las últimas solicitudes secundarias pueden depender de las acciones realizadas durante las solicitudes secundarias anteriores. Por ejemplo, en la misma solicitud por lotes, los usuarios pueden insertar texto en un documento existente y, luego, darle estilo.

Detalles del lote

Una solicitud por lotes consiste en una llamada al método batchUpdate con varias subsolicitudes, por ejemplo, para agregar una presentación y luego 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, no se completará la actualización en su totalidad y no se aplicará 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 crear un documento de Google completo mediante una solicitud de actualización por lotes a la API con varias solicitudes secundarias.

Formato de una solicitud por lotes

Una solicitud es una solicitud JSON que contiene varias subsolicitudes anidadas con una propiedad obligatoria: requests. Las solicitudes se construyen en un array de solicitudes individuales. Cada solicitud usa JSON para representar el objeto de 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 del objeto JSON principal 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 la siguiente muestra de código, se indica el uso del procesamiento por lotes con la API de Presentaciones.

Solicitud

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

• Agrega un recurso presentations.pages a una presentación existente, con un insertionIndex de 1, mediante el método CreateSlideRequest.

• Agrega un shapeType de tipo TEXT_BOX a la diapositiva nueva con el método CreateShapeRequest.

• Inserta el texto "Hello World" en el campo nuevo con el método InsertTextRequest.

{
   "requests":[
      {
         "createSlide":{
            "insertionIndex":1,
            "objectId":"newSlide"
         }
      },
      {
         "createShape":{
            "elementProperties":{
               "pageObjectId":"newSlide",
               "size":{
                  "height":{
                     "magnitude":50,
                     "unit":"PT"
                  },
                  "width":{
                     "magnitude":200,
                     "unit":"PT"
                  }
               }
            },
            "shapeType":"TEXT_BOX",
            "objectId":"newTextBox"
         }
      },
      {
         "insertText":{
            "objectId":"newTextBox",
            "text":"Hello World"
         }
      }
   ]
}

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 el método InsertTextRequest no contiene una respuesta, por lo que el valor de índice del array en [2] consta de llaves vacías. La solicitud por lotes muestra la propiedad WriteControl, que indica cómo se ejecutaron las solicitudes de escritura.

{
   "requiredRevisionId": ID
   "presentationId": "",
   "replies":[
      {
         "createSlide":{
            "objectId":"newSlide"
         }
      },
      {
         "createShape":{
            "objectId":"newTextBox"
         }
      },
      {
         
      }
   ],
   "writeControl":{
      "requiredRevisionId": REVISION_ID
   }
}