Events: import

นําเข้ากิจกรรม การดำเนินการนี้ใช้เพื่อเพิ่มสำเนาส่วนตัวของกิจกรรมที่มีอยู่ลงในปฏิทิน ระบบจะนําเข้าได้เฉพาะเหตุการณ์ที่มี eventType เท่ากับ default

ลักษณะการทำงานที่เลิกใช้งานแล้ว: หากนําเข้าเหตุการณ์ที่ไม่ใช่ default ระบบจะเปลี่ยนประเภทของเหตุการณ์เป็น default และทิ้งพร็อพเพอร์ตี้เฉพาะประเภทเหตุการณ์ที่อาจมี

ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/import

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
calendarId string ตัวระบุปฏิทิน หากต้องการเรียกข้อมูลรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบัน ให้ใช้คีย์เวิร์ด "primary"
พารามิเตอร์การค้นหาที่ไม่บังคับ
conferenceDataVersion integer หมายเลขเวอร์ชันของข้อมูลการประชุมที่ไคลเอ็นต์ API รองรับ เวอร์ชัน 0 จะถือว่าไม่รองรับข้อมูลการประชุมและจะไม่สนใจข้อมูลการประชุมในเนื้อหาของกิจกรรม เวอร์ชัน 1 รองรับการคัดลอก ConferenceData รวมถึงการสร้างการประชุมใหม่โดยใช้ฟิลด์ createRequest ของ conferenceData ค่าเริ่มต้นคือ 0 ค่าที่ยอมรับได้คือตั้งแต่ 0 ถึง 1
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 เวลาสิ้นสุด (ไม่รวม) ของกิจกรรม สําหรับกิจกรรมที่เกิดซ้ำ ค่านี้คือเวลาสิ้นสุดของอินสแตนซ์แรก
iCalUID string ตัวระบุที่ไม่ซ้ำของเหตุการณ์ตามที่กําหนดใน RFC5545 ซึ่งจะใช้เพื่อระบุกิจกรรมในระบบปฏิทินต่างๆ โดยไม่ซ้ำกัน และต้องระบุเมื่อนำเข้ากิจกรรมผ่านเมธอด import

โปรดทราบว่า iCalUID และ id จะไม่เหมือนกัน และควรระบุเพียงรายการเดียวเมื่อสร้างเหตุการณ์ ความแตกต่างอย่างหนึ่งของความหมายคือในเหตุการณ์ที่เกิดซ้ำ เหตุการณ์หนึ่งๆ ที่เกิดขึ้นทั้งหมดจะมี id ต่างกัน แต่ใช้ iCalUID เดียวกัน หากต้องการเรียกข้อมูลเหตุการณ์โดยใช้ iCalUID ให้เรียกเมธอด events.list โดยใช้พารามิเตอร์ iCalUID หากต้องการเรียกข้อมูลเหตุการณ์โดยใช้ id ให้เรียกใช้เมธอด events.get
start nested object เวลาเริ่มต้น (รวมวันที่เริ่มต้น) ของกิจกรรม สำหรับกิจกรรมที่เกิดซ้ำ ข้อมูลนี้คือเวลาเริ่มต้นของอินสแตนซ์แรก
พร็อพเพอร์ตี้ที่ไม่บังคับ
anyoneCanAddSelf boolean กำหนดว่าทุกคนสามารถเชิญตนเองเข้าร่วมกิจกรรมได้หรือไม่ (เลิกใช้งานแล้ว) ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
attachments[].fileUrl string ลิงก์ URL ไปยังไฟล์แนบ

สำหรับการเพิ่มไฟล์แนบของ Google ไดรฟ์ ให้ใช้รูปแบบเดียวกับในพร็อพเพอร์ตี้ alternateLink ของทรัพยากร Files ใน Drive API

ต้องระบุเมื่อเพิ่มไฟล์แนบ

 เขียนได้
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 สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้
  • "needsAction" - ผู้เข้าร่วมยังไม่ได้ตอบกลับคำเชิญ (แนะนำสำหรับกิจกรรมใหม่)
  • "declined" - ผู้เข้าร่วมปฏิเสธคำเชิญ
  • "tentative" - ผู้เข้าร่วมตอบรับคําเชิญชั่วคราวแล้ว
  • "accepted" - ผู้เข้าร่วมยอมรับคำเชิญแล้ว
 เขียนได้
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 โหมดการแสดงผลของอุปกรณ์ เลิกใช้งานแล้ว ค่าที่เป็นไปได้มีดังนี้
  • "icon" - แกดเจ็ตจะแสดงข้างชื่อกิจกรรมในมุมมองปฏิทิน
  • "chip" - แกดเจ็ตจะแสดงเมื่อมีการคลิกเหตุการณ์
 เขียนได้
gadget.height integer ความสูงของแก็ดเจ็ตในหน่วยพิกเซล ความสูงต้องเป็นจำนวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว เขียนได้
gadget.preferences object ค่ากำหนด เขียนได้
gadget.title string ชื่อของแกดเจ็ต เลิกใช้งานแล้ว เขียนได้
gadget.type string ประเภทของแก็ดเจ็ต เลิกใช้งานแล้ว เขียนได้
gadget.width integer ความกว้างของแก็ดเจ็ตในหน่วยพิกเซล ความกว้างต้องเป็นจำนวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว เขียนได้
guestsCanInviteOthers boolean ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะเชิญผู้อื่นให้เข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True เขียนได้
guestsCanModify boolean กำหนดว่าผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะแก้ไขกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
guestsCanSeeOtherGuests boolean ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะเห็นรายชื่อผู้เข้าร่วมกิจกรรมหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True เขียนได้
location string สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมเป็นข้อความรูปแบบใดก็ได้ ไม่บังคับ เขียนได้
organizer object ผู้จัดกิจกรรม หากผู้จัดเป็นผู้เข้าร่วมด้วย ระบบจะระบุข้อมูลนี้ด้วยรายการแยกต่างหากใน attendees โดยตั้งค่าช่อง organizer เป็น "จริง" หากต้องการเปลี่ยนผู้จัด ให้ใช้การดำเนินการย้าย อ่านอย่างเดียว ยกเว้นเมื่อนําเข้าเหตุการณ์ เขียนได้
organizer.displayName string ชื่อผู้จัด (หากมี) เขียนได้
organizer.email string อีเมลของผู้จัด (หากมี) ต้องเป็นอีเมลที่ถูกต้องตาม RFC5322 เขียนได้
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 วิธีการที่ใช้โดยการช่วยเตือนนี้ ค่าที่เป็นไปได้มีดังนี้
  • "email" - ระบบจะส่งการช่วยเตือนทางอีเมล
  • "popup" - ระบบจะส่งการช่วยเตือนผ่านป๊อปอัป UI

ต้องระบุเมื่อเพิ่มการช่วยเตือน

 เขียนได้
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 สถานะของกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้
  • "confirmed" - ยืนยันเหตุการณ์แล้ว สถานะนี้เป็นสถานะเริ่มต้น
  • "tentative" - กิจกรรมได้รับการยืนยันอย่างไม่แน่นอน
  • "cancelled" - กิจกรรมถูกยกเลิก (ลบแล้ว) เมธอด list จะแสดงเหตุการณ์ที่ยกเลิกในการซิงค์แบบเพิ่มเท่านั้น (เมื่อระบุ syncToken หรือ updatedMin) หรือหากตั้งค่า Flag showDeleted เป็น true เมธอด get จะแสดงผลลัพธ์เสมอ

    สถานะ "ยกเลิกแล้ว" แสดงสถานะ 2 สถานะที่แตกต่างกันโดยขึ้นอยู่กับประเภทกิจกรรม ดังนี้

    1. ข้อยกเว้นที่ยกเลิกแล้วของกิจกรรมที่เกิดขึ้นซ้ำซึ่งยังไม่ได้ยกเลิกบ่งชี้ว่าไม่ควรแสดงอินสแตนซ์นี้ต่อผู้ใช้อีกต่อไป ไคลเอ็นต์ควรจัดเก็บเหตุการณ์เหล่านี้ตลอดอายุของกิจกรรมที่เกิดซ้ำหลัก

      ระบบจะรับประกันว่าข้อยกเว้นที่ยกเลิกแล้วจะมีค่าสำหรับช่อง id, recurringEventId และ originalStartTime เท่านั้น ช่องอื่นๆ อาจว่างเปล่า

    2. กิจกรรมอื่นๆ ทั้งหมดที่ยกเลิกแล้วแสดงถึงกิจกรรมที่ถูกลบ ลูกค้าควรนำสำเนาที่ซิงค์ในเครื่องออก กิจกรรมที่ยกเลิกดังกล่าวจะหายไปในที่สุด ดังนั้นอย่าคิดว่ากิจกรรมดังกล่าวจะพร้อมใช้งานตลอดไป

      เหตุการณ์ที่ลบไปแล้วจะได้รับการรับประกันว่ามีการป้อนข้อมูลในช่อง id เท่านั้น

    ในปฏิทินของผู้จัดการประชุม กิจกรรมที่ยกเลิกจะยังคงแสดงรายละเอียดกิจกรรม (สรุป สถานที่ ฯลฯ) เพื่อให้กู้คืนได้ (ยกเลิกการลบ) ในทำนองเดียวกัน กิจกรรมที่ผู้ใช้ได้รับเชิญและนำออกด้วยตนเองจะยังคงแสดงรายละเอียดต่อไป อย่างไรก็ตาม คำขอซิงค์แบบเพิ่มที่ตั้งค่า showDeleted เป็นเท็จจะไม่แสดงรายละเอียดเหล่านี้

    หากกิจกรรมเปลี่ยนผู้จัด (เช่น ผ่านการดำเนินการย้าย) และผู้จัดเดิมไม่ได้อยู่ในรายชื่อผู้เข้าร่วม ระบบจะทิ้งกิจกรรมที่ยกเลิกไว้โดยระบบจะป้อนข้อมูลเฉพาะในช่อง id เท่านั้น

เขียนได้
summary string ชื่อกิจกรรม เขียนได้
transparency string กิจกรรมบล็อกเวลาในปฏิทินหรือไม่ ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้
  • "opaque" - ค่าเริ่มต้น กิจกรรมจะบล็อกเวลาในปฏิทิน ซึ่งเทียบเท่ากับการตั้งค่าแสดงฉันเป็นเป็นไม่ว่างใน UI ของปฏิทิน
  • "transparent" - กิจกรรมไม่ได้บล็อกเวลาในปฏิทิน ซึ่งเทียบเท่ากับการตั้งค่าแสดงฉันเป็นเป็นว่างใน UI ของปฏิทิน
 เขียนได้
visibility string ระดับการเข้าถึงของกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้
  • "default" - ใช้ระดับการเข้าถึงเริ่มต้นสำหรับกิจกรรมในปฏิทิน นี่คือค่าเริ่มต้น
  • "public" - กิจกรรมเป็นแบบสาธารณะและผู้อ่านทุกคนของปฏิทินจะเห็นรายละเอียดกิจกรรม
  • "private" - กิจกรรมเป็นแบบส่วนตัว และมีเพียงผู้เข้าร่วมกิจกรรมเท่านั้นที่ดูรายละเอียดกิจกรรมได้
  • "confidential" - กิจกรรมเป็นแบบส่วนตัว ค่านี้มีไว้เพื่อเหตุผลด้านความเข้ากันได้
 เขียนได้

การตอบกลับ

หากทําสําเร็จ เมธอดนี้จะแสดงทรัพยากรเหตุการณ์ในเนื้อหาการตอบกลับ

ลองใช้งาน

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