API Reference

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

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

  1. Acl
  2. CalendarList
  3. ปฏิทิน
  4. ช่อง
  5. สี
  6. เหตุการณ์
  7. Freebusy
  8. การตั้งค่า

Acl

ดูรายละเอียดทรัพยากร Acl ได้ที่หน้าการแสดงทรัพยากร

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

CalendarList

ดูรายละเอียดทรัพยากร CalendarList ได้ที่หน้าการแสดงทรัพยากร

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

ปฏิทิน

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

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

ช่อง

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

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

สี

ดูรายละเอียดแหล่งข้อมูลสีได้ที่หน้าการแสดงทรัพยากร

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

กิจกรรม

ดูรายละเอียดทรัพยากรเหตุการณ์ได้ที่หน้าการแสดงทรัพยากร

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

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

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

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

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

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

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

ดูรายละเอียดทรัพยากรเวลาว่างได้ที่หน้าการแสดงทรัพยากร

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

การตั้งค่า

ดูรายละเอียดแหล่งข้อมูลการตั้งค่าได้ที่หน้าการแสดงทรัพยากร

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