เอกสารอ้างอิง API นี้จัดเรียงตามประเภททรัพยากร ทรัพยากรแต่ละประเภทมีการนำเสนอข้อมูลอย่างน้อย 1 รายการและวิธีการอย่างน้อย 1 วิธี
ประเภททรัพยากร
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
|
คอยดูการเปลี่ยนแปลงของทรัพยากร 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 ให้เรียกเมธอด events.list โดยใช้พารามิเตอร์ iCalUID
|
import |
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
|
ย้ายกิจกรรมไปยังปฏิทินอื่น เช่น เปลี่ยนผู้จัดกิจกรรม โปรดทราบว่าสามารถย้ายได้เพียง default กิจกรรมเท่านั้น ไม่สามารถย้าย outOfOffice , focusTime และ workingLocation ได้
พารามิเตอร์การค้นหาที่จำเป็น:
|
แพตช์ |
PATCH /calendars/calendarId/events/eventId
|
อัปเดตกิจกรรม เมธอดนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการจะใช้หน่วยโควต้า 3 หน่วย แนะนำให้ใช้ get ตามด้วย update ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ส่วนช่องที่คุณไม่ได้ระบุไว้ในคำขอจะยังคงเดิมไม่เปลี่ยนแปลง ช่องอาร์เรย์ (หากระบุ) จะเขียนทับอาร์เรย์ที่มีอยู่ ซึ่งจะยกเลิกองค์ประกอบอาร์เรย์ก่อนหน้า
|
quickAdd |
POST /calendars/calendarId/events/quickAdd
|
สร้างเหตุการณ์ตามสตริงข้อความธรรมดา
พารามิเตอร์การค้นหาที่จำเป็น:
|
อัปเดต |
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
|
คอยดูการเปลี่ยนแปลงของทรัพยากรการตั้งค่า |