API Reference

เอกสารอ้างอิง API นี้จัดเรียงตามประเภททรัพยากร ทรัพยากรแต่ละประเภทจะมีการนำเสนอข้อมูลอย่างน้อย 1 รายการและวิธีการอย่างน้อย 1 วิธี

ประเภททรัพยากร

  1. Acl
  2. CalendarList
  3. ปฏิทิน
  4. แชแนล
  5. สี
  6. กิจกรรม
  7. ว่าง/ไม่ว่าง
  8. การตั้งค่า

Acl

สำหรับรายละเอียดทรัพยากร Acl โปรดดูหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
ลบ DELETE  /calendars/calendarId/acl/ruleId ลบกฎควบคุมการเข้าถึง
รับ GET  /calendars/calendarId/acl/ruleId แสดงผลกฎควบคุมการเข้าถึง
แทรก POST  /calendars/calendarId/acl สร้างกฎควบคุมการเข้าถึง
list GET  /calendars/calendarId/acl แสดงผลกฎในรายการควบคุมการเข้าถึงสำหรับปฏิทิน
แพตช์ PATCH  /calendars/calendarId/acl/ruleId อัปเดตกฎควบคุมการเข้าถึง เมธอดนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการจะใช้หน่วยโควต้า 3 หน่วย ควรใช้ get ตามด้วย update ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ช่องที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง หากระบุ จะเขียนทับอาร์เรย์ที่มีอยู่ การดำเนินการนี้จะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้าทั้งหมด
อัปเดต PUT  /calendars/calendarId/acl/ruleId อัปเดตกฎควบคุมการเข้าถึง
นาฬิกา POST  /calendars/calendarId/acl/watch คอยดูการเปลี่ยนแปลงในทรัพยากร ACL

CalendarList

สำหรับรายละเอียดของทรัพยากร รายการปฏิทิน โปรดดูที่หน้าการนำเสนอทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
ลบ DELETE  /users/me/calendarList/calendarId นำปฏิทินออกจากรายการปฏิทินของผู้ใช้
รับ GET  /users/me/calendarList/calendarId แสดงผลปฏิทินจากรายการปฏิทินของผู้ใช้
แทรก POST  /users/me/calendarList แทรกปฏิทินที่มีอยู่ลงในรายการปฏิทินของผู้ใช้
list GET  /users/me/calendarList แสดงผลปฏิทินในรายการปฏิทินของผู้ใช้
แพตช์ PATCH  /users/me/calendarList/calendarId อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้ เมธอดนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการจะใช้หน่วยโควต้า 3 หน่วย ควรใช้ get ตามด้วย update ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ช่องที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง หากระบุ จะเขียนทับอาร์เรย์ที่มีอยู่ การดำเนินการนี้จะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้าทั้งหมด
อัปเดต PUT  /users/me/calendarList/calendarId อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้
นาฬิกา POST  /users/me/calendarList/watch คอยดูการเปลี่ยนแปลงของทรัพยากร รายการปฏิทิน

บริการพิมพ์ปฏิทิน

สำหรับรายละเอียดของทรัพยากรปฏิทิน โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
ล้าง POST  /calendars/calendarId/clear ล้างปฏิทินหลัก การดำเนินการนี้จะลบกิจกรรมทั้งหมดที่เชื่อมโยงกับปฏิทินหลักของบัญชี
ลบ DELETE  /calendars/calendarId ลบปฏิทินรอง ใช้ calendar.clear เพื่อล้างกิจกรรมทั้งหมดในปฏิทินหลัก
รับ GET  /calendars/calendarId แสดงผลข้อมูลเมตาสำหรับปฏิทิน
แทรก POST  /calendars สร้างปฏิทินรอง
แพตช์ PATCH  /calendars/calendarId อัปเดตข้อมูลเมตาสำหรับปฏิทิน เมธอดนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการจะใช้หน่วยโควต้า 3 หน่วย ควรใช้ get ตามด้วย update ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ช่องที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง หากระบุ จะเขียนทับอาร์เรย์ที่มีอยู่ การดำเนินการนี้จะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้าทั้งหมด
อัปเดต PUT  /calendars/calendarId อัปเดตข้อมูลเมตาสำหรับปฏิทิน

ช่อง

สำหรับรายละเอียดทรัพยากรของช่อง โปรดดูหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
หยุด POST  /channels/stop หยุดดูแหล่งข้อมูลผ่านช่องทางนี้

สี

สำหรับรายละเอียดทรัพยากรสี โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
รับ GET  /colors แสดงคำจำกัดความสีสำหรับปฏิทินและกิจกรรม

เหตุการณ์

สำหรับรายละเอียดของทรัพยากรเหตุการณ์ โปรดดูที่หน้าการนำเสนอทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
ลบ DELETE  /calendars/calendarId/events/eventId ลบกิจกรรม
รับ GET  /calendars/calendarId/events/eventId แสดงผลกิจกรรมตามรหัส Google ปฏิทิน หากต้องการดึงเหตุการณ์โดยใช้รหัส iปฏิทินของฉัน ให้เรียกใช้เมธอดevents.list โดยใช้พารามิเตอร์ iCalUID
import POST  /calendars/calendarId/events/import นำเข้าเหตุการณ์ การทำงานนี้ใช้เพื่อเพิ่มสำเนาส่วนตัวของกิจกรรมที่มีอยู่ไปยังปฏิทิน นำเข้าได้เฉพาะเหตุการณ์ที่มี eventType เป็น default เท่านั้น

ลักษณะการทำงานที่เลิกใช้งาน: หากนำเข้าเหตุการณ์ที่ไม่ใช่ default ระบบจะเปลี่ยนประเภทเหตุการณ์เป็น default และพร็อพเพอร์ตี้เฉพาะสำหรับประเภทเหตุการณ์ที่มีอยู่จะหายไป
แทรก POST  /calendars/calendarId/events สร้างกิจกรรม
อินสแตนซ์ GET  /calendars/calendarId/events/eventId/instances แสดงผลอินสแตนซ์ของกิจกรรมที่เกิดซ้ำที่ระบุ
list GET  /calendars/calendarId/events แสดงผลกิจกรรมในปฏิทินที่ระบุ
ย้าย POST  /calendars/calendarId/events/eventId/move ย้ายกิจกรรมไปยังปฏิทินอื่น เช่น เปลี่ยนผู้จัดกิจกรรม โปรดทราบว่าคุณสามารถย้ายได้เพียง default กิจกรรมเท่านั้น ไม่สามารถย้าย outOfOffice, focusTime, workingLocation และ fromGmail ได้

พารามิเตอร์การค้นหาที่จําเป็น: destination

แพตช์ PATCH  /calendars/calendarId/events/eventId อัปเดตกิจกรรม เมธอดนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการจะใช้หน่วยโควต้า 3 หน่วย ควรใช้ get ตามด้วย update ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ช่องที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง หากระบุ จะเขียนทับอาร์เรย์ที่มีอยู่ การดำเนินการนี้จะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้าทั้งหมด
quickAdd POST  /calendars/calendarId/events/quickAdd สร้างเหตุการณ์ตามสตริงข้อความธรรมดา

พารามิเตอร์การค้นหาที่จําเป็น: text

อัปเดต PUT  /calendars/calendarId/events/eventId อัปเดตกิจกรรม เมธอดนี้ไม่รองรับความหมายของแพตช์และอัปเดตทรัพยากรเหตุการณ์ทั้งหมดเสมอ หากต้องการอัปเดตบางส่วน ให้ใช้ get ตามด้วย update โดยใช้ etag เพื่อให้มั่นใจถึงความเป็นอิสระ
นาฬิกา POST  /calendars/calendarId/events/watch คอยดูการเปลี่ยนแปลงของทรัพยากรเหตุการณ์

ว่าง/ไม่ว่าง

สำหรับรายละเอียดทรัพยากรว่าง/ไม่ว่าง โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
คำค้นหา POST  /freeBusy แสดงข้อมูลว่าง/ไม่ว่างของชุดปฏิทิน

การตั้งค่า

สำหรับรายละเอียดทรัพยากรการตั้งค่า โปรดดูหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/calendar/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
รับ GET  /users/me/settings/setting แสดงการตั้งค่าสำหรับผู้ใช้รายเดียว
list GET  /users/me/settings แสดงการตั้งค่าผู้ใช้ทั้งหมดสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
นาฬิกา POST  /users/me/settings/watch คอยดูการเปลี่ยนแปลงของแหล่งข้อมูลการตั้งค่า