يقدم هذا المستند وثائق مرجعية مفصلة عن البروتوكول الأولي (XML وHTTP) لواجهة برمجة تطبيقات Blogger للبيانات.
لا يحتوي هذا المستند على معلومات حول مكتبات العميل بلغة البرمجة. للحصول على معلومات مرجعية بمكتبة العميل، راجع الروابط من الأقسام الخاصة بلغة البرمجة في دليل مطوّري البرامج.
المحتويات
الجمهور
هذا المستند مخصّص للمبرمجين الذين يريدون كتابة تطبيقات عملاء يمكنها التفاعل مع Blogger.
ويمثّل هذا المستند مرجعًا ويفترض أنّك تفهم المفاهيم الواردة في دليل مطوّري البرامج والأفكار العامة التي تستند إليها بروتوكولات Google Data APIs.
أنواع خلاصات Blogger
توفّر Blogger تمثيلين لمحتوى المدونة في الخلاصات: الخلاصات الكاملة وخلاصات الملخّصات. تحتوي الخلاصة الكاملة على مشاركات كاملة للمدونة، بينما تحتوي الخلاصة التلخيصية على مقتطف قصير من كل مشاركة.
يمكن لمالك المدونة تحديد، باستخدام إعدادات واجهة المستخدم التصويرية، ما إذا كانت المدونة توفّر خلاصة كاملة أو خلاصة ملخّصة للموزّعين والعارضين.
عندما يرسل تطبيق العميل طلبًا غير مصادَق عليه لخلاصة، يتلقّى أي نوع من الخلاصات التي حدّدها مالك المدونة.
وعند إرسال تطبيق العميل طلبًا تمت مصادقته، يتلقّى دائمًا خلاصة كاملة، بغض النظر عن ما حدّده مالك المدونة.
مرجع معلمات طلب البحث في Blogger
تتوافق واجهة برمجة تطبيقات Blogger Data API مع كل معلّمات طلب البحث في واجهة برمجة تطبيقات البيانات العادية من Google.
لا يتيح Blogger استخدام المعلمة 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 عناصر Atom العادية فقط. لمزيد من المعلومات، يمكنك الاطّلاع على مواصفات تنسيق المشاركة Atom 1.0 وبروتوكول النشر Atom.
يقدم الجزء المتبقي من هذا القسم ملاحظتين محددتين حول استخدام Blogger لبعض العناصر القياسية.
مسودات الإدخالات
يتم وضع علامة على مسودة إدخال المدونة باستخدام عنصر الإضافة <app:draft>
المحدّد في مستند بروتوكول Atom Publish. في ما يلي مثال على إدخال مسودة:
<entry xmlns:app='http://www.w3.org/2007/app'> ... <app:control> <app:draft>yes</app:draft> </app:control> </entry>
إذا لم يتم تحديد عنصر <draft>، لا يكون الإدخال مسودة.
تواريخ النشر والتواريخ المعدّلة
يتطابق الطابع الزمني المحدّد في عنصر Atom <published>
العادي مع "post;post date" التي يمكن للمستخدم ضبطها في
واجهة برمجة تطبيقات Blogger.
عندما ينشئ البرنامج إدخالاً جديدًا، إذا لم يحدِّد العميل قيمة <published>، سيضبط Blogger تاريخ نشر الإدخال على وقت الخادم الحالي. عندما يعدّل عميلك إدخالاً ولكنه لا يحدّد قيمة <published>، يترك Blogger المدوّنة تاريخ نشر الإدخال وحده.
وإذا حدّد العميل قيمة للعنصر <published> عند إنشاء إدخال أو تعديله، ستضبط خدمة Blogger تاريخ نشر الإدخال على القيمة المحدّدة. ويمكن أن يكون ذلك مفيدًا لمهام مثل استيراد إدخالات قديمة من نظام تدوين آخر (مع الاحتفاظ بتواريخ الإنشاء الأصلية).
يستخدم Blogger عنصر Atom <updated> العادي
للإشارة إلى آخر مرة تم فيها إدخال إدخال. لا يمكن لعميلك التحكّم في
قيمة <updated>، لأنّ Blogger يحدِّد دائمًا تاريخ آخر إدخال تم تعديله بتاريخ الوقت الحالي على الخادم عندما ينشر العميل إدخالاً
أو يعدّله.
يمكنك استخدام معلّمات طلب البحث العادية من Google Data 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/opensearch/1.1/"
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>