API Reference

Tài liệu tham khảo API này được sắp xếp theo loại tài nguyên. Mỗi loại tài nguyên có một hoặc nhiều cách trình bày dữ liệu và một hoặc nhiều phương thức.

Loại tài nguyên

  1. Acl
  2. CalendarList
  3. Lịch
  4. Kênh
  5. Màu sắc
  6. Sự kiện
  7. Lịch trống/bận
  8. Cài đặt

Acl

Để biết thông tin chi tiết về Tài nguyên Acl, hãy xem trang biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
xóa DELETE  /calendars/calendarId/acl/ruleId Xoá một quy tắc kiểm soát quyền truy cập.
get GET  /calendars/calendarId/acl/ruleId Trả về một quy tắc kiểm soát quyền truy cập.
chèn POST  /calendars/calendarId/acl Tạo quy tắc kiểm soát quyền truy cập.
list GET  /calendars/calendarId/acl Trả về các quy tắc trong danh sách kiểm soát quyền truy cập cho lịch.
bản vá PATCH  /calendars/calendarId/acl/ruleId Cập nhật quy tắc kiểm soát quyền truy cập. Phương thức này hỗ trợ ngữ nghĩa của bản vá. Xin lưu ý rằng mỗi yêu cầu vá sẽ tiêu thụ 3 đơn vị hạn mức; ưu tiên sử dụng get theo sau là update. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường mà bạn không chỉ định trong yêu cầu sẽ không thay đổi. Các trường mảng, nếu được chỉ định, sẽ ghi đè các mảng hiện có; thao tác này sẽ loại bỏ mọi phần tử mảng trước đó.
update PUT  /calendars/calendarId/acl/ruleId Cập nhật quy tắc kiểm soát quyền truy cập.
watch POST  /calendars/calendarId/acl/watch Theo dõi các thay đổi đối với tài nguyên ACL.

CalendarList

Để biết thông tin chi tiết về Tài nguyên CalendarList, hãy xem trang biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
xóa DELETE  /users/me/calendarList/calendarId Xoá một lịch khỏi danh sách lịch của người dùng.
get GET  /users/me/calendarList/calendarId Trả về một lịch trong danh sách lịch của người dùng.
chèn POST  /users/me/calendarList Chèn một lịch hiện có vào danh sách lịch của người dùng.
list GET  /users/me/calendarList Trả về các lịch trong danh sách lịch của người dùng.
bản vá PATCH  /users/me/calendarList/calendarId Cập nhật một lịch hiện có trong danh sách lịch của người dùng. Phương thức này hỗ trợ ngữ nghĩa của bản vá. Xin lưu ý rằng mỗi yêu cầu vá sẽ tiêu thụ 3 đơn vị hạn mức; ưu tiên sử dụng get theo sau là update. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường mà bạn không chỉ định trong yêu cầu sẽ không thay đổi. Các trường mảng, nếu được chỉ định, sẽ ghi đè các mảng hiện có; thao tác này sẽ loại bỏ mọi phần tử mảng trước đó.
update PUT  /users/me/calendarList/calendarId Cập nhật một lịch hiện có trong danh sách lịch của người dùng.
watch POST  /users/me/calendarList/watch Theo dõi các thay đổi đối với tài nguyên CalendarList.

Lịch

Để biết thông tin chi tiết về Tài nguyên lịch, hãy xem trang biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
clear POST  /calendars/calendarId/clear Xoá lịch chính. Thao tác này sẽ xoá tất cả sự kiện liên kết với lịch chính của một tài khoản.
xóa DELETE  /calendars/calendarId Xoá một lịch phụ. Sử dụng calendars.clear để xoá tất cả sự kiện trên lịch chính.
get GET  /calendars/calendarId Trả về siêu dữ liệu cho một lịch.
chèn POST  /calendars Tạo lịch phụ.
bản vá PATCH  /calendars/calendarId Cập nhật siêu dữ liệu cho một lịch. Phương thức này hỗ trợ ngữ nghĩa của bản vá. Xin lưu ý rằng mỗi yêu cầu vá sẽ tiêu thụ 3 đơn vị hạn mức; ưu tiên sử dụng get theo sau là update. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường mà bạn không chỉ định trong yêu cầu sẽ không thay đổi. Các trường mảng, nếu được chỉ định, sẽ ghi đè các mảng hiện có; thao tác này sẽ loại bỏ mọi phần tử mảng trước đó.
update PUT  /calendars/calendarId Cập nhật siêu dữ liệu cho một lịch.

Kênh

Để biết thông tin chi tiết về Tài nguyên kênh, hãy xem trang biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
dừng POST  /channels/stop Ngừng xem tài nguyên thông qua kênh này.

Màu

Để biết thông tin chi tiết về Tài nguyên màu, hãy xem trang phương thức biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
get GET  /colors Trả về định nghĩa màu cho lịch và sự kiện.

Sự kiện

Để biết thông tin chi tiết về Tài nguyên sự kiện, hãy xem trang biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
xóa DELETE  /calendars/calendarId/events/eventId Xoá một sự kiện.
get GET  /calendars/calendarId/events/eventId Trả về một sự kiện dựa trên mã sự kiện trên Lịch Google. Để truy xuất một sự kiện bằng mã nhận dạng iCalendar, hãy gọi phương thức events.list bằng tham số iCalUID.
nhập POST  /calendars/calendarId/events/import Nhập một sự kiện. Thao tác này dùng để thêm bản sao riêng tư của một sự kiện hiện có vào lịch. Bạn chỉ có thể nhập những sự kiện có eventType là default.

Hành vi không dùng nữa: Nếu bạn nhập một sự kiện không phải default, thì loại sự kiện đó sẽ được thay đổi thành default và mọi thuộc tính dành riêng cho loại sự kiện mà sự kiện đó có thể có sẽ bị xoá.
chèn POST  /calendars/calendarId/events Tạo một sự kiện.
phiên bản GET  /calendars/calendarId/events/eventId/instances Trả về các thực thể của sự kiện định kỳ đã chỉ định.
list GET  /calendars/calendarId/events Trả về các sự kiện trên lịch được chỉ định.
di chuyển POST  /calendars/calendarId/events/eventId/move Di chuyển một sự kiện sang một lịch khác, tức là thay đổi người tổ chức sự kiện. Xin lưu ý rằng bạn chỉ có thể di chuyển các sự kiện default; không thể di chuyển các sự kiện birthday, focusTime, fromGmail, outOfOffice và workingLocation.

Tham số truy vấn bắt buộc: destination

bản vá PATCH  /calendars/calendarId/events/eventId Cập nhật một sự kiện. Phương thức này hỗ trợ ngữ nghĩa của bản vá. Xin lưu ý rằng mỗi yêu cầu vá sẽ tiêu thụ 3 đơn vị hạn mức; ưu tiên sử dụng get theo sau là update. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường mà bạn không chỉ định trong yêu cầu sẽ không thay đổi. Các trường mảng, nếu được chỉ định, sẽ ghi đè các mảng hiện có; thao tác này sẽ loại bỏ mọi phần tử mảng trước đó.
quickAdd POST  /calendars/calendarId/events/quickAdd Tạo một sự kiện dựa trên một chuỗi văn bản đơn giản.

Tham số truy vấn bắt buộc: text

update PUT  /calendars/calendarId/events/eventId Cập nhật một sự kiện. Phương thức này không hỗ trợ ngữ nghĩa bản vá và luôn cập nhật toàn bộ tài nguyên sự kiện. Để cập nhật một phần, hãy thực hiện get, theo sau là update bằng cách sử dụng etags để đảm bảo tính nguyên tử.
watch POST  /calendars/calendarId/events/watch Theo dõi các thay đổi đối với tài nguyên Sự kiện.

Rảnh/bận

Để biết thông tin chi tiết về Tài nguyên lịch biểu trống, hãy xem trang biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
cụm từ tìm kiếm POST  /freeBusy Trả về thông tin về tình trạng rảnh/bận cho một nhóm lịch.

Cài đặt

Để biết thông tin chi tiết về Tài nguyên cài đặt, hãy xem trang biểu thị tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://www.googleapis.com/calendar/v3, trừ phi có ghi chú khác
get GET  /users/me/settings/setting Trả về một chế độ cài đặt người dùng.
list GET  /users/me/settings Trả về tất cả chế độ cài đặt người dùng cho người dùng đã xác thực.
watch POST  /users/me/settings/watch Theo dõi các thay đổi đối với tài nguyên Cài đặt.