إرسال طلبات مجمّعة

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

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

نظرة عامة

ينتج عن كل اتصال HTTP ينتج عنه قدر معيّن من النفقات العامة. تتيح واجهة برمجة التطبيقات Google Search Console ميزة التجميع للسماح لعميلك بإدخال طلبات بيانات متعددة من واجهة برمجة التطبيقات في طلب HTTP واحد.

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

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

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

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

ملاحظة: يستخدم النظام المجمّع لواجهة برمجة التطبيقات Google Search Console البنية نفسها المستخدمة في نظام المعالجة المجمّعة لبيانات OData، ولكن تختلف دلالات الألفاظ.

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

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

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

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

الطلب المجمّع هو طلب HTTP عادي واحد يحتوي على طلبات متعددة من Google Search Console API، وذلك باستخدام نوع المحتوى 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-، كما هو موضّح في المثال التالي.

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

مثال

يوضح المثال التالي استخدام التجميع باستخدام واجهة برمجة تطبيقات تجريبية عامة (خيالية) تسمى Farm API. يُرجى العِلم أنّ المفاهيم نفسها تنطبق على Google Search Console API.

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

POST /batch/farm/v1 HTTP/1.1
Authorization: Bearer your_auth_token
Host: www.googleapis.com
Content-Type: multipart/mixed; boundary=batch_foobarbaz
Content-Length: total_content_length

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item1:[e-mail]>

GET /farm/v1/animals/pony

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item2:[e-mail]>

PUT /farm/v1/animals/sheep
Content-Type: application/json
Content-Length: part_content_length
If-Match: "etag/sheep"

{
  "animalName": "sheep",
  "animalAge": "5"
  "peltColor": "green",
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item3:[e-mail]>

GET /farm/v1/animals
If-None-Match: "etag/animals"

--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:[e-mail]>

HTTP/1.1 200 OK
Content-Type application/json
Content-Length: response_part_1_content_length
ETag: "etag/pony"

{
  "kind": "farm#animal",
  "etag": "etag/pony",
  "selfLink": "/farm/v1/animals/pony",
  "animalName": "pony",
  "animalAge": 34,
  "peltColor": "white"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item2:[e-mail]>

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: response_part_2_content_length
ETag: "etag/sheep"

{
  "kind": "farm#animal",
  "etag": "etag/sheep",
  "selfLink": "/farm/v1/animals/sheep",
  "animalName": "sheep",
  "animalAge": 5,
  "peltColor": "green"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item3:[e-mail]>

HTTP/1.1 304 Not Modified
ETag: "etag/animals"

--batch_foobarbaz--