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

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

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

ผู้ชม

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

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

ประเภทฟีด Google Sites

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

ฟีดกิจกรรม

ฟีดกิจกรรมคือฟีดที่มีคำอธิบายกิจกรรมทั้งหมดภายในไซต์

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

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

domainName คือ "site" หรือโดเมน 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 คือ "site" หรือโดเมน G Suite

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

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

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

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

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

ฟีดการแก้ไข

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

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

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

domainName คือ "site" หรือโดเมน G Suite

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

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

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

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

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

URI ฟีดสำหรับรายการเว็บไซต์คือ

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

domainName คือ "site" หรือโดเมน G Suite

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

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

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

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

ฟีด ACL

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

URI ของฟีดสำหรับข้อมูลเว็บไซต์คือ

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

domainName คือ "site" หรือโดเมน G Suite

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

ประเภทคำขอที่รองรับ ได้แก่ GET, POST, PUT, DELETE

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

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

  • max-results
  • published-max (ฟีดเนื้อหาเท่านั้น)
  • published-min (ฟีดเนื้อหาเท่านั้น)
  • start-index
  • updated-max
  • updated-min
  • q (การค้นหาข้อความทั้งหมด)

ดูรายการพารามิเตอร์เฉพาะของฟีดนั้นๆ ได้ที่ฟีดแต่ละรายการด้านบน

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