Trả về các lịch trong danh sách lịch của người dùng. Thử ngay.
Yêu cầu
Yêu cầu HTTP
GET https://www.googleapis.com/calendar/v3/users/me/calendarList
Thông số
| Tên thông số | Giá trị | Mô tả |
|---|---|---|
| Tham số truy vấn không bắt buộc | ||
maxResults |
integer |
Số lượng mục tối đa được trả về trên một trang kết quả. Theo mặc định, giá trị này là 100 mục. Kích thước trang không bao giờ được lớn hơn 250 mục. Không bắt buộc. |
minAccessRole |
string |
Vai trò truy cập tối thiểu của người dùng trong các mục được trả về. Không bắt buộc. Theo mặc định, không có quy tắc hạn chế nào.
Các giá trị được chấp nhận là:
|
pageToken |
string |
Mã thông báo chỉ định trang kết quả cần trả về. Không bắt buộc. |
showDeleted |
boolean |
Có bao gồm các mục trong danh sách lịch đã xoá trong kết quả hay không. Không bắt buộc. Giá trị mặc định là False. |
showHidden |
boolean |
Có hiện các mục bị ẩn hay không. Không bắt buộc. Giá trị mặc định là False. |
showOwnOrganizationOnly |
boolean |
Có chỉ hiển thị những lịch thuộc về tổ chức hay không. Tham số này chỉ áp dụng cho người dùng Google Workspace. Không bắt buộc. Giá trị mặc định là False. |
syncToken |
string |
Mã thông báo nhận được từ trường nextSyncToken được trả về trên trang kết quả cuối cùng của yêu cầu danh sách trước đó. Nhờ đó, kết quả của yêu cầu danh sách này chỉ chứa những mục đã thay đổi kể từ thời điểm đó. Nếu chỉ các trường chỉ đọc như thuộc tính lịch hoặc ACL thay đổi, thì mục đó sẽ không được trả về. Tất cả các mục đã bị xoá và ẩn kể từ yêu cầu danh sách trước đó sẽ luôn nằm trong tập kết quả và bạn không được phép đặt showDeleted cũng như showHidden thành False. Để đảm bảo tính nhất quán của trạng thái ứng dụng minAccessRole và showOwnOrganizationOnly, bạn không thể chỉ định các tham số truy vấn cùng với nextSyncToken. Nếu syncToken hết hạn, máy chủ sẽ phản hồi bằng mã phản hồi 410 GONE và ứng dụng phải xoá bộ nhớ cũng như thực hiện quy trình đồng bộ hoá đầy đủ mà không có syncToken. Tìm hiểu thêm về tính năng đồng bộ hoá gia tăng. Không bắt buộc. Chế độ mặc định là trả về tất cả các mục. |
Ủy quyền
Yêu cầu này cần có uỷ quyền với ít nhất một trong các phạm vi sau:
| Phạm vi |
|---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.calendarlist |
https://www.googleapis.com/auth/calendar.calendarlist.readonly |
Để biết thêm thông tin, hãy xem trang xác thực và uỷ quyền.
Nội dung yêu cầu
Không cung cấp nội dung yêu cầu bằng phương thức này.
Phản hồi
Nếu thành công, phương thức này sẽ trả về một phần nội dung phản hồi có cấu trúc sau:
{
"kind": "calendar#calendarList",
"etag": etag,
"nextPageToken": string,
"nextSyncToken": string,
"items": [
calendarList Resource
]
}| Tên tài sản | Giá trị | Mô tả | Ghi chú |
|---|---|---|---|
kind |
string |
Loại bộ sưu tập ("calendar#calendarList"). |
|
etag |
etag |
ETag của bộ sưu tập. | |
nextPageToken |
string |
Mã thông báo dùng để truy cập vào trang tiếp theo của kết quả này. Bị bỏ qua nếu không có kết quả nào khác, trong trường hợp đó, nextSyncToken sẽ được cung cấp. |
|
items[] |
list |
Những lịch có trong danh sách lịch của người dùng. | |
nextSyncToken |
string |
Mã thông báo được dùng vào thời điểm sau này để chỉ truy xuất những mục đã thay đổi kể từ khi kết quả này được trả về. Bị bỏ qua nếu có thêm kết quả. Trong trường hợp đó, nextPageToken sẽ được cung cấp. |
Hãy dùng thử!
Hãy sử dụng Trình khám phá API bên dưới để gọi phương thức này trên dữ liệu thực và xem phản hồi.