Calendars: update

อัปเดตข้อมูลเมตาสำหรับปฏิทิน ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

PUT https://www.googleapis.com/calendar/v3/calendars/calendarId

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
calendarId string ตัวระบุปฏิทิน หากต้องการดึงข้อมูลรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบัน ให้ใช้คีย์เวิร์ด "primary"

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

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

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

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

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

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

ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
พร็อพเพอร์ตี้ที่ไม่บังคับ
description string คำอธิบายของปฏิทิน ไม่บังคับ เขียนได้
labelProperties nested object พร็อพเพอร์ตี้ป้ายกำกับที่กำหนดไว้ในปฏิทินนี้ หากระบุไว้ ระบบจะเขียนทับพร็อพเพอร์ตี้ป้ายกำกับที่มีอยู่ หากไม่ระบุ พร็อพเพอร์ตี้ของป้ายกำกับจะยังคงเหมือนเดิม เขียนได้
labelProperties.eventLabels[] list ป้ายกำกับกิจกรรมที่กำหนดไว้ในปฏิทินนี้ หากมีป้ายกำกับนี้เมื่ออัปเดตปฏิทิน ระบบจะแทนที่ป้ายกำกับกิจกรรมที่มีอยู่

ขยายรายการเพื่อเพิ่มป้ายกำกับกิจกรรมใหม่ และนำเอนทิตีออกจากรายการเพื่อลบป้ายกำกับออกจากปฏิทิน

ปฏิทินแต่ละรายการมีป้ายกำกับได้สูงสุด 200 รายการ

 เขียนได้
labelProperties.eventLabels[].backgroundColor string สีพื้นหลังของป้ายกำกับในรูปแบบเลขฐาน 16 เช่น "#039be5" กิจกรรมที่มีป้ายกำกับนี้จะแสดงเป็นสีนี้ ต้องระบุ เขียนได้
labelProperties.eventLabels[].id string รหัสของป้ายกำกับ ไม่บังคับเมื่อแทรกป้ายกำกับใหม่ หากไม่ได้ระบุ ระบบจะสร้างรหัสที่ไม่ซ้ำกัน ต้องระบุเมื่ออัปเดตป้ายกำกับ

หากระบุ รหัสต้องไม่ซ้ำกันภายในปฏิทินและเป็นไปตามรูปแบบ UUID

 เขียนได้
labelProperties.eventLabels[].name string ชื่อของป้ายกำกับ ไม่บังคับ

หากระบุไว้ ต้องมีอักขระไม่เกิน 50 ตัว

 เขียนได้
location string สถานที่ตั้งทางภูมิศาสตร์ของปฏิทินในรูปแบบข้อความอิสระ ไม่บังคับ เขียนได้
summary string ชื่อของปฏิทิน เขียนได้
timeZone string เขตเวลาของปฏิทิน (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลา IANA เช่น "Europe/Zurich") ไม่บังคับ เขียนได้
workingHours object แสดงข้อมูลเกี่ยวกับเวลาทำงานของผู้ใช้ ใช้ได้กับปฏิทินหลักของผู้ใช้ Google Workspace เท่านั้น หากต้องการอัปเดตเวลาทำงาน คุณต้องส่งออบเจ็กต์เวลาทำงานทั้งหมด หากไม่ได้ระบุ (หรือส่งเป็นค่าว่างหรือออบเจ็กต์ว่าง) เวลาทำการที่มีอยู่จะยังคงไม่เปลี่ยนแปลง หากต้องการปิดใช้เวลาทำงานหรือล้างกำหนดเวลา ให้ตั้งค่า workingHoursEnabled เป็นเท็จ (และละเว้น availableTimes หรือส่งรายการที่ว่างเปล่า) เขียนได้
workingHours.availableTimes[] list เวลาทำงาน ระยะเวลาที่พร้อมใช้งานแต่ละช่วงจะแสดงบล็อกเวลาทำงานของผู้ใช้ใน 1 วัน เขียนได้
workingHours.availableTimes[].dayOfWeek string วันของสัปดาห์ ต้องระบุ ค่าที่เป็นไปได้มีดังนี้
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
เขียนได้
workingHours.availableTimes[].periodEnd integer จุดสิ้นสุดของระยะเวลา โดยนับเป็นนาทีจากจุดเริ่มต้นของวัน (ไม่รวมจุดสิ้นสุด) ต้องระบุ เขียนได้
workingHours.availableTimes[].periodStart integer จุดเริ่มต้นของระยะเวลา โดยนับเป็นนาทีจากจุดเริ่มต้นของวัน (รวมเวลาเริ่มต้น) ต้องระบุ เขียนได้
workingHours.workingHoursEnabled boolean ระบุว่ามีการเปิดใช้เวลาทำงานสำหรับปฏิทินนี้หรือไม่ ตั้งค่าเป็น "จริง" ไม่ได้เมื่อ availableTimes ว่างเปล่า เขียนได้

คำตอบ

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

ลองใช้งาน

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