Công cụ: list_events
Trả về các sự kiện trên lịch đã cho khớp với tất cả các điều kiện ràng buộc được chỉ định. Bạn không nên chỉ định các hạn chế về thời gian, trừ phi người dùng yêu cầu. Đối với các cụm từ tìm kiếm dựa trên chủ đề hoặc từ khoá không giới hạn trên lịch chính, bạn phải sử dụng công cụ search_events.
Mẫu sau đây minh hoạ cách sử dụng curl để gọi công cụ MCP list_events.
| Yêu cầu Curl |
|---|
curl --location 'https://calendarmcp.googleapis.com/mcp/v1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "list_events", "arguments": { // provide these details according to the tool MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Giản đồ đầu vào
ListEventsRequest
| Biểu diễn dưới dạng JSON |
|---|
{
"eventTypeFilter": [
string
],
"eventType": [
enum ( |
| Trường | |
|---|---|
eventTypeFilter[] |
Không bắt buộc. Không dùng nữa: hãy sử dụng |
eventType[] |
Không bắt buộc. Các loại sự kiện cần trả về. Nếu trống, chỉ các loại sự kiện sau được trả về: |
Trường nhóm
|
|
calendarId |
Không bắt buộc. Mã của lịch chứa các sự kiện. Địa chỉ email – có thể được phân giải bằng |
Trường nhóm
|
|
pageSize |
Không bắt buộc. Số sự kiện tối đa trên mỗi trang (mặc định là |
Trường nhóm
|
|
pageToken |
Không bắt buộc. Mã thông báo trang tiếp theo. Sử dụng giá trị |
Trường nhóm
|
|
startTime |
Không bắt buộc. Giới hạn dưới của một khoảng thời gian. Chỉ được đặt khi người dùng yêu cầu một khung thời gian cụ thể. Phải là dấu thời gian ISO 8601 nhỏ hơn |
Trường nhóm
|
|
endTime |
Không bắt buộc. Giới hạn trên của một khoảng thời gian. Chỉ được đặt khi người dùng yêu cầu một khung thời gian cụ thể hoặc một thời điểm trong quá khứ. Phải là dấu thời gian ISO 8601 lớn hơn |
Trường nhóm
|
|
timeZone |
Không bắt buộc. Múi giờ (mã nhận dạng IANA, ví dụ: |
Trường nhóm
|
|
orderBy |
Không bắt buộc. Thứ tự trả về các sự kiện. Các giá trị có thể là:
|
Trường nhóm
|
|
fullText |
Không bắt buộc. Tìm kiếm không phân biệt chữ hoa chữ thường theo biểu mẫu tự do, khớp với tiêu đề, nội dung mô tả, vị trí hoặc người tham dự. Khớp với những sự kiện chứa tất cả các cụm từ tìm kiếm nguyên văn (tìm kiếm AND). |
EventType
Loại sự kiện. Không thể thay đổi sau khi tạo.
| Enum | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
Được coi là DEFAULT. |
DEFAULT |
Sự kiện định kỳ. Giá trị mặc định. |
OUT_OF_OFFICE |
Sự kiện không có mặt tại văn phòng. |
FOCUS_TIME |
Sự kiện thời gian cần tập trung. |
WORKING_LOCATION |
Sự kiện về địa điểm làm việc. |
BIRTHDAY |
Sự kiện đặc biệt kéo dài cả ngày và diễn ra hằng năm. |
FROM_GMAIL |
Sự kiện từ Gmail. Bạn không thể tạo loại sự kiện này. |
Giản đồ đầu ra
ListEventsResponse
| Biểu diễn dưới dạng JSON |
|---|
{ "summary": string, "description": string, "updated": string, "timeZone": string, "accessRole": string, "defaultReminders": [ { object ( |
| Trường | |
|---|---|
summary |
Tiêu đề của lịch. |
description |
Nội dung mô tả về lịch. |
updated |
Thời gian cập nhật gần đây nhất (ISO 8601) của lịch. |
timeZone |
Múi giờ của lịch. |
accessRole |
Chỉ có đầu ra. Vai trò truy cập của người dùng đối với lịch. Các giá trị có thể là:
owner khác với chủ sở hữu dữ liệu của lịch. Một lịch chỉ có một chủ sở hữu dữ liệu, nhưng có thể có nhiều người dùng có vai trò owner.
|
defaultReminders[] |
Lời nhắc mặc định cho các sự kiện trên lịch. |
events[] |
Danh sách sự kiện. |
Trường nhóm
|
|
nextPageToken |
Mã thông báo trang tiếp theo. Bị bỏ qua nếu không có trang tiếp theo. |
Lời nhắc
| Biểu diễn dưới dạng JSON |
|---|
{ "method": string "minutes": integer } |
| Trường | |
|---|---|
Trường nhóm
|
|
method |
Bắt buộc. Phương thức phân phối. Các giá trị có thể là:
|
Trường nhóm
|
|
minutes |
Bắt buộc. Số phút trước khi lời nhắc được kích hoạt. |
Sự kiện
| Biểu diễn dưới dạng JSON |
|---|
{ "id": string, "status": string, "htmlLink": string, "created": string, "updated": string, "summary": string, "description": string, "location": string, "creator": { object ( |
| Trường | |
|---|---|
id |
Giá trị nhận dạng riêng biệt. |
status |
Không bắt buộc. Trạng thái. Các giá trị có thể là:
|
htmlLink |
Chỉ có đầu ra. Đường liên kết tuyệt đối đến sự kiện này trong giao diện người dùng web của Lịch Google. |
created |
Chỉ có đầu ra. Thời gian tạo (ISO 8601). |
updated |
Chỉ có đầu ra. Thời gian sửa đổi lần gần đây nhất (ISO 8601). |
summary |
Tiêu đề. |
description |
Không bắt buộc. Nội dung mô tả. Có thể chứa HTML. |
location |
Không bắt buộc. Vị trí. |
creator |
Chỉ có đầu ra. Nhà sáng tạo. |
organizer |
Chỉ có đầu ra. Đơn vị tổ chức. Cũng có tên trong danh sách người tham dự nếu tham dự. |
start |
Thời gian bắt đầu (bao gồm cả giá trị đầu và giá trị cuối). Đối với sự kiện định kỳ, hệ thống sẽ sử dụng lần diễn ra đầu tiên. |
end |
Thời gian kết thúc (loại trừ). Đối với các sự kiện định kỳ, hệ thống sẽ sử dụng phiên bản đầu tiên. |
recurrence[] |
Quy tắc định kỳ dưới dạng chuỗi |
recurringEventId |
Mã sự kiện định kỳ mẹ cho các phiên bản của sự kiện định kỳ. |
originalStartTime |
Thời gian bắt đầu ban đầu của các sự kiện định kỳ. Đây là thời điểm phiên bản này sẽ bắt đầu theo dữ liệu định kỳ. |
transparency |
Không bắt buộc. Không dùng nữa: hãy sử dụng |
visibility |
Không bắt buộc. Chế độ hiển thị của sự kiện. Các giá trị có thể là:
|
attendees[] |
Người tham dự. |
conferenceUrl |
Đường liên kết đến hội nghị truyền hình. |
colorId |
Màu của sự kiện. Chỉ ảnh hưởng đến chế độ xem lịch của riêng bạn. Đây là mã nhận dạng đề cập đến một mục trong bảng màu của lịch (chuỗi
|
overrideReminders[] |
Lời nhắc. Quay lại chế độ cài đặt mặc định của lịch nếu chưa được đặt. |
attachments[] |
Tệp đính kèm. |
guestPermissions |
Quyền của khách. |
eventType |
Loại sự kiện. |
workingLocationProperties |
Thuộc tính địa điểm làm việc. Chỉ được điền sẵn khi |
availability |
Không bắt buộc. Chế độ cài đặt tình trạng rảnh/bận. |
Tổng
| Biểu diễn dưới dạng JSON |
|---|
{ "email": string, "displayName": string, "self": boolean } |
| Trường | |
|---|---|
email |
Email. |
displayName |
Tên. |
self |
Chỉ có đầu ra. Liệu người dùng này có tương ứng với lịch mà bản sao của sự kiện này xuất hiện hay không. Mặc định: |
DateOrDateTime
| Biểu diễn dưới dạng JSON |
|---|
{ "date": string, "dateTime": string, "timeZone": string } |
| Trường | |
|---|---|
date |
Ngày theo tiêu chuẩn ISO 8601 vào nửa đêm theo giờ UTC (ví dụ: |
dateTime |
Dấu thời gian ISO 8601 (ví dụ: |
timeZone |
Tên múi giờ TZDB. |
Người tham dự
| Biểu diễn dưới dạng JSON |
|---|
{ "id": string "email": string "displayName": string "organizer": boolean "self": boolean "resource": boolean "optionalAttendee": boolean "responseStatus": string "comment": string "additionalGuests": integer } |
| Trường | |
|---|---|
Trường nhóm
|
|
id |
Chỉ có đầu ra. Mã hồ sơ. |
Trường nhóm
|
|
email |
Bắt buộc. Địa chỉ email của người tham dự. |
Trường nhóm
|
|
displayName |
Không bắt buộc. Tên. |
Trường nhóm
|
|
organizer |
Chỉ có đầu ra. Người tham dự có phải là người tổ chức hay không. Mặc định: |
Trường nhóm
|
|
self |
Chỉ có đầu ra. Liệu mục này có đại diện cho lịch mà bản sao này của sự kiện xuất hiện hay không. Mặc định: |
Trường nhóm
|
|
resource |
Không bắt buộc. Người tham dự có phải là tài nguyên (ví dụ: phòng) hay không. Không thể thay đổi, chỉ có thể đặt khi người tham dự được thêm lần đầu. Mặc định: |
Trường nhóm
|
|
optionalAttendee |
Không bắt buộc. Người tham dự có phải là không bắt buộc hay không. Mặc định: |
Trường nhóm
|
|
responseStatus |
Không bắt buộc. Trạng thái phản hồi. Các giá trị có thể là:
|
Trường nhóm
|
|
comment |
Chỉ có đầu ra. Bình luận phản hồi. |
Trường nhóm
|
|
additionalGuests |
Không bắt buộc. Số lượng khách bổ sung. Mặc định: |
Tệp đính kèm
| Biểu diễn dưới dạng JSON |
|---|
{ "fileUrl": string "title": string } |
| Trường | |
|---|---|
Trường nhóm
|
|
fileUrl |
Bắt buộc. Đường liên kết URL đến tệp đính kèm. |
Trường nhóm
|
|
title |
Không bắt buộc. Tên tệp đính kèm. |
GuestPermissions
| Biểu diễn dưới dạng JSON |
|---|
{ "guestsCanInviteOthers": boolean "guestsCanModify": boolean "guestsCanSeeGuests": boolean } |
| Trường | |
|---|---|
Trường nhóm
|
|
guestsCanInviteOthers |
Không bắt buộc. Khách có thể mời người khác hay không. |
Trường nhóm
|
|
guestsCanModify |
Không bắt buộc. Khách có thể sửa đổi sự kiện hay không. |
Trường nhóm
|
|
guestsCanSeeGuests |
Không bắt buộc. Cho biết khách có thể xem những khách khác hay không. |
WorkingLocationProperties
| Biểu diễn dưới dạng JSON |
|---|
{
"type": enum ( |
| Trường | |
|---|---|
Trường nhóm
|
|
type |
Không bắt buộc. Loại địa điểm làm việc. |
Trường nhóm
|
|
customLocationLabel |
Không bắt buộc. Nhãn của một vị trí tuỳ chỉnh. Bắt buộc nếu loại là |
EventType
Loại sự kiện. Không thể thay đổi sau khi tạo.
| Enum | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
Được coi là DEFAULT. |
DEFAULT |
Sự kiện định kỳ. Giá trị mặc định. |
OUT_OF_OFFICE |
Sự kiện không có mặt tại văn phòng. |
FOCUS_TIME |
Sự kiện thời gian cần tập trung. |
WORKING_LOCATION |
Sự kiện về địa điểm làm việc. |
BIRTHDAY |
Sự kiện đặc biệt kéo dài cả ngày và diễn ra hằng năm. |
FROM_GMAIL |
Sự kiện từ Gmail. Bạn không thể tạo loại sự kiện này. |
WorkingLocationType
Loại địa điểm làm việc.
| Enum | |
|---|---|
WORKING_LOCATION_TYPE_UNSPECIFIED |
Loại địa điểm làm việc chưa được chỉ định. Sẽ được coi là HOME_OFFICE. |
HOME_OFFICE |
Văn phòng tại nhà. |
CUSTOM_LOCATION |
Vị trí tuỳ chỉnh. |
Phạm vi cung cấp
Chế độ cài đặt tình trạng rảnh/bận cho một sự kiện.
| Enum | |
|---|---|
AVAILABILITY_UNSPECIFIED |
Mặc định. Được coi là BUSY. |
AVAILABILITY_BUSY |
Chặn thời gian trên lịch. |
AVAILABILITY_FREE |
Không chặn thời gian. |
Chú giải công cụ
Gợi ý phá hoại: ❌ | Gợi ý bất biến: ✅ | Gợi ý chỉ đọc: ✅ | Gợi ý thế giới mở: ❌
Phạm vi cấp phép
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/calendarhttps://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.events.readonlyhttps://www.googleapis.com/auth/calendar.readonly