สร้างกิจกรรม ลองใช้เลย
ส่งคำขอ
คำขอ HTTP
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events
พารามิเตอร์
| ชื่อพารามิเตอร์ | ค่า | คำอธิบาย |
|---|---|---|
| พารามิเตอร์เส้นทาง | ||
calendarId |
string |
ตัวระบุปฏิทิน หากต้องการดึงรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบัน ให้ใช้คีย์เวิร์ด "primary"
|
| พารามิเตอร์การค้นหาที่ไม่บังคับ | ||
conferenceDataVersion |
integer |
หมายเลขเวอร์ชันของข้อมูลการประชุมที่ไคลเอ็นต์ API รองรับ เวอร์ชัน 0 จะถือว่าไม่มีการรองรับข้อมูลการประชุมและไม่สนใจข้อมูลการประชุมในเนื้อหาของกิจกรรม เวอร์ชัน 1 รองรับการคัดลอก ConferenceData รวมถึงการสร้างการประชุมใหม่โดยใช้ฟิลด์ createRequest ของ conferenceData ค่าเริ่มต้นคือ 0
ค่าที่ยอมรับได้คือ 0 ถึง 1
|
maxAttendees |
integer |
จำนวนผู้เข้าร่วมสูงสุดที่จะรวมไว้ในการตอบกลับ หากมีผู้เข้าร่วมมากกว่าจำนวนที่ระบุ ระบบจะแสดงผลเฉพาะผู้เข้าร่วม ไม่บังคับ |
sendNotifications |
boolean |
เลิกใช้งานแล้ว โปรดใช้ sendUpdates แทน เลือกว่าจะส่งการแจ้งเตือนเกี่ยวกับการสร้างกิจกรรมใหม่หรือไม่ โปรดทราบว่าระบบอาจยังส่งอีเมลบางฉบับแม้ว่าคุณจะตั้งค่าเป็น false แล้วก็ตาม ค่าเริ่มต้นคือ false
|
sendUpdates |
string |
จะส่งการแจ้งเตือนเกี่ยวกับการสร้างกิจกรรมใหม่หรือไม่ โปรดทราบว่าระบบอาจยังส่งอีเมลบางฉบับ โดยมีค่าเริ่มต้นเป็น false
ค่าที่ยอมรับมีดังนี้
|
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 |
สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้
|
เขียนได้ |
birthdayProperties |
nested object |
ข้อมูลวันเกิดหรือกิจกรรมพิเศษ ใช้ในกรณีที่ eventType เป็น "birthday" เปลี่ยนแปลงไม่ได้ |
เขียนได้ |
birthdayProperties.type |
string |
ประเภทวันเกิดหรือกิจกรรมพิเศษ ค่าที่เป็นไปได้มีดังนี้
"birthday" คุณจะเปลี่ยนประเภทหลังจากสร้างกิจกรรมแล้วไม่ได้ |
เขียนได้ |
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 เช่น "Europe/Zurich") สำหรับกิจกรรมที่เกิดซ้ำ ฟิลด์นี้จำเป็นและระบุเขตเวลาที่จะขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ฟิลด์นี้ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม | เขียนได้ |
eventType |
string |
ประเภทเฉพาะของเหตุการณ์ คุณจะแก้ไขส่วนนี้หลังจากที่สร้างกิจกรรมแล้วไม่ได้ ค่าที่เป็นไปได้มีดังนี้
|
เขียนได้ |
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 | เขียนได้ |
id |
string |
ตัวระบุเหตุการณ์แบบทึบ เมื่อสร้างกิจกรรมใหม่แบบครั้งเดียวหรือแบบเกิดซ้ำ คุณจะระบุรหัสของกิจกรรมได้ บัตรประจำตัวที่ส่งมาต้องเป็นไปตามกฎต่อไปนี้
หากคุณไม่ได้ระบุรหัส เซิร์ฟเวอร์จะสร้างรหัสให้โดยอัตโนมัติ โปรดทราบว่า |
เขียนได้ |
location |
string |
สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมเป็นข้อความรูปแบบอิสระ ไม่บังคับ | เขียนได้ |
originalStartTime.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
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 |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
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 |
ประเภทสถานที่ทำงาน ค่าที่เป็นไปได้มีดังนี้
ต้องระบุเมื่อเพิ่มพร็อพเพอร์ตี้สถานที่ทำงาน |
เขียนได้ |
การตอบกลับ
หากสำเร็จ เมธอดนี้จะแสดงทรัพยากรเหตุการณ์ในเนื้อหาการตอบกลับ
ลองใช้งาน
ใช้โปรแกรมสำรวจ API ด้านล่างเพื่อเรียกเมธอดนี้ในข้อมูลสดและดูการตอบกลับ