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

สำคัญ: เราจะหยุดรองรับ Google Data API เวอร์ชัน 2.0 ในวันที่ 30 กันยายน 2024 โปรดอัปเดตแอปพลิเคชันที่ใช้ Google Data API เวอร์ชัน 2.0 เป็น API เวอร์ชันล่าสุดเพื่อให้ใช้งานได้อย่างต่อเนื่อง หากต้องการดูเวอร์ชันล่าสุด ให้ใช้ลิงก์ในแถบนำทางด้านซ้าย หมายเหตุ: แม้ว่าคำขอ GET บางรายการ (เช่น โพสต์ข้อมูล) จะยังคงรองรับเป็น URL ฟีดต่อไป แต่ก็มีลักษณะการทำงานที่ต่างกันเล็กน้อย โปรดดูข้อมูลโดยละเอียดในเอกสารความช่วยเหลือเกี่ยวกับ Blogger

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

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

เนื้อหา

ผู้ชม

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

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

ประเภทฟีดของ Blogger

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

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

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

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

การอ้างอิงพารามิเตอร์การค้นหาของ Blogger

Blogger Data API รองรับพารามิเตอร์การค้นหาของ Google Data API แบบมาตรฐานเกือบทั้งหมด

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 Data API จะใช้องค์ประกอบ Atom แบบมาตรฐานเท่านั้น ดูข้อมูลเพิ่มเติมได้ที่ข้อกำหนดเกี่ยวกับรูปแบบการเผยแพร่ Atom 1.0 และโปรโตคอลการเผยแพร่ Atom Publishing

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

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

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

<entry xmlns:app='http://www.w3.org/2007/app'>
...
<app:control>
<app:draft>yes</app:draft>
</app:control>
</entry>

หากไม่ได้ระบุองค์ประกอบ <draft> รายการดังกล่าวจะไม่เป็นฉบับร่าง

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

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

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

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

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

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

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

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

นอกจากนี้ การลิงก์รายการความคิดเห็นกับโพสต์ของโพสต์นั้นยังดำเนินการผ่านส่วนขยาย Atom Threading อีกด้วย ในตัวอย่างด้านล่าง องค์ประกอบ <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 comment</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>

ข้อมูลอ้างอิงสคีมาฟีดของ Blogger

  1. ฟีดข้อมูลรายการบล็อก
  2. ฟีดบล็อกโพสต์
  3. ฟีดความคิดเห็นบนบล็อก
  4. ฟีดความคิดเห็นของบล็อกโพสต์

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