API Reference

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

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

  1. Acl
  2. รายการปฏิทิน
  3. ปฏิทิน
  4. แชแนล
  5. สี
  6. เหตุการณ์
  7. ไม่ว่าง
  8. การตั้งค่า

CL

ดูรายละเอียดทรัพยากรของ 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 รับชมการเปลี่ยนแปลงทรัพยากร CalendarList

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

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

วิธีการ คำขอ 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 ปฏิทินของกิจกรรม หากต้องการเรียกข้อมูลกิจกรรมโดยใช้รหัส iCalendar ให้เรียกใช้เมธอด event.list โดยใช้พารามิเตอร์ iCalUID
นําเข้า POST  /calendars/calendarId/events/import นําเข้ากิจกรรม การดําเนินการนี้ใช้เพื่อเพิ่มสําเนาส่วนตัวของกิจกรรมที่มีอยู่ลงในปฏิทิน
แทรก POST  /calendars/calendarId/events สร้างกิจกรรม
อินสแตนซ์ GET  /calendars/calendarId/events/eventId/instances แสดงผลอินสแตนซ์ของกิจกรรมที่เกิดซ้ํา
list GET  /calendars/calendarId/events แสดงผลกิจกรรมในปฏิทินที่ระบุ
ย้าย POST  /calendars/calendarId/events/eventId/move ย้ายกิจกรรมไปยังปฏิทินอื่น เช่น เปลี่ยนผู้จัดกิจกรรม

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

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

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

อัปเดต PUT  /calendars/calendarId/events/eventId อัปเดตกิจกรรม วิธีการนี้ไม่รองรับความหมายแพตช์และอัปเดตทรัพยากรทั้งหมดของเหตุการณ์เสมอ หากต้องการอัปเดตบางส่วน ให้ใช้ get ตามด้วย update โดยใช้ Etags เพื่อให้แน่ใจว่ามีความคมชัด
ดู 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 รับชมการเปลี่ยนแปลงทรัพยากรการตั้งค่า