อัปเดตกิจกรรม วิธีนี้ไม่รองรับความหมายของแพตช์และอัปเดตทรัพยากรทั้งหมดของเหตุการณ์เสมอ หากต้องการอัปเดตบางส่วน ให้ใช้ get
ตามด้วย update
โดยใช้แท็ก etag เพื่อรับประกันความอิสระ
ลองใช้เลยหรือดูตัวอย่าง
ส่งคำขอ
คำขอ 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 ของ ConferenceData ค่าเริ่มต้นคือ 0
ค่าที่ยอมรับได้คือ 0 ถึง 1 เท่านั้น
|
maxAttendees |
integer |
จำนวนผู้เข้าร่วมสูงสุดที่จะรวมไว้ในคำตอบ ถ้ามีผู้เข้าร่วมมากกว่าจำนวนที่ระบุ ระบบจะส่งคืนเฉพาะผู้เข้าร่วมเท่านั้น ไม่บังคับ |
sendNotifications |
boolean |
เลิกใช้งานแล้ว โปรดใช้ sendUpdates แทน ต้องการส่งการแจ้งเตือนเกี่ยวกับการอัปเดตกิจกรรม (เช่น การเปลี่ยนแปลงคำอธิบาย เป็นต้น) หรือไม่ โปรดทราบว่าระบบอาจยังส่งอีเมลบางฉบับอยู่ แม้ว่าคุณจะกำหนดค่าเป็น false ก็ตาม ค่าเริ่มต้นคือ false
|
sendUpdates |
string |
ผู้เข้าร่วมที่ควรได้รับการแจ้งเตือนเกี่ยวกับการอัปเดตกิจกรรม (เช่น การเปลี่ยนชื่อ ฯลฯ)
ค่าที่ยอมรับมีดังนี้
|
supportsAttachments |
boolean |
การทำงานของไคลเอ็นต์ API รองรับไฟล์แนบเหตุการณ์หรือไม่ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ" |
การให้สิทธิ์
คำขอนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต
ขอบเขต |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
โปรดดูข้อมูลเพิ่มเติมที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
ในเนื้อหาคำขอ ให้ระบุทรัพยากรเหตุการณ์พร้อมด้วยพร็อพเพอร์ตี้ต่อไปนี้
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | Notes |
---|---|---|---|
พร็อพเพอร์ตี้ที่จำเป็น | |||
end |
nested object |
เวลาสิ้นสุด (ไม่รวม) ของกิจกรรม สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาสิ้นสุดของอินสแตนซ์แรก | |
start |
nested object |
เวลาเริ่มต้นกิจกรรม (นับรวมด้วย) สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาเริ่มต้นของอินสแตนซ์แรก | |
พร็อพเพอร์ตี้ที่ไม่บังคับ | |||
anyoneCanAddSelf |
boolean |
ทุกคนสามารถเชิญตนเองเข้าร่วมกิจกรรมได้หรือไม่ (เลิกใช้งานแล้ว) ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ" | เขียนได้ |
attachments[].fileUrl |
string |
URL ของไฟล์แนบ สำหรับการเพิ่มไฟล์แนบของ Google ไดรฟ์ ให้ใช้รูปแบบเดียวกับในพร็อพเพอร์ตี้ ต้องระบุเมื่อเพิ่มไฟล์แนบ |
เขียนได้ |
attendees[] |
list |
ผู้เข้าร่วมกิจกรรม โปรดดูคู่มือกิจกรรมที่มีผู้เข้าร่วมเพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดเวลากิจกรรมกับผู้ใช้ปฏิทินคนอื่นๆ บัญชีบริการต้องใช้การมอบสิทธิ์ทั่วทั้งโดเมนเพื่อสร้างรายชื่อผู้เข้าร่วม | เขียนได้ |
attendees[].additionalGuests |
integer |
จำนวนแขกเพิ่มเติม ไม่บังคับ ค่าเริ่มต้นคือ 0 | เขียนได้ |
attendees[].comment |
string |
ความคิดเห็นตอบกลับของผู้เข้าร่วม ไม่บังคับ | เขียนได้ |
attendees[].displayName |
string |
ชื่อผู้เข้าร่วม (หากมี) ไม่บังคับ | เขียนได้ |
attendees[].email |
string |
อีเมลของผู้เข้าร่วม (หากมี) ช่องนี้ต้องแสดงเมื่อเพิ่มผู้เข้าร่วม อีเมลนี้ต้องเป็นอีเมลที่ถูกต้องตามที่ระบุใน RFC5322 ต้องระบุเมื่อเพิ่มผู้เข้าร่วม |
เขียนได้ |
attendees[].optional |
boolean |
ดูว่าเป็นผู้เข้าร่วมที่ไม่บังคับหรือไม่ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ" | เขียนได้ |
attendees[].resource |
boolean |
ผู้เข้าร่วมเป็นทรัพยากรหรือไม่ ตั้งค่าได้ก็ต่อเมื่อเพิ่มผู้เข้าร่วมในกิจกรรมเป็นครั้งแรกเท่านั้น ระบบจะไม่สนใจการแก้ไขที่ตามมา ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ" | เขียนได้ |
attendees[].responseStatus |
string |
สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้
|
เขียนได้ |
attendeesOmitted |
boolean |
ผู้เข้าร่วมถูกละเว้นจากตัวแทนของกิจกรรมหรือไม่ เมื่อดึงข้อมูลเหตุการณ์ อาจเป็นเพราะข้อจํากัดที่ระบุโดยพารามิเตอร์การค้นหา maxAttendee เมื่ออัปเดตกิจกรรม จะใช้เพื่ออัปเดตคำตอบของผู้เข้าร่วมเท่านั้น ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ" |
เขียนได้ |
colorId |
string |
สีของกิจกรรม นี่คือรหัสที่อ้างถึงรายการในส่วนevent ของคำจำกัดความสี (ดู จุดสิ้นสุดของสี) ไม่บังคับ |
เขียนได้ |
conferenceData |
nested object |
ข้อมูลเกี่ยวกับการประชุม เช่น รายละเอียดการประชุมของ Google Meet หากต้องการสร้างรายละเอียดการประชุมใหม่ ให้ใช้ช่อง createRequest หากต้องการคงการเปลี่ยนแปลงไว้ อย่าลืมตั้งค่าพารามิเตอร์คำขอ conferenceDataVersion เป็น 1 สำหรับคำขอแก้ไขเหตุการณ์ทั้งหมด |
เขียนได้ |
description |
string |
คำอธิบายกิจกรรม มี HTML ได้ ไม่บังคับ | เขียนได้ |
end.date |
date |
วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดทั้งวัน | เขียนได้ |
end.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลารวม (จัดรูปแบบตาม RFC3339) ต้องมีการชดเชยเขตเวลา เว้นแต่จะระบุเขตเวลาใน timeZone อย่างชัดเจน |
เขียนได้ |
end.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลา IANA เช่น "ยุโรป/ซูริค") สำหรับกิจกรรมที่เกิดซ้ำ ช่องนี้ต้องระบุและระบุเขตเวลาที่จะขยายการเกิดซ้ำ สำหรับเหตุการณ์เดียว ช่องนี้เป็นช่องที่ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับการเริ่มต้น/สิ้นสุดเหตุการณ์ | เขียนได้ |
extendedProperties.private |
object |
พร็อพเพอร์ตี้ที่เป็นส่วนบุคคลในสำเนาของกิจกรรมที่ปรากฏในปฏิทินนี้ | เขียนได้ |
extendedProperties.shared |
object |
พร็อพเพอร์ตี้ที่แชร์ระหว่างสำเนาของกิจกรรมในปฏิทินของผู้เข้าร่วมคนอื่น | เขียนได้ |
focusTimeProperties |
nested object |
ข้อมูลเหตุการณ์ "เวลาที่ต้องการสมาธิ" ใช้เมื่อ eventType คือ focusTime |
เขียนได้ |
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 |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดสามารถเชิญผู้อื่นเข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
guestsCanModify |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะแก้ไขกิจกรรมได้หรือไม่ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ" | เขียนได้ |
guestsCanSeeOtherGuests |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะเห็นว่าผู้เข้าร่วมกิจกรรมคือใคร ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
location |
string |
สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมเป็นข้อความรูปแบบอิสระ ไม่บังคับ | เขียนได้ |
originalStartTime.date |
date |
วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดทั้งวัน | เขียนได้ |
originalStartTime.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลารวม (จัดรูปแบบตาม RFC3339) ต้องมีการชดเชยเขตเวลา เว้นแต่จะระบุเขตเวลาใน timeZone อย่างชัดเจน |
เขียนได้ |
originalStartTime.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลา IANA เช่น "ยุโรป/ซูริค") สำหรับกิจกรรมที่เกิดซ้ำ ช่องนี้ต้องระบุและระบุเขตเวลาที่จะขยายการเกิดซ้ำ สำหรับเหตุการณ์เดียว ช่องนี้เป็นช่องที่ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับการเริ่มต้น/สิ้นสุดเหตุการณ์ | เขียนได้ |
outOfOfficeProperties |
nested object |
ข้อมูลกิจกรรมลางาน ใช้เมื่อ eventType คือ outOfOffice |
เขียนได้ |
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 |
วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดทั้งวัน | เขียนได้ |
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 ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบเรียลไทม์และดูการตอบสนอง