CalendarList: list

Trả về các lịch trong danh sách lịch của người dùng. 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ả
Thông số truy vấn không bắt buộc
maxResults integer Số 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ó hạn chế nào.

Các giá trị được chấp nhận là:
  • "freeBusyReader": Người dùng có thể đọc thông tin về thời gian rảnh/bận.
  • "owner": Người dùng có thể đọc và sửa đổi sự kiện cũng như danh sách kiểm soát quyền truy cập.
  • "reader": Người dùng có thể đọc các sự kiện không phải là sự kiện riêng tư.
  • "writer": Người dùng có thể đọc và sửa đổi sự kiện.
  • "writerWithoutPrivateAccess": Người dùng có thể đọc và sửa đổi sự kiện, nhưng không thể truy cập vào các sự kiện riêng tư.
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ó đưa các mục trong danh sách lịch đã xoá vào 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.
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 đó. Mã này giúp kết quả của yêu cầu danh sách này chỉ chứa các mục đã thay đổi kể từ đó. Nếu chỉ các trường chỉ đọc (chẳng hạn như thuộc tính lịch hoặc danh sách kiểm soát quyền truy cập) thay đổi, thì mục đó sẽ không được trả về. Tất cả các mục đã 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 đặ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, bạn không thể chỉ định tham số truy vấn minAccessRole 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 cần xoá bộ nhớ cũng như thực hiện quá trình đồng bộ hoá đầy đủ mà không có syncToken.
Tìm hiểu thêm về quá trình đồng bộ hoá gia tăng.
Không bắt buộc. Theo mặc định, tất cả các mục sẽ được trả về.

Ủ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 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 Các 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 các mục đã thay đổi kể từ khi kết quả này được trả về. Bị bỏ qua nếu có kết quả khác, trong trường hợp đó, nextPageToken sẽ được cung cấp.

Hãy dùng thử!

Sử dụng APIs Explorer 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.