طلبات مجمّعة

يعرض هذا المستند كيفية تجميع طلبات البيانات من واجهة برمجة التطبيقات معًا لتقليل عدد اتصالات HTTP التي يجب على العميل إجراؤها.

يدور هذا المستند تحديدًا حول تقديم طلب مُجمَّع من خلال إرسال طلب HTTP. بدلاً من ذلك، إذا كنت تستخدم مكتبة عملاء Google لتقديم طلب مجمّع، يُرجى الاطّلاع على مستندات مكتبة العملاء.

نظرة عامة

ينتج عن كل اتصال HTTP ينتج عنه قدر معيّن من النفقات العامة. تتيح "مساحة العرض والفيديو 360 API" التجميع، وذلك للسماح لعميلك بإدخال طلبات بيانات متعددة من واجهة برمجة التطبيقات في طلب HTTP واحد.

أمثلة على الحالات التي قد تريد فيها استخدام التجميع:

  • استرداد الموارد عبر عدة معلنين.
  • إنشاء الموارد أو تعديلها بشكل مجمّع
  • تعديل الاستهداف عبر عناصر متعددة.

في كل حالة، بدلاً من إرسال كل استدعاء بشكل منفصل، يمكنك تجميعها معًا في طلب HTTP واحد. يجب أن تنتقل جميع الطلبات الداخلية إلى واجهة Google API نفسها.

الحد الأقصى المسموح به لعدد المكالمات هو 1000 مكالمة في كل طلب مجمّع. إذا كنت بحاجة إلى إجراء استدعاءات أكثر من ذلك، استخدم طلبات مجمَّعة متعددة.

ملاحظة: يستخدِم نظام التجميع لـ "مساحة العرض والفيديو 360 API" البنية نفسها المستخدَمة في نظام المعالجة المجمّعة لبيانات OData، ولكن تختلف المعنى.

تفاصيل الدفعة

يتألف الطلب المجمّع من طلبات بيانات متعددة من واجهة برمجة التطبيقات تم دمجها في طلب HTTP واحد، ويمكن إرساله إلى batchPath المحدّد في مستند اكتشاف واجهة برمجة التطبيقات. المسار التلقائي هو /batch/api_name/api_version. يوضّح هذا القسم بنية الدفعة بالتفصيل، ويمكنك الاطّلاع لاحقًا على مثال.

ملاحظة: يتم احتساب مجموعة من طلبات n مجمّعة معًا ضمن حد الاستخدام كطلبات n، وليس كطلب واحد. ويتم تقسيم الطلب المجمّع إلى مجموعة من الطلبات قبل المعالجة.

تنسيق الطلب المجمّع

الطلب المجمّع هو طلب HTTP عادي واحد يحتوي على طلبات متعدّدة من واجهة برمجة التطبيقات الخاصة بـ "مساحة العرض والفيديو 360"، ويستخدم نوع المحتوى multipart/mixed. ضمن طلب HTTP الرئيسي هذا، يحتوي كل جزء على طلب HTTP متداخل.

يبدأ كل جزء بعنوان HTTP يتضمّن العنصر Content-Type: application/http خاص به. ويمكن أن تحتوي أيضًا على عنوان Content-ID اختياري. ومع ذلك، تكون رؤوس الأجزاء موجودة فقط لوضع علامة على بداية الجزء؛ وهي منفصلة عن الطلب المتداخل. بعد أن يلغي الخادم الطلب المجمّع في طلبات منفصلة، يتم تجاهل عناوين الأجزاء.

ويكون نص كل جزء بحد ذاته طلب HTTP كاملاً، مع ما يخصه من فعل وعنوان URL ورؤوس ونص. يجب أن يحتوي طلب HTTP فقط على جزء المسار من عنوان URL، ولا يُسمح بعناوين URL الكاملة في الطلبات المجمّعة.

تسري عناوين HTTP الخاصة بالطلب المجمّع الخارجي، باستثناء عناوين Content-، مثل Content-Type، على كل طلب في الدفعة. إذا حددت عنوان HTTP محددًا في كل من الطلب الخارجي والاستدعاء الفردي، فستلغي قيمة عنوان الاستدعاء الفردي قيمة عنوان طلب الدفعة الخارجية. لا تسري رؤوس مكالمة فردية إلا على هذه المكالمة.

على سبيل المثال، إذا قدّمت عنوان تفويض لمكالمة معيّنة، ينطبق هذا العنوان فقط على هذه المكالمة. في حال تقديم عنوان تفويض للطلب الخارجي، سيتم عندئذٍ تطبيق هذا العنوان على جميع الطلبات الفردية ما لم يتم تجاوزه برؤوس تفويض خاصة بها.

عندما يتلقى الخادم الطلب المجمّع، فإنه يطبق معلمات طلب البحث الخارجي ورؤوسه (حسب الاقتضاء) على كل جزء، ثم يعامل كل جزء كما لو كان طلب HTTP منفصلاً.

الرد على طلب مجمّع

تكون استجابة الخادم هي استجابة HTTP عادية واحدة مع نوع محتوى multipart/mixed، ويمثل كل جزء استجابة لأحد الطلبات في الطلب المجمّع، وبنفس ترتيب الطلبات.

مثل الأجزاء في الطلب، يحتوي كل جزء استجابة على استجابة HTTP كاملة، بما في ذلك رمز الحالة والرؤوس والنص. وعلى غرار الأجزاء المدرَجة في الطلب، يكون كل جزء استجابة مسبوقًا برأس Content-Type يحدّد بداية ذلك الجزء.

إذا كان لجزء معيّن من الطلب عنوان Content-ID، يكون لهذا الجزء من الاستجابة عنوان Content-ID مطابق، على أن تكون القيمة الأصلية مسبوقة بالسلسلة response-، كما هو موضّح في المثال التالي.

ملاحظة: قد يجري الخادم المكالمات بأي ترتيب. لا تعتمد على تنفيذها بالترتيب الذي حددتها به. إذا أردت التأكد من حدوث المكالمتين بترتيب معين، فلا يمكنك إرسالهما في طلب واحد؛ بدلاً من ذلك، أرسِل الطلب الأول بمفرده، ثم انتظر الرد على الطلب الأول قبل إرسال الطلب الثاني.

مثال

يوضِّح المثال التالي استخدام التجميع باستخدام Display & Video 360 API.

مثال على طلب مجمّع

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--

مثال على ردّ مجمّع

هذا هو الردّ على نموذج الطلب الوارد في القسم السابق.

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--

استخدام مكتبات العملاء

توضّح نماذج الرموز التالية كيفية إجراء طلبات مجمّعة باستخدام مكتبات عملاء Google APIs. راجع أدلة البدء السريع ذات الصلة لمزيد من المعلومات حول كيفية تثبيت المكتبات وإعدادها.

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);