راهنمای مرجع

مهم : این نسخه قدیمی این صفحه است. برای آخرین نسخه، از پیوندهای موجود در نوار ناوبری سمت چپ استفاده کنید.

این سند مستندات مرجع مفصلی را برای پروتکل خام (XML و HTTP) برای Blogger Data API ارائه می دهد.

این سند حاوی اطلاعاتی درباره کتابخانه های کلاینت زبان برنامه نویسی نیست. برای اطلاعات مرجع کلاینت-کتابخانه، پیوندهای بخش‌های زبان برنامه‌نویسی راهنمای توسعه‌دهنده را ببینید.

فهرست

حضار

این سند برای برنامه نویسانی در نظر گرفته شده است که می خواهند برنامه های مشتری بنویسند که بتوانند با بلاگر تعامل داشته باشند.

این یک سند مرجع است. فرض بر این است که مفاهیم ارائه شده در راهنمای توسعه‌دهنده و ایده‌های کلی پشت پروتکل Google Data APIs را درک می‌کنید.

انواع فید بلاگر

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 Data API فقط از عناصر استاندارد Atom استفاده می کند. برای اطلاعات بیشتر، به مشخصات قالب سندیکای Atom 1.0 و پروتکل انتشار اتم مراجعه کنید.

بقیه این بخش چند یادداشت خاص در مورد استفاده بلاگر از برخی عناصر استاندارد ارائه می دهد.

پیش نویس ورودی ها

یک ورودی پیش‌نویس وبلاگ با استفاده از عنصر افزونه <app:draft> که در سند پروتکل انتشار اتم تعریف شده است، علامت‌گذاری می‌شود. در اینجا یک نمونه از یک ورودی پیش نویس آورده شده است:

<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 است. برای تمایز بین این دو نوع ورودی، بلاگر از عنصر <atom:category> استفاده می کند. این عنصر دارای یک پارامتر term است که نشان می دهد ورودی برای یک پست یا یک نظر است.

علاوه بر این، پیوند ورودی نظر به پستی که به آن تعلق دارد از طریق استفاده از Atom Threading Extension انجام می شود. در مثال زیر، عنصر <thr:in-reply-to> در ورودی نظر با استفاده از شناسه ورودی پست در پارامتر ref به پست اشاره می کند. همچنین از طریق پارامتر href به URL HTML پست پیوند می خورد.

<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>

بازگشت به بالا