อัปเดตกิจกรรม วิธีนี้ไม่รองรับความหมายของแพตช์และจะอัปเดตทรัพยากรเหตุการณ์ทั้งหมดเสมอ หากต้องการอัปเดตบางส่วน ให้ทำ 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 ของ conferenceData ค่าเริ่มต้นคือ 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 |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
ดูข้อมูลเพิ่มเติมได้ที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
ในเนื้อหาคำขอ ให้ระบุทรัพยากรเหตุการณ์ที่มีพร็อพเพอร์ตี้ต่อไปนี้
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | หมายเหตุ |
---|---|---|---|
พร็อพเพอร์ตี้ที่จำเป็น | |||
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 |
วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
end.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลาแบบรวม (จัดรูปแบบตาม RFC3339) ต้องระบุเขตเวลาออฟเซ็ต เว้นแต่จะมีการระบุเขตเวลาอย่างชัดเจนใน timeZone |
เขียนได้ |
end.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สําหรับกิจกรรมที่เกิดซ้ำ ช่องนี้ต้องระบุและระบุเขตเวลาที่ขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ช่องนี้ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม | เขียนได้ |
extendedProperties.private |
object |
พร็อพเพอร์ตี้ที่เป็นส่วนตัวสำหรับสำเนาของกิจกรรมที่ปรากฏในปฏิทินนี้ | เขียนได้ |
extendedProperties.shared |
object |
พร็อพเพอร์ตี้ที่แชร์ระหว่างสำเนาของกิจกรรมในปฏิทินของผู้อื่น | เขียนได้ |
focusTimeProperties |
nested object |
ข้อมูลกิจกรรมที่ต้องการสมาธิ ใช้ในกรณีที่ eventType เป็น focusTime |
เขียนได้ |
gadget.display |
string |
โหมดการแสดงผลของอุปกรณ์ เลิกใช้งานแล้ว ค่าที่เป็นไปได้มีดังนี้
|
เขียนได้ |
gadget.height |
integer |
ความสูงของแก็ดเจ็ตในหน่วยพิกเซล ความสูงต้องเป็นจํานวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
gadget.iconLink |
string |
URL ของไอคอนของแก็ดเจ็ต รูปแบบ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.link |
string |
URL ของแก็ดเจ็ต รูปแบบ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.preferences |
object |
ค่ากำหนด | เขียนได้ |
gadget.title |
string |
ชื่อของแกดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.type |
string |
ประเภทของแก็ดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.width |
integer |
ความกว้างของแก็ดเจ็ตในหน่วยพิกเซล ความกว้างต้องเป็นจํานวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
guestsCanInviteOthers |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะเชิญผู้อื่นให้เข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
guestsCanModify |
boolean |
กำหนดว่าผู้เข้าร่วมที่ไม่ใช่ผู้จัดงานจะแก้ไขกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False | เขียนได้ |
guestsCanSeeOtherGuests |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะเห็นรายชื่อผู้เข้าร่วมกิจกรรมหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
location |
string |
สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมเป็นข้อความรูปแบบใดก็ได้ ไม่บังคับ | เขียนได้ |
originalStartTime.date |
date |
วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
originalStartTime.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลาแบบรวม (จัดรูปแบบตาม RFC3339) ต้องระบุเขตเวลาออฟเซ็ต เว้นแต่จะมีการระบุเขตเวลาอย่างชัดเจนใน timeZone |
เขียนได้ |
originalStartTime.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สําหรับกิจกรรมที่เกิดซ้ำ ช่องนี้ต้องระบุและระบุเขตเวลาที่ขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ช่องนี้ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม | เขียนได้ |
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 ของแหล่งที่มาที่ชี้ไปยังทรัพยากร รูปแบบ URL ต้องเป็น HTTP หรือ HTTPS | เขียนได้ |
start.date |
date |
วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
start.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลาแบบรวม (จัดรูปแบบตาม RFC3339) ต้องระบุเขตเวลาออฟเซ็ต เว้นแต่จะมีการระบุเขตเวลาอย่างชัดเจนใน timeZone |
เขียนได้ |
start.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สําหรับกิจกรรมที่เกิดซ้ำ ช่องนี้ต้องระบุและระบุเขตเวลาที่ขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ช่องนี้ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม | เขียนได้ |
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 ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลจริงและดูการตอบกลับ