CalendarList: update

หมายเหตุ: ต้องให้สิทธิ์

อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้ ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์	ค่า	คำอธิบาย
พารามิเตอร์เส้นทาง
calendarId	string	ตัวระบุปฏิทิน หากต้องการเรียกข้อมูลรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบัน ให้ใช้คีย์เวิร์ด "primary"
พารามิเตอร์การค้นหาที่ไม่บังคับ
colorRgbFormat	boolean	ระบุว่าจะใช้ช่อง foregroundColor และ backgroundColor เพื่อเขียนสีปฏิทิน (RGB) หรือไม่ หากใช้ฟีเจอร์นี้ ระบบจะตั้งค่าช่อง colorId ตามดัชนีเป็นตัวเลือกที่ตรงกันที่สุดโดยอัตโนมัติ ไม่บังคับ ค่าเริ่มต้นคือ False

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

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

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

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

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

ในเนื้อหาคำขอ ให้ระบุทรัพยากร CalendarList ที่มีพร็อพเพอร์ตี้ต่อไปนี้

ชื่อพร็อพเพอร์ตี้	ค่า	คำอธิบาย	หมายเหตุ
พร็อพเพอร์ตี้ที่ไม่บังคับ
backgroundColor	string	สีหลักของปฏิทินในรูปแบบฐานสิบหก "#0088aa" พร็อพเพอร์ตี้นี้จะแทนที่พร็อพเพอร์ตี้ colorId ตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนพร็อพเพอร์ตี้นี้ คุณต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ	เขียนได้
colorId	string	สีของปฏิทิน รหัสนี้หมายถึงรายการในส่วน calendar ของคำจำกัดความสี (ดูปลายทางสี) พร็อพเพอร์ตี้นี้ถูกแทนที่โดยพร็อพเพอร์ตี้ backgroundColor และ foregroundColor และระบบจะไม่สนใจเมื่อใช้พร็อพเพอร์ตี้เหล่านี้ ไม่บังคับ	เขียนได้
defaultReminders[]	list	การช่วยเตือนเริ่มต้นที่ผู้ใช้ที่ตรวจสอบสิทธิ์มีสำหรับปฏิทินนี้	เขียนได้
defaultReminders[].method	string	วิธีการที่ใช้โดยการช่วยเตือนนี้ ค่าที่เป็นไปได้มีดังนี้ "email" - ระบบจะส่งการช่วยเตือนทางอีเมล "popup" - ระบบจะส่งการช่วยเตือนผ่านป๊อปอัป UI ต้องระบุเมื่อเพิ่มการช่วยเตือน	เขียนได้
defaultReminders[].minutes	integer	จำนวนนาทีก่อนเริ่มกิจกรรมที่การช่วยเตือนควรทริกเกอร์ ค่าที่ใช้ได้คือระหว่าง 0 ถึง 40320 (4 สัปดาห์เป็นนาที) ต้องระบุเมื่อเพิ่มการช่วยเตือน	เขียนได้
foregroundColor	string	สีพื้นหน้าของปฏิทินในรูปแบบฐานสิบหก "#ffffff" พร็อพเพอร์ตี้นี้จะแทนที่พร็อพเพอร์ตี้ colorId ตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนพร็อพเพอร์ตี้นี้ คุณต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ	เขียนได้
hidden	boolean	ปฏิทินถูกซ่อนจากรายการหรือไม่ ไม่บังคับ ระบบจะแสดงผลแอตทริบิวต์เมื่อปฏิทินซ่อนอยู่เท่านั้น ซึ่งในกรณีนี้ค่าจะเป็น true	เขียนได้
notificationSettings	object	การแจ้งเตือนที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วได้รับสำหรับปฏิทินนี้	เขียนได้
notificationSettings.notifications[].method	string	วิธีที่ใช้ในการส่งการแจ้งเตือน ค่าที่เป็นไปได้คือ "email" - ระบบจะส่งการแจ้งเตือนทางอีเมล ต้องระบุเมื่อเพิ่มการแจ้งเตือน	เขียนได้
notificationSettings.notifications[].type	string	ประเภทการแจ้งเตือน ค่าที่เป็นไปได้มีดังนี้ "eventCreation" - การแจ้งเตือนที่ส่งเมื่อมีการใส่กิจกรรมใหม่ในปฏิทิน "eventChange" - ส่งการแจ้งเตือนเมื่อมีการเปลี่ยนแปลงกิจกรรม "eventCancellation" - ส่งการแจ้งเตือนเมื่อมีการยกเลิกกิจกรรม "eventResponse" - การแจ้งเตือนที่ส่งเมื่อผู้เข้าร่วมตอบกลับคำเชิญเข้าร่วมกิจกรรม "agenda" - กำหนดการพร้อมกิจกรรมของวัน (ส่งในตอนเช้า) ต้องระบุเมื่อเพิ่มการแจ้งเตือน	เขียนได้
selected	boolean	เนื้อหาปฏิทินจะปรากฏใน UI ของปฏิทินหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False	เขียนได้
summaryOverride	string	สรุปที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วตั้งค่าไว้สำหรับปฏิทินนี้ ไม่บังคับ	เขียนได้

การตอบกลับ

หากดำเนินการสำเร็จ วิธีการนี้จะแสดงทรัพยากร CalendarList ในเนื้อหาการตอบกลับ

ลองใช้งาน

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