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

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

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

ผู้ชม

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

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

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

Google Sites Data API มีฟีดประเภทต่อไปนี้

ฟีดกิจกรรม

ฟีดกิจกรรมเป็นฟีดที่มีรายละเอียดของกิจกรรมทั้งหมดภายในเว็บไซต์

URI GET ของฟีดนี้สำหรับเว็บไซต์ภายในโดเมนหนึ่งคือ:

https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]

domainName เป็น "เว็บไซต์" หรือโดเมน G Suite ก็ได้

siteName เป็นชื่อเว็บไซต์ตามที่ปรากฏใน URL ของหน้า Landing Page ของเว็บไซต์: http://sites.google.com/a/domainName/siteName/

คำขอทั้งหมดที่ส่งไปยังฟีดนี้ต้องผ่านการตรวจสอบสิทธิ์

ประเภทคำขอที่รองรับ: GET

ฟีดเนื้อหา

ฟีดเนื้อหาคือฟีดที่มีเนื้อหาของเว็บไซต์ปัจจุบันซึ่งแก้ไขได้

URI GET ของฟีดนี้สำหรับเว็บไซต์ภายในโดเมนหนึ่งคือ:

https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]

domainName เป็น "เว็บไซต์" หรือโดเมน G Suite ก็ได้

siteName เป็นชื่อเว็บไซต์ตามที่ปรากฏใน URL ของหน้า Landing Page ของเว็บไซต์: http://sites.google.com/a/domainName/siteName

คำขอในฟีดนี้อาจต้องมีการตรวจสอบสิทธิ์หรือไม่ก็ได้ ทั้งนี้ขึ้นอยู่กับการตั้งค่า (เผยแพร่แล้ว) ของเว็บไซต์

ประเภทคำขอที่รองรับ: GET, POST, PUT, DELETE

นอกจากพารามิเตอร์การค้นหา Data API มาตรฐานแล้ว Sites Data API ยังอนุญาตให้ใช้พารามิเตอร์ที่ไม่บังคับต่อไปนี้ที่ส่งคำขอ GET โดยใช้ฟีดเนื้อหา

พารามิเตอร์ คำอธิบาย ประเภท Notes
ancestor ขอเฉพาะรายการที่มีระดับบนที่ระบุไว้ สตริง ระบุรหัสของรายการระดับบนที่ต้องการ เช่น 0123456789 แสดงผลรายการทั้งหมดที่มีระดับบนที่ระบุเป็นระดับบนสุด ระดับบนสุดของระดับบน และอื่นๆ
include-deleted ระบุว่าจะรวมรายการที่ถูกลบหรือไม่ boolean ค่าที่เป็นไปได้คือ true หรือ false ค่าเริ่มต้นคือ false
include-draft ระบุว่าจะรวมรายการฉบับร่างหรือไม่ boolean ค่าที่เป็นไปได้คือ true หรือ false ค่าเริ่มต้นคือ false คุณต้องเป็นเจ้าของหรือผู้เขียนแบบร่างเพื่อดู
kind ระบุประเภทของรายการเนื้อหาที่จะแสดง ซึ่งเป็นไปตามประเภทของหน้าเว็บภายใน Google Sites รายการสตริงที่คั่นด้วยคอมมา ค่าที่เป็นไปได้คือ announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template
parent ขอเฉพาะรายการที่มีระดับบนสุดที่ระบุ สตริง ระบุรหัสของรายการหลัก เช่น 0123456789
path ขอเนื้อหาภายใต้ลําดับชั้นของหน้าเว็บหนึ่งๆ สตริง เส้นทางไปยังหน้าย่อยภายในเว็บไซต์เพื่อดึงเนื้อหา เช่น path=/path/to/page

ฟีดการแก้ไข

ฟีดการแก้ไขคือฟีดที่มีการแก้ไขเนื้อหาเว็บไซต์ตามประวัติที่ผ่านมา

URI GET ของฟีดนี้สำหรับเว็บไซต์ภายในโดเมนหนึ่งคือ:

https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]

domainName เป็น "เว็บไซต์" หรือโดเมน G Suite ก็ได้

siteName เป็นชื่อเว็บไซต์ตามที่ปรากฏใน URL ของหน้า Landing Page ของเว็บไซต์: http://sites.google.com/a/domainName/siteName

คำขอทั้งหมดที่ส่งไปยังฟีดนี้ต้องผ่านการตรวจสอบสิทธิ์

ประเภทคำขอที่รองรับ: GET

ฟีดของเว็บไซต์

ฟีดของเว็บไซต์สามารถใช้เพื่อแสดงรายการ Google Sites ที่ผู้ใช้เป็นเจ้าของหรือมีสิทธิ์ดู นอกจากนี้ ยังใช้เพื่อสร้างเว็บไซต์ใหม่ คัดลอกเว็บไซต์ หรือแก้ไขชื่อเว็บไซต์ที่มีอยู่ได้ด้วย

URI ของฟีดสำหรับรายการ Sites คือ:

https://sites.google.com/feeds/site/domainName/[siteName]

domainName เป็น "เว็บไซต์" หรือโดเมน G Suite ก็ได้

คำขอทั้งหมดที่ส่งไปยังฟีดนี้ต้องผ่านการตรวจสอบสิทธิ์

ประเภทคำขอที่รองรับ: GET, POST, PUT

ฟีดเว็บไซต์รองรับพารามิเตอร์ (ไม่บังคับ) ต่อไปนี้เมื่อส่งคําขอ GET สําหรับรายการเว็บไซต์

พารามิเตอร์ คำอธิบาย ประเภท Notes
include-all-sites แสดงรายการเว็บไซต์ทั้งหมดที่ผู้ใช้ในโดเมน G Suite ดูได้เป็นอย่างน้อย boolean พารามิเตอร์นี้ใช้เมื่อแสดงเว็บไซต์สำหรับโดเมน G Suite เท่านั้น ค่าที่เป็นไปได้คือ true หรือ false ค่าเริ่มต้นคือ false
with-mappings รวมการจับคู่ที่อยู่เว็บในรายการเว็บไซต์ boolean ค่าที่เป็นไปได้คือ true หรือ false ค่าเริ่มต้นคือ false

ฟีด ACL

ฟีด ACL สามารถใช้เพื่อแสดงรายการและ/หรือแก้ไขสิทธิ์การแชร์ (ACL) ของเว็บไซต์จาก Google Sites

URI ของฟีดสำหรับรายการ Sites คือ:

https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]

domainName เป็น "เว็บไซต์" หรือโดเมน G Suite ก็ได้

คำขอทั้งหมดที่ส่งไปยังฟีดนี้ต้องผ่านการตรวจสอบสิทธิ์

ประเภทคำขอที่รองรับ: GET, POST, PUT, DELETE

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

พารามิเตอร์การค้นหาที่รองรับจากโปรโตคอล Google Data API ได้แก่

  • max-results
  • published-max (เฉพาะฟีดเนื้อหา)
  • published-min (เฉพาะฟีดเนื้อหา)
  • start-index
  • updated-max
  • updated-min
  • q (การค้นหาข้อความแบบเต็ม)

โปรดดูแต่ละฟีดด้านบนสำหรับรายการพารามิเตอร์เฉพาะสำหรับฟีดนั้นๆ

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