CalendarList: list

แสดงปฏิทินในรายการปฏิทินของผู้ใช้ ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์การค้นหาที่ไม่บังคับ
maxResults integer จำนวนสูงสุดของรายการที่แสดงในหน้าผลการค้นหา 1 หน้า โดยค่าเริ่มต้น ค่าจะเป็น 100 รายการ ขนาดหน้าต้องไม่เกิน 250 รายการ ไม่บังคับ
minAccessRole string บทบาทการเข้าถึงขั้นต่ำของผู้ใช้ในรายการที่แสดง ไม่บังคับ ค่าเริ่มต้นคือไม่มีข้อจำกัด

โดยค่าที่ยอมรับมีดังต่อไปนี้
  • "freeBusyReader": ผู้ใช้สามารถอ่านข้อมูลว่าง/ไม่ว่าง
  • "owner": ผู้ใช้สามารถอ่านและแก้ไขกิจกรรม รวมถึงรายการควบคุมการเข้าถึง
  • "reader": ผู้ใช้สามารถอ่านกิจกรรมที่ไม่เป็นส่วนตัว
  • "writer": ผู้ใช้สามารถอ่านและแก้ไขกิจกรรม
  • "writerWithoutPrivateAccess": ผู้ใช้สามารถอ่านและแก้ไขกิจกรรมที่ไม่เป็นส่วนตัว ผู้ใช้สามารถอ่านข้อมูลว่าง/ไม่ว่างเกี่ยวกับกิจกรรมส่วนตัว ผู้ใช้ไม่สามารถแก้ไขกิจกรรมส่วนตัว
pageToken string โทเค็นที่ระบุหน้าผลการค้นหาที่จะแสดง ไม่บังคับ
showDeleted boolean เลือกว่าจะรวมรายการปฏิทินที่ถูกลบในผลการค้นหาหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False
showHidden boolean เลือกว่าจะแสดงรายการที่ซ่อนไว้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False
showOwnOrganizationOnly boolean เลือกว่าจะแสดงเฉพาะรายการสำหรับปฏิทินจากองค์กรหรือไม่ พารามิเตอร์นี้ใช้ได้กับผู้ใช้ Google Workspace เท่านั้น ไม่บังคับ ค่าเริ่มต้นคือ False
syncToken string โทเค็นที่ได้รับจากช่อง nextSyncToken ซึ่งแสดงในหน้าสุดท้ายของผลการค้นหาจากคำขอรายการก่อนหน้า โทเค็นนี้จะทำให้ผลการค้นหาของคำขอรายการนี้มีเฉพาะรายการที่มีการเปลี่ยนแปลงนับตั้งแต่นั้นเป็นต้นมา หากมีการเปลี่ยนแปลงเฉพาะช่องแบบอ่านอย่างเดียว เช่น พร็อพเพอร์ตี้ของปฏิทินหรือ ACL ระบบจะไม่แสดงรายการ รายการทั้งหมดที่ถูกลบและซ่อนนับตั้งแต่คำขอรายการก่อนหน้าจะอยู่ในชุดผลการค้นหาเสมอ และคุณไม่สามารถตั้งค่า showDeleted หรือ showHidden เป็น False ได้
พารามิเตอร์การค้นหา minAccessRole และ showOwnOrganizationOnly จะระบุร่วมกับ nextSyncToken ไม่ได้ เพื่อให้มั่นใจว่าสถานะของไคลเอ็นต์จะสอดคล้องกัน
หาก syncToken หมดอายุ เซิร์ฟเวอร์จะตอบกลับด้วยโค้ดตอบกลับ 410 GONE และไคลเอ็นต์ควรล้างพื้นที่เก็บข้อมูลและทำการซิงโครไนซ์แบบเต็มโดยไม่มี syncToken
ดูข้อมูลเพิ่มเติม เกี่ยวกับการซิงโครไนซ์แบบเพิ่มทีละรายการ
ไม่บังคับ ค่าเริ่มต้นคือแสดงรายการทั้งหมด

การให้สิทธิ์

คำขอนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตอย่างน้อย 1 รายการต่อไปนี้

ขอบเขต
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

ดูข้อมูลเพิ่มเติมได้ที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อความของคำขอ

อย่าระบุเนื้อความของคำขอด้วยเมธอดนี้

การตอบกลับ

หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับที่มีโครงสร้างดังต่อไปนี้

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
kind string ประเภทของคอลเล็กชัน ("calendar#calendarList")
etag etag ETag ของคอลเล็กชัน
nextPageToken string โทเค็นที่ใช้เข้าถึงหน้าถัดไปของผลการค้นหานี้ ระบบจะไม่แสดงโทเค็นนี้หากไม่มีผลการค้นหาเพิ่มเติม ซึ่งในกรณีนี้ระบบจะแสดง nextSyncToken
items[] list ปฏิทินที่อยู่ในรายการปฏิทินของผู้ใช้
nextSyncToken string โทเค็นที่ใช้ในภายหลังเพื่อดึงข้อมูลเฉพาะรายการที่มีการเปลี่ยนแปลงนับตั้งแต่แสดงผลการค้นหานี้ ระบบจะไม่แสดงโทเค็นนี้หากมีผลการค้นหาเพิ่มเติม ซึ่งในกรณีนี้ระบบจะแสดง nextPageToken

ลองใช้งาน

ใช้โปรแกรมสำรวจ API ด้านล่างเพื่อเรียกเมธอดนี้กับข้อมูลจริงและดูการตอบกลับ