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

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

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

กลุ่มเป้าหมาย

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

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

ประเภทฟีด 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

ฟีดเนื้อหา

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

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

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 Sites

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 (ข้อความค้นหาแบบเต็ม)

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

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