เอกสารนี้แสดงเอกสารอ้างอิงโดยละเอียดสำหรับโปรโตคอลดิบ (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
โดยใช้ฟีดเนื้อหา:
พารามิเตอร์ | คำอธิบาย | ประเภท | หมายเหตุ |
---|---|---|---|
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 ฟีดสำหรับรายการเว็บไซต์คือ
https://sites.google.com/feeds/site/domainName/[siteName]
domainName เป็น "เว็บไซต์" หรือโดเมน G Suite ก็ได้
คำขอทั้งหมดที่ส่งไปยังฟีดนี้ต้องผ่านการตรวจสอบสิทธิ์
ประเภทคำขอที่รองรับ: GET
, POST
, PUT
ฟีดเว็บไซต์รองรับพารามิเตอร์ต่อไปนี้ (ไม่บังคับ) เมื่อออกคำขอ GET
สำหรับข้อมูลเว็บไซต์
พารามิเตอร์ | คำอธิบาย | ประเภท | หมายเหตุ |
---|---|---|---|
include-all-sites |
แสดงรายการเว็บไซต์ทั้งหมดที่ผู้ใช้ในโดเมน G Suite ดูได้เป็นอย่างน้อย | boolean | พารามิเตอร์นี้ใช้ได้เฉพาะเมื่อแสดงเว็บไซต์สำหรับโดเมน G Suite ค่าที่เป็นไปได้คือ true
หรือ false ค่าเริ่มต้นคือ false |
with-mappings |
รวมการแมปที่อยู่เว็บในรายการเว็บไซต์ | boolean | ค่าที่เป็นไปได้คือ true หรือ false ค่าเริ่มต้นคือ false |
ฟีด ACL
คุณสามารถใช้ฟีด ACL เพื่อแสดงและ/หรือแก้ไขสิทธิ์การแชร์ (ACL) ของ Google Site
URI ฟีดสำหรับรายการเว็บไซต์คือ
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
(ข้อความค้นหาแบบเต็ม)
ดูรายการพารามิเตอร์เฉพาะสำหรับฟีดนั้นๆ ในแต่ละฟีดด้านบน