نظرة عامة على دليل مطوّر البرامج

تحذير: تتعلق هذه الصفحة بواجهات برمجة التطبيقات القديمة من Google، وهي واجهات برمجة التطبيقات لبيانات Google؛ وهي مرتبطة فقط بواجهات برمجة التطبيقات المدرجة في دليل Google Data APIs، والتي تم استبدال العديد منها بواجهات برمجة تطبيقات أحدث. للحصول على معلومات حول واجهة برمجة تطبيقات جديدة، اطلع على وثائق واجهة برمجة التطبيقات الجديدة. للحصول على معلومات حول تفويض الطلبات باستخدام واجهة برمجة تطبيقات أحدث، اطلع على مصادقة حسابات Google وتفويضها.

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

يوفر بروتوكول بيانات Google وسيلة آمنة لمطوري البرامج الخارجيين لكتابة تطبيقات جديدة تتيح للمستخدمين الدخول إلى البيانات المخزنة بواسطة العديد من منتجات Google وتحديثها. ويمكن لمطوّري البرامج الخارجيين استخدام بروتوكول بيانات Google مباشرةً أو استخدام أي من لغات البرمجة المتوافقة التي توفّرها مكتبات البرامج.

الجمهور

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

إذا كنت تبحث عن دليل مطور البرامج لواجهة برمجة تطبيقات معينة، فانتقل إلى دليل واجهة برمجة التطبيقات لبروتوكول Google Data.

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

الخلفية

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

ملاحظة: يُشار أحيانًا إلى منتجات Google التي توفر واجهات برمجة التطبيقات باسم الخدمات في هذه المستندات والمستندات الأخرى ذات الصلة.

إذا كتبت رمزًا يستخدم بروتوكول بيانات Google مباشرةً، سيدخل إلى واجهة برمجة التطبيقات باستخدام طلبات HTTP مثل GET أو POST. وباستخدام هذه الطلبات، يتم نقل البيانات المخزَّنة بواسطة منتج Google مرارًا وتكرارًا عبر السلك في شكل خلاصات بيانات. خلاصات البيانات هي ببساطة قوائم منظَّمة تحتوي على البيانات. في السابق، كان تنسيق الخلاصة الأساسيّ هو AtomPub XML، ولكنه أصبح الآن بتنسيق JSON أو JavaScript Object Notation كتنسيق بديل.

إذا كنت تفضّل عدم كتابة شفرة تُرسل طلبات HTTP مباشرةً، يمكنك بدلاً من ذلك برمجة تطبيق العميل باستخدام إحدى لغات البرمجة المتاحة في مجموعة مكتبات العملاء المتوفرة. وعند إجراء ذلك، تعالج مكتبة العميل تفاصيل طلبات HTTP؛ حيث تكتب الشفرة على مستوى أكثر تصورًا باستخدام الطرق والفئات المتعلقة باللغة التي توفرها مكتبة العميل.

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

إصدارات البروتوكول

بروتوكول الإصدار 2.0 في مقابل بروتوكول الإصدار 1.0

تم تطوير الإصدار الأول من بروتوكول Google Data قبل إنهاء بروتوكول النشر Atom. الإصدار الثاني من بروتوكول Google Data متوافق تمامًا مع معيار AtomPub RFC 5023.

يتضمن الإصدار 2.0 من بروتوكول بيانات Google أيضًا دعمًا لما يلي:

  • HTTP ETags. معيار ويب يساعد تطبيقات العميل على الاستفادة بشكل أفضل من التخزين المؤقت عبر HTTP. تعمل الخدمات المضمّنة في مكتبات البرامج التي تتوافق مع Protocol v2.0 على معالجة العلامات الإلكترونية تلقائيًا.
  • الاستجابة الجزئية والتحديث الجزئي (تجريبي). ميزات تتيح لك إجراء طلبات نقل بيانات أقل. ومن خلال طلب المعلومات التي تحتاج إليها فقط أو إرسال التحديثات التي تتضمن فقط البيانات التي تريد تغييرها فعليًا، يمكن أن يكون تطبيق العميل أكثر فعالية في استخدامه للشبكة ووحدة المعالجة المركزية وموارد الذاكرة. تتوفر الاستجابة الجزئية والتحديث الجزئي حاليًا لبعض المنتجات فقط. راجع الوثائق المتعلقة بالمنتج لمعرفة ما إذا كانت واجهة برمجة التطبيقات تتيح ذلك أم لا.

جارٍ تحديث طلبك

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

تحديث عميل مستند إلى مكتبة العميل

إذا كان تطبيق العميل يستخدم مكتبة برامج، مثل مكتبة برامج جافا أو مكتبة عميل NET.، فقد يحتوي على إصدار من واجهة برمجة التطبيقات التي تدعم ميزات الإصدار 2.0 من البروتوكول. لمعرفة ذلك، ارجع إلى وثائق واجهة برمجة التطبيقات لمنتج Google الذي تستخدمه لمعرفة ما إذا كان أي مما يلي صحيحًا:

  • هناك إصدار لواجهة برمجة التطبيقات يتوافق مع ميزات الإصدار 2.0 من بروتوكول Google Data.
  • تدعم مكتبة العميل التي تستخدمها إصدار واجهة برمجة التطبيقات هذا أيضًا.

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

تحديث برنامج HTTP أولي

إذا كتبت تطبيق العميل مباشرة باستخدام بروتوكول بيانات Google، فيجب إجراء هذه التغييرات:

  • طلبات النسخة غير الافتراضية. يمكنك إضافة عنوان إصدار HTTP (GData-Version: X.0) إلى كل طلب HTTP ترسله، حيث يكون X هو إصدار واجهة برمجة التطبيقات الذي يتوافق مع ميزات الإصدار 2.0 من بروتوكول Google Data. ويمكنك بدلاً من ذلك إضافة معلّمة طلب بحث (v=X.0) إلى عنوان URL لكل طلب، حيث يكون X هو النسخة الصحيحة من واجهة برمجة التطبيقات مرة أخرى. وفي حال عدم تحديد إصدار أحدث، سيتم إرسال طلباتك تلقائيًا إلى أقدم إصدار متوافق من واجهة برمجة التطبيقات.
  • التزامن المتفائل. إذا كنت تستخدم إصدارًا من واجهة برمجة تطبيقات يتوافق مع التفاؤل الإيجابي، قد تحتاج إلى تغيير التحديث وحذف الرمز لاستخدام أداة ETags. للحصول على مزيد من المعلومات، اطلع على قسم ETags لمستندات بروتوكول Google Data Protocol، واقرأ أقسام "التحديث والحذف" من دليل مطور البروتوكول للخدمة التي يستخدمها تطبيق العميل.
  • معرّفات الموارد المنتظمة (URI) الذاتية أو تعديلها. إذا كان البرنامج يتتبع بنفسك أو يُعدِّل معرّفات الموارد المنتظمة (URI) للخلاصات أو الإدخالات، لاحظ أنه ربما تم تغيير معرّفات الموارد المنتظمة (URI) هذه. للحصول على معرّف الموارد المنتظم الجديد، أعِد طلب العنصر باستخدام معرّف الموارد المنتظم القديم، ولكن ضَع علامة على الطلب كطلب الإصدار X.0، حيث تمثل القيمة X إصدار واجهة برمجة التطبيقات الذي يتوافق مع ميزات الإصدار 2.0 من بروتوكول Google Data. يعرض الخادم التمثيل الجديد للإدخال، بما في ذلك معرفات الموارد المنتظمة (URI) الجديدة التي يمكنك تخزينها بدلاً من معرفات الموارد القديمة.
  • معرفات الموارد المنتظمة (URI) لمساحة الاسم. إذا كان العميل يخزّن معرّفات الموارد المنتظمة (URI) لمساحة اسم بروتوكول Google Data Protocol محليًا أو إذا كانت لديه معرّفات غير ثابتة، عليك تعديلها:
    • تم تغيير مساحة الاسم AtomPub (البادئة app) من http://purl.org/atom/app إلى http://www.w3.org/2007/app.
    • تم تغيير مساحة الاسم OpenSearch (البادئة openSearch) من http://a9.com/-/spec/opensearchrss/1.0/ إلى http://a9.com/-/spec/opensearch/1.1/.