دليل مرجعي

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

يقدم هذا المستند مستندات مرجعية مفصّلة للبروتوكول الأولي (XML وHTTP) الخاص بواجهة برمجة تطبيقات Blogger Data API.

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

المحتويات

الجمهور

هذا المستند مخصص للمبرمجين الذين يريدون كتابة تطبيقات العميل التي يمكنها التفاعل مع Blogger.

وهو مستند مرجعي، ويُفترَض أنّك تفهم المفاهيم الواردة في دليل المطوّر، والأفكار العامة التي تستند إليها بروتوكول Google Data APIs.

أنواع خلاصات Blogger

توفر خدمة Blogger تمثيلين لمحتوى المدونة في الخلاصات: الخلاصات الكاملة وخلاصات الملخّصات. تحتوي الخلاصة الكاملة على مشاركات مدونة كاملة، بينما تحتوي الخلاصة الملخصة على مقتطف قصير لكل مشاركة.

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

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

ومع ذلك، عندما يرسل تطبيق العميل طلبًا تمت مصادقته، يتلقّى دائمًا خلاصة كاملة، بغض النظر عمّا حدّده مالك المدونة.

مرجع مَعلمات طلب البحث في Blogger

تتوافق واجهة برمجة التطبيقات Blogger Data API تقريبًا مع جميع مَعلمات طلبات البحث العادية في Google Data API.

لا يتيح Blogger استخدام المعلمتَين q (البحث النصي) وauthor.

يتم تجاهل مَعلمتَي طلب البحث updated-min وupdated-max ما لم يتم ضبط المَعلمة orderby على updated. على سبيل المثال، يسترد عنوان URL التالي جميع مشاركات المدونة التي تم تحديثها من 16 آذار (مارس) 2008 إلى 24 آذار (مارس) 2008:

http://www.blogger.com/feeds/blogID/posts/default?updated-min=2008-03-16T00:00:00&updated-max=2008-03-24T23:59:59&orderby=updated

مرجع عناصر Blogger

لا تستخدم Blogger Data API سوى عناصر Atom العادية. للمزيد من المعلومات، يمكنك الاطّلاع على مواصفات تنسيق مشاركة Atom 1.0 وبروتوكول Atom Publishing.

يقدّم الجزء المتبقّي من هذا القسم بعض الملاحظات المحدّدة حول استخدام Blogger لبعض العناصر العادية.

مسودة الإدخالات

تم وضع علامة على مسودة إدخال مدونة باستخدام عنصر الإضافة <app:draft> المحدّد في مستند بروتوكول نشر Atom. فيما يلي مثال على مسودة إدخال:

<entry xmlns:app='http://purl.org/atom/app#'>
...
<app:control>
<app:draft>yes</app:draft>
</app:control>
</entry>

إذا لم يتم تحديد عنصر <draft>، لن يكون الإدخال مسودة.

تواريخ النشر والتواريخ المعدّلة

يتوافق الطابع الزمني المقدَّم في عنصر Atom <published> العادي مع "تاريخ النشر" الذي يمكن للمستخدم ضبطه في واجهة المستخدم الرسومية في Blogger.

عندما ينشئ البرنامج إدخالاً جديدًا، إذا لم يحدّد العميل قيمة للسمة <published>، تضبط Blogger تاريخ نشر الإدخال على الوقت الحالي للخادم. عندما يعدّل العميل إدخالاً ولكنّه لا يحدّد قيمة <published>، يترك Blogger تاريخ نشر الإدخال وحده.

وإذا حدَّد العميل قيمة للعنصر <published> عند إنشاء إدخال أو تعديله، ستضبط Blogger تاريخ نشر الإدخال على القيمة المحدّدة. ويمكن أن يكون ذلك مفيدًا في مهام مثل استيراد الإدخالات القديمة من نظام تدوين آخر (مع الاحتفاظ بتواريخ الإنشاء الأصلية).

يستخدم Blogger عنصر Atom <updated> العادي للإشارة إلى آخر مرة تم فيها تغيير أحد الإدخالات. لا يمكن لبرنامجك التحكّم في قيمة <updated>، لأنّ Blogger دائمًا ما تضبط تاريخ آخر تعديل للإدخال على وقت الخادم الحالي كلما نشر العميل إدخالاً أو يعدّله.

يمكنك استخدام معلَمات طلب البحث العادية في Google Data API published-min وpublished-max وupdated-min وupdated-max لطلب إدخالات استنادًا إلى قيمها <published> أو <updated>. ومع ذلك، للاطّلاع على ملاحظات حول طلب البحث عن تواريخ معدّلة، اطّلِع على مرجع مَعلمات طلب البحث في Blogger.

ربط التعليقات بالمشاركات

يحتوي تنسيق التصدير على Blogger على إدخالات المشاركات والتعليقات في مستند خلاصة Atom واحد. للتمييز بين نوعَي الإدخالات، يستخدم Blogger العنصر <atom:category>. سيحتوي هذا العنصر على المعلَمة term التي تعكس ما إذا كان الإدخال يخص مشاركة أو تعليقًا.

إضافةً إلى ذلك، يتم ربط إدخال التعليق بإدخال المشاركة التي ينتمي إليها من خلال استخدام إضافة سلاسل محادثات Atom. في المثال أدناه، سيشير العنصر <thr:in-reply-to> في إدخال التعليق إلى المشاركة باستخدام معرّف إدخال المشاركة في المعلَمة ref. ويتضمّن أيضًا رابطًا يؤدي إلى عنوان URL الخاص بملف HTML الخاص بالمشاركة من خلال المَعلمة href.

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"
      xmlns:thr="http://purl.org/syndication/thread/1.0">
  ...

  <-- A blog post entry -->
  <entry>
    <id>tag:blogger.com,1999:blog-blogID.post-postID</id>
    <content type="html">This is my first post</content>
    <link rel="alternate" type="text/html"
      href="http://blogName.blogspot.com/2007/04/first-post.html">
    </link>
    <category scheme="http://schemas.google.com/g/2005#kind" 
              term="http://schemas.google.com/blogger/2008/kind#post"/>
    ...
  </entry>

  <-- A comment to the blog post entry -->
  <entry>
    <id>tag:blogger.com,1999:blog-blogID.post-postID.comment-commentID</id>
    <content type="html">This is my first commment</content>
    <category scheme="http://schemas.google.com/g/2005#kind" 
              term="http://schemas.google.com/blogger/2008/kind#comment"/>
    <thr:in-reply-to href="http://blogName.blogspot.com/2007/04/first-post.html" 
                     ref="tag:blogger.com,1999:blog-blogID.post-postID" 
                     type="text/html"/>
    ...
  </entry>
</feed>

الرجوع إلى الأعلى