En este documento, se muestra cómo agrupar llamadas a la API a fin de reducir la cantidad de conexiones HTTP que debe hacer el cliente.
Este documento trata, en particular, sobre cómo hacer una solicitud por lotes mediante el envío de una solicitud HTTP. En cambio, si usas una biblioteca cliente de Google para realizar una solicitud por lotes, consulta la documentación sobre bibliotecas cliente.
Descripción general
Cada conexión HTTP que tu cliente realiza da como resultado una cierta cantidad de sobrecarga. La API de Display & Video 360 admite el procesamiento por lotes para permitir que tu cliente coloque varias llamadas a la API en una sola solicitud HTTP.
A continuación, se detallan algunos ejemplos de situaciones en las que te sería útil usar el procesamiento por lotes:
- Recuperar recursos de varios anunciantes
- Crear o actualizar recursos de forma masiva
- Editar la segmentación en varias líneas de pedido
En cada caso, en lugar de enviar cada llamada por separado, puedes agruparlas en una sola solicitud HTTP. Todas las solicitudes internas deben dirigirse a la misma API de Google.
Tienes un límite de 1,000 llamadas por solicitud por lotes. Si necesitas realizar más llamadas, usa varias solicitudes por lotes.
Nota: El sistema por lotes para la API de Display & Video 360 usa la misma sintaxis que el sistema de procesamiento por lotes OData, pero difiere en la semántica.
Detalles del lote
Una solicitud por lotes consta de varias llamadas a la API combinadas en una solicitud HTTP, que pueden enviarse al batchPath especificado en el documento de descubrimiento de la API. La ruta de acceso predeterminada es /batch/api_name/api_version. En esta sección, se describe la sintaxis del lote en detalle; más adelante, se muestra un ejemplo.
Nota: Un conjunto de solicitudes n agrupadas se considera en tu límite de uso como solicitudes n, no como una sola. La solicitud por lotes se divide en un conjunto de solicitudes antes de procesarse.
Formato de una solicitud por lotes
Una solicitud por lotes es una solicitud HTTP estándar que contiene varias llamadas a la API de Display & Video 360 con el tipo de contenido multipart/mixed. Dentro de esa solicitud HTTP principal, cada una de las partes contiene una solicitud HTTP anidada.
Cada parte comienza con su propio encabezado HTTP Content-Type: application/http. También puede tener un encabezado opcional Content-ID. Sin embargo, los encabezados de partes solo están allí para marcar el comienzo de la parte; están separados de la solicitud anidada. Una vez que el servicio desenvuelve la solicitud por lotes en diferentes solicitudes, los encabezados de las partes se ignoran.
El cuerpo de cada parte es en sí mismo una solicitud HTTP completa, con su propio verbo, URL, encabezados y cuerpo. La solicitud HTTP debe contener solamente la parte de la ruta de la URL; no se admiten URL enteras en las solicitudes por lotes.
Los encabezados HTTP para la solicitud por lotes externa, excepto por los encabezados Content-, como Content-Type, se aplican a cada solicitud en el lote. Si especificas cierto encabezado HTTP tanto en la solicitud externa como en una llamada individual, el valor del encabezado de la llamada individual reemplaza el valor del encabezado de la solicitud por lotes externa. Los encabezados de una llamada individual solo se aplican a esa llamada.
Por ejemplo, si proporcionas un encabezado de autorización para una llamada específica, ese encabezado se aplica solamente a esa llamada. Si proporcionas un encabezado de autorización para la solicitud externa, se aplica a todas las llamadas individuales, a menos que la reemplacen con encabezados de autorización propios.
Cuando el servidor recibe la solicitud por lotes, aplica los encabezados y parámetros de consulta de la solicitud externa (según corresponda) a cada parte y, a continuación, trata cada parte como una solicitud HTTP separada.
Respuesta a una solicitud por lotes
La respuesta del servidor es una sola respuesta HTTP estándar con un tipo de contenido multipart/mixed; cada parte es la respuesta a una de las solicitudes de la solicitud por lotes, en el mismo orden que las solicitudes.
Como las partes de la solicitud, cada parte de respuesta contiene una respuesta HTTP completa, que incluye un código de estado, encabezados y un cuerpo. Además, cada una está precedida por un encabezado Content-Type que marca el comienzo de la parte.
Si cierta parte de la solicitud tenía un encabezado Content-ID, la parte correspondiente de la respuesta tendrá un encabezado Content-ID que coincida y un valor original precedido por la string response-, como se muestra en el siguiente ejemplo.
Nota: Es posible que el servidor realice llamadas en cualquier orden. No cuentes con que se ejecutarán en el orden en que las especificaste. Si quieres garantizar que dos llamadas sucedan en un orden determinado, no puedes enviarlas en una misma solicitud; en cambio, envía la primera sola, espera una respuesta y, luego, envía la segunda.
Ejemplo
En el siguiente ejemplo, se muestra el uso del procesamiento por lotes con la API de Display & Video 360.
Ejemplo de solicitud por lotes
POST /batch HTTP/1.1
Host: displayvideo.googleapis.com
Authorization: Bearer your_auth_code
Content-Type: multipart/mixed; boundary=batch_foobarbaz
Content-Length: total_content_length
--batch_foobarbaz
Content-Type: application/http
Content-Transfer-Encoding: binary
MIME-Version: 1.0
Content-ID: <item1:12930812@displayvideo.example.com>
PATCH /v1/advertisers/advertiser_id?updateMask=displayName&fields=advertiserId,displayName HTTP/1.1
Content-Type: application/json; charset=UTF-8
Authorization: Bearer your_auth_code
{
"displayName": "Updated Advertiser Name"
}
--batch_foobarbaz
Content-Type: application/http
Content-Transfer-Encoding: binary
MIME-Version: 1.0
Content-ID: <item2:12930812@displayvideo.example.com>
PATCH /v1/advertisers/advertiser_id/lineItems/line_item_id?updateMask=displayName&fields=lineItemId,displayName HTTP/1.1
Content-Type: application/json; charset=UTF-8
Authorization: Bearer your_auth_code
{
"displayName": "Updated Line Item Name"
}
--batch_foobarbaz--
Ejemplo de respuesta por lotes
Esta es la respuesta a la solicitud de ejemplo de la sección anterior.
HTTP/1.1 200
Content-Length: response_total_content_length
Content-Type: multipart/mixed; boundary=batch_foobarbaz
--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item1:12930812@displayvideo.example.com>
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: response_part_1_content_length
{
"advertiserId": advertiser_id,
"displayName": "Updated Advertiser Name"
}
--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item2:12930812@displayvideo.example.com>
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: response_part_2_content_length
{
"lineItemId": line_item_id,
"displayName": "Updated Line Item Name"
}
--batch_foobarbaz--
Uso de las bibliotecas cliente
En las siguientes muestras de código, se indica cómo realizar solicitudes por lotes con las bibliotecas cliente de las APIs de Google. Consulta las respectivas guías de inicio rápido para obtener más información sobre cómo instalar las bibliotecas y configurarlas.
Java
Long advertiserId = advertiser-id;
List<Long> lineItemIds = Arrays.asList(line-item-id-1, line-item-id-2);
BatchRequest batch = service.batch();
JsonBatchCallback<LineItem> callback = new JsonBatchCallback<LineItem>() {
public void onSuccess(LineItem lineItem, HttpHeaders responseHeaders) {
System.out.printf("Line Item '%s' is now active.\n",
lineItem.getName());
}
public void onFailure (GoogleJsonError error, HttpHeaders responseHeaders)
throws IOException{
System.out.printf("Error activating line item: %s\n", error.getMessage());
}
};
LineItem activatedLineItem = new LineItem().setEntityStatus("ENTITY_STATUS_ACTIVE");
for (Long lineItemId: lineItemIds) {
service.advertisers().lineItems().patch(advertiserId, lineItemId, activatedLineItem)
.setUpdateMask("entityStatus").queue(batch, callback);
}
batch.execute();Python
advertiser_id = advertiser-id
line_item_ids = [line-item-id-1, line-item-id-2]
def callback(request_id, response, exception):
if exception is not None:
print('Error activating line item "%s": %s' %
request_id, exception)
else:
print('Line item "%s" is now active.' %
response.get('name'))
batch = service.new_batch_http_request(callback=callback)
line_item_obj = {
'entityStatus': 'ENTITY_STATUS_ACTIVE'
}
for line_item_id in line_item_ids:
request = service.advertisers().lineItems().patch(
advertiserId=advertiser_id,
lineItemId=line_item_id,
updateMask="entityStatus",
body=line_item_obj
)
batch.add(request, request_id=line_item_id)
batch.execute()PHP
$advertiserId = advertiser-id;
$lineItemIds = array(line-item-id-1, line-item-id-2);
// Enable batching on client and create current batch
$service->getClient()->setUseBatch(true);
$batch = $service->createBatch();
// Create line item with updated fields
$updatedLineItem = new Google_Service_DisplayVideo_LineItem();
$updatedLineItem->setEntityStatus('ENTITY_STATUS_ACTIVE');
// Create request parameter array with update mask
$optParams = array('updateMask' => 'entityStatus');
// Add each patch request to the batch
foreach($lineItemIds as $lineItemId) {
$request = $this->service->advertisers_lineItems->patch(
$advertiserId,
$lineItemId,
$updatedLineItem,
$optParams
);
$requestId = $lineItemId;
$batch->add($request, $requestId);
}
// Execute batch request
$results = $batch->execute();
// Iterate through results
foreach($results as $responseId => $lineItem) {
$lineItemId = substr($responseId, strlen('response-') + 1);
if ($lineItem instanceof Google_Service_Exception) {
$e = $lineItem;
printf(
"Error activating line item '%s': %s\n",
$lineItemId,
$e->getMessage()
);
} else {
printf("Line item '%s' is now active.\n", $lineItem->getName());
}
}
$service->getClient()->setUseBatch(false);