API Reference

เอกสารอ้างอิง API นี้จัดเรียงตามประเภททรัพยากร ทรัพยากรแต่ละประเภทมีการแสดงข้อมูลอย่างน้อย 1 รายการและเมธอดอย่างน้อย 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  /calendars/calendarId/acl/ruleId แสดงกฎการควบคุมการเข้าถึง
แทรก POST  /calendars/calendarId/acl สร้างกฎการควบคุมการเข้าถึง
list GET  /calendars/calendarId/acl แสดงกฎในรายการควบคุมการเข้าถึงสำหรับปฏิทิน
patch PATCH  /calendars/calendarId/acl/ruleId อัปเดตกฎการควบคุมการเข้าถึง วิธีนี้รองรับความหมายของการแก้ไข โปรดทราบว่าคำขอแก้ไขแต่ละรายการจะใช้โควต้า 3 หน่วย ดังนั้นจึงควรใช้ get ตามด้วย update ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ฟิลด์ที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง ฟิลด์อาร์เรย์ หากระบุไว้ จะเขียนทับอาร์เรย์ที่มีอยู่ ซึ่งจะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้า
อัปเดต PUT  /calendars/calendarId/acl/ruleId อัปเดตกฎการควบคุมการเข้าถึง
ดู POST  /calendars/calendarId/acl/watch คอยดูการเปลี่ยนแปลงในทรัพยากร ACL

CalendarList

ดูรายละเอียดเกี่ยวกับทรัพยากร 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 PATCH  /users/me/calendarList/calendarId อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้ วิธีนี้รองรับความหมายของการแก้ไข โปรดทราบว่าคำขอแก้ไขแต่ละรายการจะใช้โควต้า 3 หน่วย ดังนั้นจึงควรใช้ get ตามด้วย update ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ฟิลด์ที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง ฟิลด์อาร์เรย์ หากระบุไว้ จะเขียนทับอาร์เรย์ที่มีอยู่ ซึ่งจะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้า
อัปเดต PUT  /users/me/calendarList/calendarId อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้
ดู POST  /users/me/calendarList/watch ดูการเปลี่ยนแปลงทรัพยากร CalendarList

ปฏิทิน

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

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

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

ช่อง

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

วิธีการ คำขอ 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 ปฏิทินของกิจกรรม หากต้องการดึงข้อมูลกิจกรรมโดยใช้รหัส iCalendar ให้เรียกใช้เมธอด 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 เท่านั้น ส่วนกิจกรรม birthday, focusTime, fromGmail, outOfOffice และ workingLocation จะย้ายไม่ได้

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

patch 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 เว้นแต่จะระบุไว้เป็นอย่างอื่น
query 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 โปรดติดตามการเปลี่ยนแปลงในแหล่งข้อมูลการตั้งค่า