Trả về các phiên bản của sự kiện định kỳ đã chỉ định. Thử ngay.
Yêu cầu
Yêu cầu HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
Thông số
| Tên thông số | Giá trị | Mô tả |
|---|---|---|
| Tham số đường dẫn | ||
calendarId |
string |
Mã nhận dạng lịch. Để truy xuất mã lịch, hãy gọi phương thức calendarList.list. Nếu bạn muốn truy cập vào lịch chính của người dùng hiện đang đăng nhập, hãy sử dụng từ khoá "primary".
|
eventId |
string |
Giá trị nhận dạng sự kiện định kỳ. |
| Tham số truy vấn không bắt buộc | ||
alwaysIncludeEmail |
boolean |
Không dùng nữa và bị bỏ qua. Giá trị sẽ luôn được trả về trong trường email cho người tổ chức, người tạo và người tham dự, ngay cả khi không có địa chỉ email thực (tức là một giá trị được tạo, không hoạt động sẽ được cung cấp).
|
maxAttendees |
integer |
Số người tham dự tối đa cần đưa vào phản hồi. Nếu có nhiều người tham dự hơn số lượng được chỉ định, thì chỉ người tham gia mới được trả về. Không bắt buộc. |
maxResults |
integer |
Số lượng sự kiện tối đa được trả về trên một trang kết quả. Theo mặc định, giá trị này là 250 sự kiện. Kích thước trang không bao giờ được lớn hơn 2.500 sự kiện. Không bắt buộc. |
originalStart |
string |
Thời gian bắt đầu ban đầu của phiên bản trong kết quả. Không bắt buộc. |
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 sự kiện đã xoá (có status bằng "cancelled") trong kết quả hay không. Các phiên bản bị huỷ của sự kiện định kỳ vẫn sẽ được đưa vào nếu singleEvents là False. Không bắt buộc. Giá trị mặc định là False.
|
timeMax |
datetime |
Giới hạn trên (loại trừ) cho thời gian bắt đầu của một sự kiện để lọc theo. Không bắt buộc. Theo mặc định, bạn không thể lọc theo thời gian bắt đầu. Phải là dấu thời gian RFC3339 có độ lệch múi giờ bắt buộc. |
timeMin |
datetime |
Giới hạn dưới (bao gồm) cho thời gian kết thúc của một sự kiện để lọc theo. Không bắt buộc. Chế độ mặc định là không lọc theo thời gian kết thúc. Phải là dấu thời gian RFC3339 có độ lệch múi giờ bắt buộc. |
timeZone |
string |
Múi giờ được dùng trong câu trả lời. Không bắt buộc. Múi giờ mặc định là múi giờ của lịch. |
Ủy quyền
Yêu cầu này cho phép 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.events.readonly |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.freebusy |
https://www.googleapis.com/auth/calendar.events.owned |
https://www.googleapis.com/auth/calendar.events.owned.readonly |
https://www.googleapis.com/auth/calendar.events.public.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#events",
"etag": etag,
"summary": string,
"description": string,
"updated": datetime,
"timeZone": string,
"accessRole": string,
"defaultReminders": [
{
"method": string,
"minutes": integer
}
],
"nextPageToken": string,
"nextSyncToken": string,
"items": [
events Resource
]
}| Tên tài sản | Giá trị | Mô tả | Ghi chú |
|---|---|---|---|
kind |
string |
Loại bộ sưu tập ("calendar#events"). |
|
etag |
etag |
ETag của bộ sưu tập. | |
summary |
string |
Tiêu đề của lịch. Chỉ đọc. | |
description |
string |
Nội dung mô tả về lịch. Chỉ đọc. | |
updated |
datetime |
Thời gian sửa đổi lần gần đây nhất của lịch (dưới dạng dấu thời gian RFC3339). Chỉ đọc. | |
timeZone |
string |
Múi giờ của lịch. Chỉ đọc. | |
accessRole |
string |
Vai trò truy cập của người dùng đối với lịch này. Chỉ đọc. Các giá trị có thể là:
|
|
defaultReminders[] |
list |
Lời nhắc mặc định trên lịch cho người dùng đã xác thực. Những lời nhắc này áp dụng cho tất cả sự kiện trên lịch này mà không ghi đè một cách rõ ràng (tức là không đặt reminders.useDefault thành True). |
|
defaultReminders[].method |
string |
Phương thức mà lời nhắc này sử dụng. Các giá trị có thể là:
Bắt buộc khi thêm lời nhắc. |
có thể ghi |
defaultReminders[].minutes |
integer |
Số phút trước khi sự kiện bắt đầu mà lời nhắc sẽ kích hoạt. Giá trị hợp lệ nằm trong khoảng từ 0 đến 40320 (4 tuần tính bằng phút). Bắt buộc khi thêm lời nhắc. |
có thể ghi |
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 |
Danh sách các sự kiện trên lịch. | |
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.