طلبات مجمّعة

نظرة عامة

ينتج عن كل اتصال HTTP ينتج عنه قدر معيّن من النفقات العامة. تتيح People API ميزة التجميع لكي تتيح لعميلك إمكانية وضع عدة طلبات من واجهة برمجة التطبيقات في طلب HTTP واحد.

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

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

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

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

ملاحظة: يستخدم النظام المجمَّع لواجهة People API البنية نفسها المستخدَمة في نظام المعالجة المجمّعة لبيانات OData، ولكن تختلف دلالات ذلك النظام.

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

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

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

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

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

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

مثال

يوضح المثال التالي استخدام التجميع باستخدام People API.

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

POST /batch HTTP/1.1
accept-encoding: gzip, deflate
Authorization: Bearer your_auth_token
Content-Type: multipart/mixed; boundary="batch_people"
Content-Length: total_content_length


--batch_people
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 1

POST /v1/people:createContact HTTP/1.1
Content-Type: application/json
Content-Length: part_content_length
Accept: application/json
{
  "names": [{ "givenName": "John", "familyName": "Doe" }]
}

--batch_people
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 2

GET /v1/people/c123456789012345?personFields=emailAddresses HTTP/1.1
Accept: application/json
--batch_people--

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

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

HTTP/1.1 200 OK
Content-Type: multipart/mixed; boundary=batch_GOMozbDceUiJkwfCeHo28pGmhwRG5o50
Date: Tue, 22 Jan 2020 18:56:00 GMT
Expires: Tue, 22 Jan 2020 18:56:00 GMT
Cache-Control: private


--batch_GOMozbDceUiJkwfCeHo28pGmhwRG5o50
Content-Type: application/http
Content-ID: response-1

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
  "resourceName": "people/c11111111111111",
  "etag": "1111",
  "names": [{ "givenName": "John", "familyName": "Doe" }]
}

--batch_GOMozbDceUiJkwfCeHo28pGmhwRG5o50
Content-Type: application/http
Content-ID: response-2

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
  "resourceName": "people/c123456789012345",
  "etag": "1234",
  "emailAddresses": [{ "value": "jane.doe@gmail.com" }]
}
--batch_GOMozbDceUiJkwfCeHo28pGmhwRG5o50--