อัปเดตกิจกรรม วิธีการนี้ไม่สนับสนุนความหมายแพตช์และอัปเดตทรัพยากรเหตุการณ์ทั้งหมดเสมอ หากต้องการอัปเดตบางส่วน ให้ทํา get
ตามด้วย update
โดยใช้ etags เพื่อความสวยงาม
ลองใช้เลยหรือดูตัวอย่าง
ส่งคำขอ
คำขอ HTTP
PUT https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
พารามิเตอร์
ชื่อพารามิเตอร์ | ค่า | คำอธิบาย |
---|---|---|
พารามิเตอร์เส้นทาง | ||
calendarId |
string |
ตัวระบุปฏิทิน หากต้องการเรียกรหัสปฏิทิน ให้เรียกเมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ ให้ใช้คีย์เวิร์ด "primary "
|
eventId |
string |
ตัวระบุเหตุการณ์ |
พารามิเตอร์การค้นหาที่ไม่บังคับ | ||
alwaysIncludeEmail |
boolean |
เลิกใช้งานแล้วและไม่สนใจ ระบบจะแสดงผลข้อมูลในช่อง email สําหรับผู้จัด ผู้สร้าง และผู้เข้าร่วมเสมอ แม้ว่าจะไม่มีที่อยู่อีเมลจริงพร้อมใช้งานก็ตาม (เช่น ค่าที่ใช้ได้และไม่สามารถใช้งานได้)
|
conferenceDataVersion |
integer |
หมายเลขเวอร์ชันของข้อมูลการประชุมที่ไคลเอ็นต์ API สนับสนุน เวอร์ชัน 0 จะถือว่าไม่มีการรองรับข้อมูลการประชุมและจะไม่สนใจข้อมูลการประชุมในส่วนเนื้อหาของกิจกรรม เวอร์ชัน 1 รองรับการคัดลอก ConferenceData และการสร้างการประชุมใหม่โดยใช้ช่อง createRequest ของ ConferencData ค่าเริ่มต้นคือ 0
ค่าที่ยอมรับได้คือ 0 ถึง 1
|
maxAttendees |
integer |
จํานวนผู้เข้าร่วมสูงสุดในการตอบกลับ หากมีผู้เข้าร่วมมากกว่าจํานวนที่ระบุ ผู้เข้าร่วมจะถูกส่งคืน ไม่บังคับ |
sendNotifications |
boolean |
เลิกใช้งานแล้ว โปรดใช้ sendUpdates แทน จะส่งการแจ้งเตือนเกี่ยวกับการอัปเดตกิจกรรมไปให้ไหม (เช่น คําอธิบายการเปลี่ยนแปลง ฯลฯ) โปรดทราบว่าอีเมลบางรายการอาจยังคงส่ง แม้ว่าคุณจะตั้งค่าเป็น false แล้ว ค่าเริ่มต้นคือ false
|
sendUpdates |
string |
ผู้เข้าร่วมที่ควรได้รับการแจ้งเตือนเกี่ยวกับการอัปเดตกิจกรรม (เช่น การเปลี่ยนชื่อ เป็นต้น)
ค่าที่ยอมรับได้ ได้แก่
|
supportsAttachments |
boolean |
การทํางานของไคลเอ็นต์ API สนับสนุนไฟล์แนบของกิจกรรมหรือไม่ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ False |
การให้สิทธิ์
คําขอนี้ต้องให้สิทธิ์ซึ่งมีขอบเขตต่อไปนี้อย่างน้อย 1 อย่าง
ขอบเขต |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
สําหรับข้อมูลเพิ่มเติม โปรดดูที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
ในเนื้อหาคําขอ ให้ระบุทรัพยากรเหตุการณ์พร้อมพร็อพเพอร์ตี้ต่อไปนี้
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | หมายเหตุ |
---|---|---|---|
พร็อพเพอร์ตี้ที่จําเป็น | |||
end |
nested object |
เวลาสิ้นสุด (ไม่รวม) กิจกรรม สําหรับเหตุการณ์ที่เกิดซ้ํา นี่คือเวลาสิ้นสุดของอินสแตนซ์แรก | |
start |
nested object |
เวลาเริ่มต้น (รวม) ของกิจกรรม สําหรับกิจกรรมที่เกิดซ้ํา นี่คือเวลาเริ่มต้นของอินสแตนซ์แรก | |
พร็อพเพอร์ตี้ที่ไม่บังคับ | |||
anyoneCanAddSelf |
boolean |
ทุกคนจะเชิญตนเองเข้าร่วมกิจกรรมได้หรือไม่ (เลิกใช้งานแล้ว) ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ False | เขียนได้ |
attachments[].fileUrl |
string |
URL ไปยังไฟล์แนบ หากต้องการเพิ่มไฟล์แนบของ Google ไดรฟ์ ให้ใช้รูปแบบเดียวกับในพร็อพเพอร์ตี้ ต้องระบุเมื่อเพิ่มไฟล์แนบ |
เขียนได้ |
attendees[] |
list |
ผู้เข้าร่วมกิจกรรม โปรดดูคู่มือกิจกรรมที่มีผู้เข้าร่วมสําหรับข้อมูลเพิ่มเติมเกี่ยวกับการจัดกําหนดการกับผู้ใช้ปฏิทินคนอื่นๆ บัญชีบริการต้องใช้การมอบสิทธิ์ทั่วทั้งโดเมนเพื่อเติมข้อมูลในรายการผู้เข้าร่วม | เขียนได้ |
attendees[].additionalGuests |
integer |
จํานวนแขกเพิ่มเติม ไม่บังคับ ค่าเริ่มต้นคือ 0 | เขียนได้ |
attendees[].comment |
string |
ความคิดเห็นการตอบกลับของผู้เข้าร่วม ไม่บังคับ | เขียนได้ |
attendees[].displayName |
string |
ชื่อผู้เข้าร่วม (หากมี) ไม่บังคับ | เขียนได้ |
attendees[].email |
string |
อีเมลของผู้เข้าร่วม (หากมี) ต้องมีช่องนี้เมื่อเพิ่มผู้เข้าร่วม ต้องเป็นที่อยู่อีเมลที่ถูกต้องตาม RFC5322 ต้องระบุเมื่อเพิ่มผู้เข้าร่วม |
เขียนได้ |
attendees[].optional |
boolean |
ระบุว่าเป็นผู้เข้าร่วมที่ไม่บังคับหรือไม่ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ False | เขียนได้ |
attendees[].resource |
boolean |
ผู้เข้าร่วมเป็นทรัพยากรหรือไม่ ตั้งค่าได้ก็ต่อเมื่อมีการเพิ่มผู้เข้าร่วมในกิจกรรมเป็นครั้งแรกเท่านั้น ระบบจะเพิกเฉยต่อการแก้ไขหลังจากนั้น ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ False | เขียนได้ |
attendees[].responseStatus |
string |
สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้คือ:
|
เขียนได้ |
attendeesOmitted |
boolean |
ผู้เข้าร่วมอาจถูกตัดสิทธิ์ออกจากการแสดงกิจกรรมหรือไม่ เมื่อเรียกข้อมูลเหตุการณ์ อาจเป็นเพราะข้อจํากัดที่พารามิเตอร์การค้นหา maxAttendee ระบุไว้ เมื่ออัปเดตกิจกรรม จะใช้เพื่ออัปเดตคําตอบของผู้เข้าร่วมเท่านั้น ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ False |
เขียนได้ |
colorId |
string |
สีของกิจกรรม รหัสนี้จะเป็นรหัสที่อ้างถึงรายการในส่วนevent ของคําจํากัดความสี (ดู ปลายทางสี) ไม่บังคับ |
เขียนได้ |
conferenceData |
nested object |
ข้อมูลเกี่ยวกับการประชุม เช่น รายละเอียดการประชุม Google Meet หากต้องการสร้างรายละเอียดการประชุมใหม่ ให้ใช้ช่อง createRequest หากต้องการคงการเปลี่ยนแปลงไว้ อย่าลืมตั้งค่าพารามิเตอร์คําขอ conferenceDataVersion เป็น 1 สําหรับคําขอแก้ไขเหตุการณ์ทั้งหมด |
เขียนได้ |
description |
string |
คำอธิบายกิจกรรม สามารถมี HTML ได้ ไม่บังคับ | เขียนได้ |
end.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
end.dateTime |
datetime |
เวลาเป็นค่าเวลารวม (จัดรูปแบบตาม RFC3339) ต้องระบุการชดเชยเขตเวลา เว้นแต่ว่ามีการระบุเขตเวลาไว้อย่างชัดเจนใน timeZone |
เขียนได้ |
end.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลา IANA เช่น "ยุโรป/ซูริค") สําหรับกิจกรรมที่เกิดซ้ํา คุณต้องระบุข้อมูลในช่องนี้และระบุเขตเวลาที่ต้องการขยายการเกิดซ้ํา สําหรับเหตุการณ์เดียว ช่องนี้จะไม่บังคับ และระบุเขตเวลาที่กําหนดเองเพื่อเริ่มต้น/สิ้นสุดเหตุการณ์ | เขียนได้ |
extendedProperties.private |
object |
พร็อพเพอร์ตี้ที่เป็นส่วนตัวกับสําเนาของเหตุการณ์ที่ปรากฏในปฏิทินนี้ | เขียนได้ |
extendedProperties.shared |
object |
พร็อพเพอร์ตี้ที่แชร์ระหว่างสําเนาของกิจกรรมในปฏิทินของผู้เข้าร่วมคนอื่นๆ | เขียนได้ |
gadget.display |
string |
โหมดการแสดงผลแกดเจ็ต เลิกใช้งานแล้ว ค่าที่เป็นไปได้คือ:
|
เขียนได้ |
gadget.height |
integer |
ความสูงของแกดเจ็ตในหน่วยพิกเซล ความสูงต้องเป็นจํานวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
gadget.iconLink |
string |
URL ไอคอนของแกดเจ็ต Scheme ของ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.link |
string |
URL ของแกดเจ็ต Scheme ของ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.preferences |
object |
ค่ากำหนด | เขียนได้ |
gadget.title |
string |
ชื่อของแกดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.type |
string |
ประเภทของแกดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.width |
integer |
ความกว้างของแกดเจ็ตเป็นพิกเซล ความกว้างต้องเป็นจํานวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
guestsCanInviteOthers |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดสามารถเชิญผู้อื่นเข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ โดยมีค่าเริ่มต้นเป็น "จริง" | เขียนได้ |
guestsCanModify |
boolean |
ผู้เข้าร่วมกิจกรรมที่ไม่ใช่ผู้จัดสามารถแก้ไขกิจกรรมได้หรือไม่ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ False | เขียนได้ |
guestsCanSeeOtherGuests |
boolean |
ผู้เข้าร่วมอื่นที่ไม่ใช่ผู้จัดจะเห็นว่าผู้เข้าร่วมกิจกรรมคือใคร ไม่บังคับ โดยมีค่าเริ่มต้นเป็น "จริง" | เขียนได้ |
location |
string |
สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมเป็นข้อความรูปแบบอิสระ ไม่บังคับ | เขียนได้ |
originalStartTime.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
originalStartTime.dateTime |
datetime |
เวลาเป็นค่าเวลารวม (จัดรูปแบบตาม RFC3339) ต้องระบุการชดเชยเขตเวลา เว้นแต่ว่ามีการระบุเขตเวลาไว้อย่างชัดเจนใน timeZone |
เขียนได้ |
originalStartTime.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลา IANA เช่น "ยุโรป/ซูริค") สําหรับกิจกรรมที่เกิดซ้ํา คุณต้องระบุข้อมูลในช่องนี้และระบุเขตเวลาที่ต้องการขยายการเกิดซ้ํา สําหรับเหตุการณ์เดียว ช่องนี้จะไม่บังคับ และระบุเขตเวลาที่กําหนดเองเพื่อเริ่มต้น/สิ้นสุดเหตุการณ์ | เขียนได้ |
recurrence[] |
list |
รายการบรรทัด RRULE, EXRULE, RDATE และ EXDATE สําหรับกิจกรรมที่เกิดซ้ําตามที่ระบุไว้ใน RFC5545 โปรดทราบว่าช่อง DTSTART และ DTEND ไม่ได้รับอนุญาตให้ใช้ที่ระบุ เวลาเริ่มต้นและสิ้นสุดของกิจกรรมจะแสดงในช่อง start และ end ช่องนี้ถูกละเว้นสําหรับเหตุการณ์เดียวหรืออินสแตนซ์ของกิจกรรมที่เกิดซ้ํา |
เขียนได้ |
reminders.overrides[] |
list |
หากกิจกรรมไม่ได้ใช้การเตือนความจําเริ่มต้น ระบบจะแสดงการเตือนความจําเฉพาะสําหรับกิจกรรมนั้นหรือไม่ได้ตั้งค่า แสดงว่าไม่มีการตั้งค่าการแจ้งเตือนสําหรับกิจกรรมนี้ จํานวนสูงสุดของการช่วยเตือนการลบล้างคือ 5 รายการ | เขียนได้ |
reminders.overrides[].method |
string |
วิธีที่การเตือนความจํานี้ใช้ ค่าที่เป็นไปได้คือ:
ต้องระบุเมื่อเพิ่มการช่วยเตือน |
เขียนได้ |
reminders.overrides[].minutes |
integer |
จํานวนนาทีก่อนเริ่มกิจกรรมเมื่อการช่วยเตือนควรเริ่มทํางาน ค่าที่ใช้ได้จะอยู่ระหว่าง 0 ถึง 40320 (4 สัปดาห์ในนาที) ต้องระบุเมื่อเพิ่มการช่วยเตือน |
เขียนได้ |
reminders.useDefault |
boolean |
กําหนดว่าจะใช้การเตือนเริ่มต้นของปฏิทินกับกิจกรรมหรือไม่ | เขียนได้ |
sequence |
integer |
หมายเลขลําดับต่อ iCalendar | เขียนได้ |
source.title |
string |
ชื่อของแหล่งที่มา เช่น ชื่อของหน้าเว็บหรือเรื่องของอีเมล | เขียนได้ |
source.url |
string |
URL ของแหล่งข้อมูลที่ชี้ไปยังทรัพยากร Scheme ของ URL ต้องเป็น HTTP หรือ HTTPS | เขียนได้ |
start.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
start.dateTime |
datetime |
เวลาเป็นค่าเวลารวม (จัดรูปแบบตาม RFC3339) ต้องระบุการชดเชยเขตเวลา เว้นแต่ว่ามีการระบุเขตเวลาไว้อย่างชัดเจนใน timeZone |
เขียนได้ |
start.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลา IANA เช่น "ยุโรป/ซูริค") สําหรับกิจกรรมที่เกิดซ้ํา คุณต้องระบุข้อมูลในช่องนี้และระบุเขตเวลาที่ต้องการขยายการเกิดซ้ํา สําหรับเหตุการณ์เดียว ช่องนี้จะไม่บังคับ และระบุเขตเวลาที่กําหนดเองเพื่อเริ่มต้น/สิ้นสุดเหตุการณ์ | เขียนได้ |
status |
string |
สถานะของกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้คือ:
|
เขียนได้ |
summary |
string |
ชื่อกิจกรรม | เขียนได้ |
transparency |
string |
กิจกรรมบล็อกเวลาในปฏิทินหรือไม่ ไม่บังคับ ค่าที่เป็นไปได้คือ:
|
เขียนได้ |
visibility |
string |
ระดับการเข้าถึงกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้คือ:
|
เขียนได้ |
workingLocationProperties |
nested object |
ข้อมูลสถานที่ทํางาน | เขียนได้ |
workingLocationProperties.customLocation |
object |
ถ้ามี ระบุว่าผู้ใช้ทํางานจากตําแหน่งที่กําหนดเอง | เขียนได้ |
workingLocationProperties.customLocation.label |
string |
ป้ายกํากับที่เป็นตัวเลือกเพิ่มเติมสําหรับข้อมูลเพิ่มเติม | เขียนได้ |
workingLocationProperties.homeOffice |
any value |
หากมี ให้ระบุว่าผู้ใช้กําลังทํางานที่บ้าน | เขียนได้ |
workingLocationProperties.officeLocation |
object |
หากมี แสดงว่าผู้ใช้กําลังทํางานจากสํานักงาน | เขียนได้ |
workingLocationProperties.officeLocation.buildingId |
string |
ตัวระบุอาคารที่ไม่บังคับ ซึ่งควรอ้างอิงรหัสอาคารในฐานข้อมูลทรัพยากรขององค์กร | เขียนได้ |
workingLocationProperties.officeLocation.deskId |
string |
ตัวระบุโต๊ะทํางานที่ไม่บังคับ | เขียนได้ |
workingLocationProperties.officeLocation.floorId |
string |
ตัวระบุชั้นที่ไม่บังคับ | เขียนได้ |
workingLocationProperties.officeLocation.floorSectionId |
string |
ตัวระบุส่วนชั้น (ไม่บังคับ) | เขียนได้ |
workingLocationProperties.officeLocation.label |
string |
ชื่อสํานักงานที่แสดงในไคลเอ็นต์ของปฏิทินเว็บและอุปกรณ์เคลื่อนที่ เราขอแนะนําให้คุณอ้างอิงชื่อสิ่งปลูกสร้างในฐานข้อมูลทรัพยากรขององค์กร | เขียนได้ |
workingLocationProperties.type |
string |
ประเภทสถานที่ทํางาน ค่าที่เป็นไปได้คือ:
ต้องระบุเมื่อเพิ่มพร็อพเพอร์ตี้สถานที่ทํางาน |
เขียนได้ |
คำตอบ
หากสําเร็จ เมธอดนี้จะแสดงทรัพยากรเหตุการณ์ในเนื้อหาตอบกลับ
ตัวอย่าง
หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)
Java
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Retrieve the event from the API Event event = service.events().get("primary", "eventId").execute(); // Make a change event.setSummary("Appointment at Somewhere"); // Update the event Event updatedEvent = service.events().update("primary", event.getId(), event).execute(); System.out.println(updatedEvent.getUpdated());
Python
# First retrieve the event from the API. event = service.events().get(calendarId='primary', eventId='eventId').execute() event['summary'] = 'Appointment at Somewhere' updated_event = service.events().update(calendarId='primary', eventId=event['id'], body=event).execute() # Print the updated date. print updated_event['updated']
PHP
// First retrieve the event from the API. $event = $service->events->get('primary', 'eventId'); $event->setSummary('Appointment at Somewhere'); $updatedEvent = $service->events->update('primary', $event->getId(), $event); // Print the updated date. echo $updatedEvent->getUpdated();
Ruby
event = client.get_event('primary', 'eventId') event.summary = 'Appointment at Somewhere' result = client.update_event('primary', event.id, event) print result.updated
ลองใช้เลย
ใช้ API Explorer ด้านล่างเพื่อเรียกใช้วิธีการนี้กับข้อมูลสดและดูการตอบกลับ