الأداة: list_events
تعرض هذه الطريقة الأحداث في التقويم المحدّد التي تتطابق مع جميع القيود المحدّدة. يجب عدم تحديد قيود زمنية ما لم يطلب المستخدم ذلك. بالنسبة إلى عمليات البحث المفتوحة حسب الكلمات الرئيسية أو المواضيع في التقويم الأساسي، يجب استخدام أداة search_events بدلاً من ذلك.
يوضّح المثال التالي كيفية استخدام curl لاستدعاء أداة list_events MCP.
| طلب Curl |
|---|
curl --location 'https://calendarmcp.googleapis.com/mcp' \ --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 }' |
مخطط الإدخال
ListEventsRequest
| تمثيل JSON |
|---|
{
"eventTypeFilter": [
string
],
"eventType": [
enum ( |
| الحقول | |
|---|---|
eventTypeFilter[] |
اختياريّ. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
eventType[] |
اختياريّ. أنواع الأحداث المطلوب عرضها. في حال كانت فارغة، يتم عرض أنواع الأحداث التالية فقط: |
حقل الربط يمكن أن يكون التعليق |
|
calendarId |
اختياريّ. رقم تعريف التقويم الذي يحتوي على الأحداث عنوان البريد الإلكتروني: يمكن حله باستخدام |
حقل الربط يمكن أن يكون التعليق |
|
pageSize |
اختياريّ. الحد الأقصى لعدد الأحداث في الصفحة (القيمة التلقائية |
حقل الربط يمكن أن يكون التعليق |
|
pageToken |
اختياريّ. الرمز المميز للصفحة التالية استخدِم القيمة من |
حقل الربط يمكن أن يكون التعليق |
|
startTime |
اختياريّ. الحدّ الأدنى لنطاق زمني. يجب ضبطها فقط عندما يطلب المستخدم إطارًا زمنيًا محدّدًا. يجب أن يكون الطابع الزمني بتنسيق ISO 8601 وأقل من |
حقل الربط يمكن أن يكون التعليق |
|
endTime |
اختياريّ. الحدّ الأعلى لنطاق زمني يجب ضبط هذا الخيار فقط عندما يطلب المستخدم إطارًا زمنيًا محدّدًا أو وقتًا في الماضي. يجب أن يكون الطابع الزمني بتنسيق ISO 8601 وأكبر من |
حقل الربط يمكن أن يكون التعليق |
|
timeZone |
اختياريّ. المنطقة الزمنية (معرّف IANA، مثل |
حقل الربط يمكن أن يكون التعليق |
|
orderBy |
اختياريّ. ترتيب عرض الأحداث القيم المحتملة هي:
|
حقل الربط يمكن أن يكون التعليق |
|
fullText |
اختياريّ. بحث حر غير حساس لحالة الأحرف يطابق العنوان أو الوصف أو الموقع الجغرافي أو الضيوف تطابق الأحداث التي تحتوي على جميع عبارات البحث حرفيًا (بحث AND). |
EventType
نوع الحدث. لا يمكن تغييره بعد الإنشاء.
| عمليات التعداد | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
يتم التعامل معها على أنّها DEFAULT. |
DEFAULT |
حدث منتظم القيمة التلقائية |
OUT_OF_OFFICE |
حدث بأنّك خارج المكتب |
FOCUS_TIME |
حدث "وقت التركيز" |
WORKING_LOCATION |
حدث عن مكان العمل |
BIRTHDAY |
حدث خاص يستمر ليوم كامل ويتكرر سنويًا. |
FROM_GMAIL |
حدث من Gmail لا يمكن إنشاء هذا النوع من الأحداث. |
مخطط النتائج
ListEventsResponse
| تمثيل JSON |
|---|
{ "summary": string, "description": string, "updated": string, "timeZone": string, "accessRole": string, "defaultReminders": [ { object ( |
| الحقول | |
|---|---|
summary |
عنوان التقويم |
description |
وصف التقويم |
updated |
تمثّل هذه السمة وقت آخر تعديل للتقويم (ISO 8601). |
timeZone |
المنطقة الزمنية للتقويم |
accessRole |
النتائج فقط. دور الوصول الخاص بالمستخدم في التقويم القيم المحتملة هي:
owner عن مالك بيانات التقويم. يتضمّن التقويم مالك بيانات واحدًا، ولكن يمكن أن يتضمّن عدة مستخدمين لديهم دور owner.
|
defaultReminders[] |
التذكيرات التلقائية للأحداث في التقويم |
events[] |
قائمة الأحداث |
حقل الربط يمكن أن يكون التعليق |
|
nextPageToken |
الرمز المميز للصفحة التالية يتم حذف هذا الحقل إذا لم تكن هناك صفحة تالية. |
تذكير
| تمثيل JSON |
|---|
{ "method": string "minutes": integer } |
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
method |
الحقل مطلوب. طريقة التسليم القيم المحتملة هي:
|
حقل الربط يمكن أن يكون التعليق |
|
minutes |
الحقل مطلوب. عدد الدقائق لعرض التذكير مُقدمًا |
الحدث
| تمثيل JSON |
|---|
{ "id": string, "status": string, "htmlLink": string, "created": string, "updated": string, "summary": string, "description": string, "location": string, "creator": { object ( |
| الحقول | |
|---|---|
id |
معرّف فريد |
status |
اختياريّ. الحالة. القيم المحتملة هي:
|
htmlLink |
النتائج فقط. رابط مطلق يؤدي إلى هذا الحدث في واجهة مستخدم الويب الخاصة بـ "تقويم Google" |
created |
النتائج فقط. وقت الإنشاء (ISO 8601) |
updated |
النتائج فقط. وقت آخر تعديل (ISO 8601) |
summary |
العنوان |
description |
اختياريّ. الوصف. يمكن أن يحتوي على HTML. |
location |
اختياريّ. الموقع الجغرافي. |
creator |
النتائج فقط. صانع المحتوى |
organizer |
النتائج فقط. المنظِّم يتم إدراجها أيضًا في قائمة الضيوف إذا كانت ستشارك في الحدث. |
start |
وقت البدء (شامل) بالنسبة إلى الأحداث المتكرّرة، يتم استخدام المثيل الأول. |
end |
وقت الانتهاء (حصري) بالنسبة إلى الأحداث المتكرّرة، يتم استخدام المثيل الأول. |
recurrence[] |
قواعد التكرار كسلاسل |
recurringEventId |
معرّف الحدث المتكرّر الرئيسي لنسخ الأحداث المتكرّرة |
originalStartTime |
وقت البدء الأصلي للمواعيد المتكرّرة هذا هو الوقت الذي ستبدأ فيه هذه الحالة وفقًا لبيانات التكرار. |
transparency |
اختياريّ. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
visibility |
اختياريّ. تمثّل هذه السمة مستوى رؤية الحدث. القيم المحتملة هي:
|
attendees[] |
المشاركون |
conferenceUrl |
رابط اجتماع الفيديو |
colorId |
تمثّل هذه السمة لون الحدث. لا يؤثّر ذلك إلا في طريقة عرض تقويمك. هذا معرّف يشير إلى إدخال في لوحة ألوان التقويم (السلسلة
|
overrideReminders[] |
التذكيرات. يتم الرجوع إلى الإعدادات التلقائية للتقويم في حال عدم ضبطها. |
attachments[] |
الملفات المرفقة |
guestPermissions |
أذونات المدعوين |
eventType |
نوع الحدث. |
workingLocationProperties |
خصائص مكان العمل لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة |
availability |
اختياريّ. إعدادات مدى التوفّر |
أساسي
| تمثيل JSON |
|---|
{ "email": string, "displayName": string, "self": boolean } |
| الحقول | |
|---|---|
email |
البريد الإلكتروني. |
displayName |
الاسم |
self |
النتائج فقط. تُستخدَم لتحديد ما إذا كان هذا العنصر الأساسي يتوافق مع التقويم الذي تظهر فيه هذه النسخة من الحدث. القيمة التلقائية: |
DateOrDateTime
| تمثيل JSON |
|---|
{ "date": string, "dateTime": string, "timeZone": string } |
| الحقول | |
|---|---|
date |
تاريخ ISO 8601 في منتصف الليل بالتوقيت العالمي المنسّق (على سبيل المثال، |
dateTime |
طابع زمني بتنسيق ISO 8601 (مثلاً، |
timeZone |
اسم المنطقة الزمنية في قاعدة بيانات المناطق الزمنية (TZDB) |
المشارك
| تمثيل JSON |
|---|
{ "id": string "email": string "displayName": string "organizer": boolean "self": boolean "resource": boolean "optionalAttendee": boolean "responseStatus": string "comment": string "additionalGuests": integer } |
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
id |
النتائج فقط. معرّف الملف التجاري |
حقل الربط يمكن أن يكون التعليق |
|
email |
الحقل مطلوب. عنوان البريد الإلكتروني للمدعو |
حقل الربط يمكن أن يكون التعليق |
|
displayName |
اختياريّ. الاسم |
حقل الربط يمكن أن يكون التعليق |
|
organizer |
النتائج فقط. تُستخدَم لتحديد ما إذا كان الضيف هو المنظّم. القيمة التلقائية: |
حقل الربط يمكن أن يكون التعليق |
|
self |
النتائج فقط. تُستخدَم لتحديد ما إذا كان هذا الإدخال يمثّل التقويم الذي تظهر فيه هذه النسخة من الحدث. القيمة التلقائية: |
حقل الربط يمكن أن يكون التعليق |
|
resource |
اختياريّ. تُستخدَم لتحديد ما إذا كان الضيف عبارة عن مورد (مثل غرفة). غير قابل للتغيير، ويمكن ضبطه فقط عند إضافة الضيف في البداية. القيمة التلقائية: |
حقل الربط يمكن أن يكون التعليق |
|
optionalAttendee |
اختياريّ. توضّح هذه السمة ما إذا كان الضيف اختياريًا. القيمة التلقائية: |
حقل الربط يمكن أن يكون التعليق |
|
responseStatus |
اختياريّ. حالة الردّ القيم المحتملة هي:
|
حقل الربط يمكن أن يكون التعليق |
|
comment |
النتائج فقط. تعليق الردّ |
حقل الربط يمكن أن يكون التعليق |
|
additionalGuests |
اختياريّ. عدد الضيوف الإضافيين القيمة التلقائية: |
مرفق
| تمثيل JSON |
|---|
{ "fileUrl": string "title": string } |
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
fileUrl |
الحقل مطلوب. رابط URL للمرفق |
حقل الربط يمكن أن يكون التعليق |
|
title |
اختياريّ. عنوان المرفق |
GuestPermissions
| تمثيل JSON |
|---|
{ "guestsCanInviteOthers": boolean "guestsCanModify": boolean "guestsCanSeeGuests": boolean } |
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
guestsCanInviteOthers |
اختياريّ. تُستخدَم لتحديد ما إذا كان بإمكان المدعوّين دعوة آخرين. |
حقل الربط يمكن أن يكون التعليق |
|
guestsCanModify |
اختياريّ. تُستخدَم لتحديد ما إذا كان بإمكان المدعوّين تعديل الحدث. |
حقل الربط يمكن أن يكون التعليق |
|
guestsCanSeeGuests |
اختياريّ. ما إذا كان بإمكان المدعوين الاطّلاع على المدعوين الآخرين |
WorkingLocationProperties
| تمثيل JSON |
|---|
{
"type": enum ( |
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
type |
اختياريّ. تمثّل هذه السمة نوع مكان العمل. |
حقل الربط يمكن أن يكون التعليق |
|
customLocationLabel |
اختياريّ. تمثّل هذه السمة تصنيفًا لموقع جغرافي مخصّص. هذه السمة مطلوبة إذا كان النوع |
EventType
نوع الحدث. لا يمكن تغييره بعد الإنشاء.
| عمليات التعداد | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
يتم التعامل معها على أنّها DEFAULT. |
DEFAULT |
حدث منتظم القيمة التلقائية |
OUT_OF_OFFICE |
حدث بأنّك خارج المكتب |
FOCUS_TIME |
حدث "وقت التركيز" |
WORKING_LOCATION |
حدث عن مكان العمل |
BIRTHDAY |
حدث خاص يستمر ليوم كامل ويتكرر سنويًا. |
FROM_GMAIL |
حدث من Gmail لا يمكن إنشاء هذا النوع من الأحداث. |
WorkingLocationType
تمثّل هذه السمة نوع مكان العمل.
| عمليات التعداد | |
|---|---|
WORKING_LOCATION_TYPE_UNSPECIFIED |
نوع موقع العمل غير محدَّد. سيتم التعامل معها على أنّها HOME_OFFICE. |
HOME_OFFICE |
المكتب المنزلي |
CUSTOM_LOCATION |
موقع جغرافي مخصّص |
مدى التوفّر
إعدادات مدى التوفّر لحدث معيّن
| عمليات التعداد | |
|---|---|
AVAILABILITY_UNSPECIFIED |
تلقائي: يتم التعامل معها على أنّها BUSY. |
AVAILABILITY_BUSY |
يحظر الوقت في التقويم. |
AVAILABILITY_FREE |
لا يحظر الوقت. |
تعليقات توضيحية للأدوات
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌