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
syncToken string โทเค็นที่ได้จากฟิลด์ nextSyncToken ซึ่งแสดงในหน้าผลลัพธ์สุดท้ายจากคำขอรายการก่อนหน้า ซึ่งจะทำให้ผลลัพธ์ของคำขอรายการนี้มีเฉพาะรายการที่มีการเปลี่ยนแปลงนับตั้งแต่นั้นเป็นต้นมา หากมีการเปลี่ยนแปลงเฉพาะช่องแบบอ่านอย่างเดียว เช่น พร็อพเพอร์ตี้ของปฏิทินหรือ ACL ระบบจะไม่แสดงผลรายการ รายการทั้งหมดที่ถูกลบและซ่อนตั้งแต่คำขอรายการก่อนหน้าจะอยู่ในชุดผลลัพธ์เสมอ และไม่อนุญาตให้ตั้งค่า showDeleted หรือ showHidden เป็น False
เพื่อความสอดคล้องของสถานะไคลเอ็นต์ minAccessRole ต้องไม่ระบุพารามิเตอร์การค้นหาร่วมกับ 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 ด้านล่างเพื่อเรียกเมธอดนี้ในข้อมูลสดและดูการตอบกลับ