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 biểu diễn dữ liệu và một hoặc nhiều phương thức.
Loại tài nguyên
Acl
Để biết thông tin chi tiết về Tài nguyên Acl, hãy xem trang trình bày tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| xóa |
DELETE /calendars/calendarId/acl/ruleId
|
Xoá quy tắc kiểm soát quyền truy cập. |
| nhận |
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 của lịch. |
| bản vá |
PATCH /calendars/calendarId/acl/ruleId
|
Cập nhật mộ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 bản vá sử dụng 3 đơn vị hạn mức; hãy ưu tiên sử dụng get trước update. Các giá trị của trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường 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 đó.
|
| cập nhật |
PUT /calendars/calendarId/acl/ruleId
|
Cập nhật một quy tắc kiểm soát quyền truy cập. |
| đồng hồ |
POST /calendars/calendarId/acl/watch
|
Chú ý các thay đổi đối với tài nguyên Danh sách kiểm soát quyền truy cập (ACL). |
CalendarList
Để biết thông tin chi tiết về Tài nguyên của CalendarList, hãy xem trang trình bày tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| xóa |
DELETE /users/me/calendarList/calendarId
|
Xoá lịch khỏi danh sách lịch của người dùng. |
| nhận |
GET /users/me/calendarList/calendarId
|
Trả về lịch từ 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 trên danh sách lịch của người dùng. |
| bản vá |
PATCH /users/me/calendarList/calendarId
|
Cập nhậ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 bản vá sử dụng 3 đơn vị hạn mức; hãy ưu tiên sử dụng get trước update. Các giá trị của trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường 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 đó.
|
| cập nhật |
PUT /users/me/calendarList/calendarId
|
Cập nhật lịch hiện có trong danh sách lịch của người dùng. |
| đồng hồ |
POST /users/me/calendarList/watch
|
Chú ý đến những 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 đại diện cho tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| xoá |
POST /calendars/calendarId/clear
|
Xoá lịch chính. Thao tác này sẽ xoá tất cả sự kiện được liên kết với lịch chính của tài khoản. |
| xóa |
DELETE /calendars/calendarId
|
Xoá lịch phụ. Sử dụng calendar.clear để xoá tất cả các sự kiện trên lịch chính. |
| nhận |
GET /calendars/calendarId
|
Trả về siêu dữ liệu cho 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 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 bản vá sử dụng 3 đơn vị hạn mức; hãy ưu tiên sử dụng get trước update. Các giá trị của trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường 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 đó.
|
| cập nhật |
PUT /calendars/calendarId
|
Cập nhật siêu dữ liệu cho lịch. |
Kênh
Để biết chi tiết về tài nguyên kênh, xem trang trình bày tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| dừng |
POST /channels/stop
|
Dừng xem tài nguyên qua kênh này. |
Màu sắc
Để biết chi tiết về Tài nguyên màu, hãy xem trang đại diện cho tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| nhận |
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 trình bày tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| xóa |
DELETE /calendars/calendarId/events/eventId
|
Xoá sự kiện. |
| nhận |
GET /calendars/calendarId/events/eventId
|
Trả về một sự kiện dựa trên mã Lịch Google của sự kiện đó. Để truy xuất một sự kiện bằng mã iLịch của sự kiện đó, hãy gọi phương thức
events.list bằng cách sử dụng thông số iCalUID.
|
| import |
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 các 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 |
| chèn |
POST /calendars/calendarId/events
|
Tạo một sự kiện. |
| thực thể |
GET /calendars/calendarId/events/eventId/instances
|
Trả về các phiên bản 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 đã chỉ định. |
| di chuyển |
POST /calendars/calendarId/events/eventId/move
|
Di chuyển một sự kiện sang 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 outOfOffice, focusTime và workingLocation.
Tham số truy vấn bắt buộc:
|
| 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 bản vá sử dụng 3 đơn vị hạn mức; hãy ưu tiên sử dụng get trước update. Các giá trị của trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường 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 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:
|
| cập nhật |
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 củ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 thẻ điện tử để đảm bảo tính nguyên âm.
|
| đồng hồ |
POST /calendars/calendarId/events/watch
|
Chú ý đến những thay đổi đối với các tài nguyên về Sự kiện. |
Rảnh/bận
Để biết thông tin chi tiết về Tài nguyên rảnh/bận, hãy xem trang trình bày tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| truy vấn |
POST /freeBusy
|
Trả về thông tin 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 trình bày về tài nguyên.
| Phương thức | Yêu cầu HTTP | Nội dung mô tả |
|---|---|---|
| URI so với https://www.googleapis.com/calendar/v3, trừ phi có lưu ý khác | ||
| nhận |
GET /users/me/settings/setting
|
Trả về chế độ cài đặt của một người dùng. |
| list |
GET /users/me/settings
|
Trả về tất cả chế độ cài đặt người dùng liên quan đến người dùng đã xác thực. |
| đồng hồ |
POST /users/me/settings/watch
|
Chú ý đến những thay đổi đối với các tài nguyên trong phần Cài đặt. |