يوضّح هذا المستند كيفية تجميع طلبات واجهة برمجة التطبيقات معًا لتقليل عدد الاتصالات التي يجب أن يجريها العميل. يمكن أن تؤدي ميزة "المعالجة المجمّعة" إلى تحسين فعالية التطبيق عن طريق تقليل عدد عمليات التنقّل بين الخادم والعملاء وزيادة معدل نقل البيانات.
نظرة عامة
يؤدي كل اتصال يجريه برنامجك إلى زيادة في وقت الاستجابة. تتيح Google Docs API تجميع الطلبات للسماح لعميلك بوضع عدة عناصر طلب، يحدّد كلّ منها نوعًا واحدًا من الطلبات المطلوب تنفيذه، في طلب مجمّع واحد. يمكن أن يؤدي طلب الحزمة إلى تحسين الأداء من خلال دمج طلبات فرعية متعددة في طلب واحد إلى الخادم، واسترداد ردّ واحد.
ونشجّع المستخدمين على تجميع طلبات متعددة معًا دائمًا. في ما يلي بعض الأمثلة على الحالات التي يمكنك فيها استخدام ميزة "تجميع الطلبات":
- إذا كنت قد بدأت للتو في استخدام واجهة برمجة التطبيقات ولديك الكثير من البيانات المطلوب تحميلها
- تحتاج إلى تعديل البيانات الوصفية أو الخصائص، مثل التنسيق، في عناصر متعددة.
- عليك حذف العديد من العناصر.
اعتبارات الحدود والتفويض والتبعية
في ما يلي قائمة بالعناصر الأخرى التي يجب مراعاتها عند استخدام ميزة "التحديث المجمّع":
- يتم احتساب كل طلب مجمّع، بما في ذلك جميع الطلبات الفرعية، كطلب واحد من واجهة برمجة التطبيقات ضمن الحد الأقصى للاستخدام.
- تتم مصادقة طلب الحزمة مرة واحدة. تنطبق عملية المصادقة هذه على جميع عناصر التعديل المجمّع في الطلب.
- يعالج الخادم الطلبات الفرعية بالترتيب نفسه الذي تظهر به في طلب الدفعة. يمكن أن تعتمد الطلبات الفرعية اللاحقة على الإجراءات التي تم اتّخاذها أثناء الطلبات الفرعية السابقة. على سبيل المثال، في طلب الحزمة نفسه، يمكن للمستخدمين إدراج نص في مستند حالي ثم تنسيقه.
تفاصيل الدفعة
يتألّف الطلب المجمّع من طلب واحد لاستدعاء طريقة batchUpdate
مع طلبات فرعية متعددة، مثل إضافة مستند ثم تنسيقه.
يتم التحقّق من كل طلب قبل تطبيقه. يتم تطبيق جميع الطلبات الفرعية في تحديث الحزمة بشكل موحّد. وهذا يعني أنّه إذا لم يكن أي طلب صالحًا، لن يتم إكمال التعديل بالكامل ولن يتم تطبيق أي من التغييرات (التي قد تكون متعلّقة).
تقدّم بعض الطلبات ردودًا تتضمّن معلومات عن الطلبات التي تمّ تقديمها. على سبيل المثال، تُرسِل جميع طلبات التعديل المجمّع لإضافة عناصر ردود حتى تتمكّن من الوصول إلى البيانات الوصفية للعنصر الذي تمت إضافته حديثًا، مثل المعرّف أو العنوان.
باستخدام هذا النهج، يمكنك إنشاء مستند Google كامل باستخدام طلب تحديث مجمّع واحد لواجهة برمجة التطبيقات يتضمّن طلبات فرعية متعددة.
تنسيق طلب الحزمة
الطلب هو طلب JSON واحد يحتوي على عدة طلبات فرعية
مضمّنة تتضمّن سمة واحدة مطلوبة: requests
. يتم إنشاء طلبات
في صفيف من الطلبات الفردية. يستخدم كل طلب
تنسيق JSON لتمثيل عنصر الطلب وتضمين خصائصه.
تنسيق ردّ الدفعة
يشبه تنسيق الردّ لطلب الحزمة تنسيق الطلب. يحتوي ردّ الخادم على ردّ كامل لعنصر الاستجابة الفردي.
سمة عنصر JSON الرئيسي هي replies
. يتم عرض الاستجابات
في صفيف، مع احتلال كل استجابة لأحد الطلبات
ترتيب الفهرس نفسه للطلب المقابل. لا تتضمّن بعض الطلبات
ردودًا، ويكون الردّ في فهرس الصفيف هذا فارغًا.
مثال
يعرض نموذج الرمز البرمجي التالي استخدام ميزة تجميع الطلبات مع Docs API.
الطلب
يوضّح مثال طلب الحزمة هذا كيفية إجراء ما يلي:
أدخِل النص "مرحبًا بك" في بداية مستند حالي، مع
location
فهرس1
، باستخدامInsertTextRequest
.عدِّل كلمة "مرحبًا" باستخدام
UpdateTextStyleRequest
. تحدِّدstartIndex
وendIndex
range
للنص المنسَّق ضمن القطعة.باستخدام
textStyle
، اضبط نمط الخط على غامق واللون على أزرق لكلمة "مرحبًا" فقط.باستخدام الحقل
WriteControl
، يمكنك التحكّم في طريقة تنفيذ طلبات الكتابة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة Establish state consistency with WriteControl.
{ "requests":[ { "insertText":{ "location":{ "index":1, "tabId":TAB_ID }, "text":"Hello World" } }, { "updateTextStyle":{ "range":{ "startIndex":1, "endIndex":6 }, "textStyle":{ "bold":true, "foregroundColor":{ "color":{ "rgbColor":{ "blue":1 } } } }, "fields":"bold,foreground_color" } } ], "writeControl": { "requiredRevisionId": "REQUIRED_REVISION_ID" } }
استبدِل TAB_ID وREQUIRED_REVISION_ID بقيمة معرّف علامة التبويب ومعرّف المراجعة، على التوالي، للمستند الذي يتم تطبيق طلب الكتابة عليه.
الردّ
يعرض مثال الاستجابة للدفعة هذه معلومات عن كيفية تطبيق كل طلب فرعي ضمن
طلب الدفعة. لا يحتوي كل من
InsertTextRequest
أو
UpdateTextStyleRequest
على استجابة، لذا تتألف قيم الفهرس للصفيف في [0] و[1] من قوسين معقوفين فارغين. يعرض الطلب المجمّع عنصر WriteControl
،
الذي يوضّح كيفية تنفيذ الطلبات.
{ "replies":[ {}, {} ], "writeControl":{ "requiredRevisionId":`REQUIRED_REVISION_ID` }, "documentId":`DOCUMENT_ID` }