คู่มือข้อมูลอ้างอิง

สำคัญ: หน้านี้เป็นเวอร์ชันเก่า สำหรับเวอร์ชันล่าสุด ให้ใช้ลิงก์ในแถบนำทางด้านซ้าย

เอกสารนี้ให้เอกสารอ้างอิงโดยละเอียดสำหรับโปรโตคอลดิบ (XML และ HTTP) สำหรับ Blogger Data API

เอกสารนี้ไม่มีข้อมูลเกี่ยวกับไลบรารีของไคลเอ็นต์ภาษาโปรแกรม สำหรับข้อมูลอ้างอิงไลบรารีของไคลเอ็นต์ โปรดดูลิงก์จากส่วนเฉพาะภาษาโปรแกรมในคู่มือของนักพัฒนาซอฟต์แวร์

เนื้อหา

ผู้ชม

เอกสารนี้มีไว้สำหรับโปรแกรมเมอร์ที่ต้องการเขียนแอปพลิเคชันไคลเอ็นต์ที่สามารถโต้ตอบกับ Blogger ได้

เอกสารนี้เป็นเอกสารอ้างอิงที่มีสมมติฐานว่าคุณเข้าใจแนวคิดที่นำเสนอในคู่มือสำหรับนักพัฒนาซอฟต์แวร์และแนวคิดทั่วไปเบื้องหลังโปรโตคอล Google Data API

ประเภทฟีด Blogger

Blogger นำเสนอเนื้อหาของบล็อกในฟีด 2 แบบ ได้แก่ ฟีดแบบสมบูรณ์และฟีดสรุป ฟีดแบบสมบูรณ์ประกอบด้วยบล็อกโพสต์แบบเต็ม ในขณะที่ฟีดสรุปจะมีเพียงตัวอย่างสั้นๆ ของแต่ละโพสต์

เจ้าของบล็อกสามารถระบุโดยใช้การตั้งค่า GUI โดยกำหนดว่าบล็อกจะมีฟีดแบบสมบูรณ์หรือฟีดสรุปสำหรับผู้เผยแพร่เนื้อหาและผู้รวบรวมข้อมูล

เมื่อแอปไคลเอ็นต์ส่งคำขอที่ไม่มีการตรวจสอบสิทธิ์สำหรับฟีด แอปจะได้รับฟีดประเภทใดก็ตามที่เจ้าของบล็อกระบุไว้

แต่เมื่อแอปไคลเอ็นต์ส่งคำขอที่ตรวจสอบสิทธิ์แล้ว แอปจะได้รับฟีดแบบเต็มเสมอไม่ว่าเจ้าของบล็อกจะระบุอะไรไว้

การอ้างอิงพารามิเตอร์การค้นหาของ 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 Protocol

เนื้อหาที่เหลือของส่วนนี้จะแสดงหมายเหตุเกี่ยวกับการใช้งานองค์ประกอบมาตรฐานบางรายการของ Blogger

รายการฉบับร่าง

รายการบล็อกฉบับร่างมีการทำเครื่องหมายโดยใช้องค์ประกอบส่วนขยาย <app:draft> ที่กำหนดไว้ในเอกสาร Atom Publishing Protocol ต่อไปนี้คือตัวอย่างของรายการฉบับร่าง

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

หากไม่ได้ระบุเอลิเมนต์ <draft> รายการดังกล่าวจะไม่ใช่ฉบับร่าง

วันที่ตีพิมพ์และวันที่ที่อัปเดต

การประทับเวลาที่ให้ไว้ในองค์ประกอบ <published> ของ Atom มาตรฐานสอดคล้องกับ "วันที่โพสต์" ที่ผู้ใช้ตั้งค่าได้ใน GUI ของ Blogger

เมื่อไคลเอ็นต์สร้างรายการใหม่ หากไคลเอ็นต์ไม่ได้ระบุค่าสำหรับ <published> ทาง Blogger จะกำหนดวันที่โพสต์ของรายการตามเวลาของเซิร์ฟเวอร์ปัจจุบัน เมื่อลูกค้าแก้ไขรายการแต่ไม่ได้ระบุค่า <published> Blogger จะปล่อยวันที่โพสต์ของรายการไว้แต่เพียงผู้เดียว

อย่างไรก็ตาม หากลูกค้าระบุค่าสำหรับองค์ประกอบ <published> เมื่อสร้างหรือแก้ไขรายการ บล็อกเกอร์จะตั้งค่าวันที่โพสต์ของรายการเป็นค่าที่ระบุ ซึ่งจะเป็นประโยชน์สำหรับงานต่างๆ เช่น การนำเข้ารายการเก่าจากระบบการเขียนบล็อกอื่น (โดยที่ยังเก็บวันที่สร้างเดิมไว้)

Blogger ใช้องค์ประกอบ <updated> ของ Atom มาตรฐานเพื่อระบุว่ารายการมีการเปลี่ยนแปลงครั้งล่าสุดเมื่อใด ไคลเอ็นต์ของคุณควบคุมค่า <updated> ไม่ได้ Blogger จะกำหนดวันที่อัปเดตล่าสุดของรายการให้เป็นเวลาปัจจุบันของเซิร์ฟเวอร์ทุกครั้งที่ไคลเอ็นต์ของคุณโพสต์หรือแก้ไขรายการ

คุณสามารถใช้พารามิเตอร์การค้นหา published-min, published-max, updated-min และ updated-max มาตรฐานของ Google Data API เพื่อขอรายการตามค่า <published> หรือ <updated> อย่างไรก็ตาม สำหรับหมายเหตุเกี่ยวกับการค้นหาในวันที่อัปเดต โปรดดูข้อมูลอ้างอิงพารามิเตอร์การค้นหาของ Blogger

การลิงก์ความคิดเห็นไปยังโพสต์

รูปแบบการส่งออกของ Blogger มีทั้งโพสต์และรายการความคิดเห็นในเอกสารฟีด Atom เดียว Blogger จะใช้องค์ประกอบ <atom:category> เพื่อแยกความแตกต่างระหว่างรายการทั้ง 2 ประเภท องค์ประกอบนี้จะมีพารามิเตอร์ 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>

กลับไปด้านบน