Events: instances

แสดงผลอินสแตนซ์ของกิจกรรมที่เกิดซ้ำที่ระบุ ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
calendarId string ตัวระบุปฏิทิน หากต้องการดึงข้อมูลรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน ให้ใช้คีย์เวิร์ด "primary"
eventId string ตัวระบุกิจกรรมที่เกิดซ้ำ
พารามิเตอร์การค้นหาที่ไม่บังคับ
alwaysIncludeEmail boolean เลิกใช้งานแล้วและระบบจะละเว้น ระบบจะแสดงผลค่าในช่อง email สำหรับผู้จัดการประชุม ผู้สร้าง และผู้เข้าร่วมเสมอ แม้ว่าจะไม่มีที่อยู่อีเมลจริง (เช่น ระบบจะระบุค่าที่สร้างขึ้นซึ่งใช้ไม่ได้)
maxAttendees integer จำนวนผู้เข้าร่วมสูงสุดที่จะรวมไว้ในการตอบกลับ หากมีผู้เข้าร่วมมากกว่าจำนวนที่ระบุ ระบบจะแสดงผลเฉพาะผู้เข้าร่วมเท่านั้น ไม่บังคับ
maxResults integer จำนวนเหตุการณ์สูงสุดที่แสดงในหน้าผลการค้นหา 1 หน้า โดยค่าเริ่มต้น ค่าจะเป็น 250 เหตุการณ์ ขนาดหน้าต้องไม่เกิน 2,500 เหตุการณ์ ไม่บังคับ
originalStart string เวลาเริ่มต้นเดิมของอินสแตนซ์ในผลการค้นหา ไม่บังคับ
pageToken string โทเค็นที่ระบุหน้าผลการค้นหาที่จะแสดง ไม่บังคับ
showDeleted boolean ระบุว่าจะรวมเหตุการณ์ที่ถูกลบ (ที่มี status เท่ากับ "cancelled") ไว้ในผลการค้นหาหรือไม่ ระบบจะยังคงรวมอินสแตนซ์ที่ยกเลิกของเหตุการณ์ที่เกิดซ้ำไว้หาก singleEvents เป็น False ไม่บังคับ ค่าเริ่มต้นคือ False
timeMax datetime ขอบเขตบน (ไม่รวม) สำหรับเวลาเริ่มต้นของเหตุการณ์ที่จะกรอง ไม่บังคับ ค่าเริ่มต้นคือไม่กรองตามเวลาเริ่มต้น ต้องเป็นการประทับเวลา RFC3339 ที่มีออฟเซตเขตเวลาที่บังคับ
timeMin datetime ขอบเขตล่าง (รวม) สำหรับเวลาสิ้นสุดของเหตุการณ์ที่จะกรอง ไม่บังคับ ค่าเริ่มต้นคือไม่กรองตามเวลาสิ้นสุด ต้องเป็นการประทับเวลา RFC3339 ที่มีออฟเซตเขตเวลาที่บังคับ
timeZone string เขตเวลาที่ใช้ในการตอบกลับ ไม่บังคับ ค่าเริ่มต้นคือเขตเวลาของปฏิทิน

การให้สิทธิ์

คำขอนี้อนุญาตการให้สิทธิ์ที่มีขอบเขตอย่างน้อย 1 รายการต่อไปนี้

ขอบเขต
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

ดูข้อมูลเพิ่มเติมได้ที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อความของคำขอ

อย่าระบุเนื้อความของคำขอด้วยเมธอดนี้

การตอบกลับ

หากทำสำเร็จ เมธอดนี้จะแสดงผลเนื้อหาการตอบกลับที่มีโครงสร้างดังต่อไปนี้

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
kind string ประเภทของคอลเล็กชัน ("calendar#events")
etag etag ETag ของคอลเล็กชัน
summary string ชื่อปฏิทิน ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
description string คำอธิบายปฏิทิน ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
updated datetime เวลาแก้ไขล่าสุดของปฏิทิน (เป็นการประทับเวลา RFC3339) ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
timeZone string เขตเวลาของปฏิทิน ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
accessRole string บทบาทการเข้าถึงปฏิทินนี้ของผู้ใช้ ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว ค่าที่เป็นไปได้มีดังนี้
  • "none" - ผู้ใช้ไม่มีสิทธิ์เข้าถึง
  • "freeBusyReader" - ผู้ใช้มีสิทธิ์อ่านข้อมูลว่าง/ไม่ว่าง
  • "reader" - ผู้ใช้มีสิทธิ์อ่านปฏิทิน เหตุการณ์ส่วนตัวจะปรากฏต่อผู้ใช้ที่มีสิทธิ์อ่าน แต่ระบบจะซ่อนรายละเอียดเหตุการณ์
  • "writerWithoutPrivateAccess" - ผู้ใช้มีสิทธิ์อ่านและเขียนปฏิทิน เหตุการณ์ส่วนตัวจะปรากฏต่อผู้ใช้ที่มีสิทธิ์ writerWithoutPrivateAccess แต่ระบบจะซ่อนรายละเอียดเหตุการณ์
  • "writer" - ผู้ใช้มีสิทธิ์อ่านและเขียนปฏิทิน เหตุการณ์ส่วนตัวจะปรากฏต่อผู้ใช้ที่มีสิทธิ์ผู้เขียน และรายละเอียดเหตุการณ์จะปรากฏให้เห็น
  • "owner" - ผู้ใช้มีสิทธิ์เข้าถึงระดับผู้จัดการปฏิทิน บทบาทนี้มีสิทธิ์ทั้งหมดของบทบาทผู้เขียน พร้อมความสามารถเพิ่มเติมในการดูและแก้ไขระดับการเข้าถึงของผู้ใช้รายอื่น

defaultReminders[] list การช่วยเตือนเริ่มต้นในปฏิทินสำหรับผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ การช่วยเตือนเหล่านี้ใช้กับเหตุการณ์ทั้งหมดในปฏิทินนี้ที่ไม่ได้ลบล้างการช่วยเตือนอย่างชัดเจน (เช่น ไม่ได้ตั้งค่า reminders.useDefault เป็น True)
defaultReminders[].method string เมธอดที่การช่วยเตือนนี้ใช้ ค่าที่เป็นไปได้มีดังนี้
  • email - ระบบจะส่งการแจ้งเตือนทางอีเมล
  • popup - ระบบจะส่งการแจ้งเตือนผ่านป๊อปอัป UI

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

 เขียนได้
defaultReminders[].minutes integer จำนวนนาทีก่อนเริ่มเหตุการณ์ที่ระบบจะเริ่มการช่วยเตือน ค่าที่ใช้ได้คือระหว่าง 0 ถึง 40320 (4 สัปดาห์ในหน่วยนาที)

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

 เขียนได้
nextPageToken string โทเค็นที่ใช้เข้าถึงหน้าถัดไปของผลการค้นหานี้ ระบบจะไม่แสดงโทเค็นนี้หากไม่มีผลการค้นหาเพิ่มเติม ในกรณีนี้ระบบจะแสดง nextSyncToken
items[] list รายการเหตุการณ์ในปฏิทิน
nextSyncToken string โทเค็นที่ใช้ในภายหลังเพื่อดึงข้อมูลเฉพาะรายการที่มีการเปลี่ยนแปลงนับตั้งแต่แสดงผลการค้นหานี้ ระบบจะไม่แสดงโทเค็นนี้หากมีผลการค้นหาเพิ่มเติม ในกรณีนี้ระบบจะแสดง nextPageToken

ลองใช้งาน

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