CalendarList: list

تعرض هذه الطريقة التقاويم في قائمة تقاويم المستخدم. جرِّبها الآن.

طلب

طلب HTTP

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

المعلمات

اسم المعلَمة القيمة الوصف
معامِلات طلب البحث الاختيارية
maxResults integer الحد الأقصى لعدد الإدخالات التي يتم عرضها في صفحة نتائج واحدة القيمة التلقائية هي 100 إدخال. لا يمكن أن يكون حجم الصفحة أكبر من 250 إدخالاً. اختياريّ.
minAccessRole string الحد الأدنى لدور الوصول الممنوح للمستخدم في الإدخالات المعروضة اختياريّ. القيمة التلقائية هي عدم فرض أي قيود.

القيم المقبولة هي:
  • "freeBusyReader": يمكن للمستخدم قراءة معلومات التوفّر/الانشغال.
  • "owner": يمكن للمستخدم قراءة الأحداث وقوائم التحكّم بالوصول وتعديلها.
  • "reader": يمكن للمستخدم قراءة الأحداث غير الخاصة.
  • "writer": يمكن للمستخدم قراءة الأحداث وتعديلها.
  • "writerWithoutPrivateAccess": يمكن للمستخدم قراءة الأحداث وتعديلها، ولكن لا يمكنه الوصول إلى الأحداث الخاصة.
pageToken string رمز يحدّد صفحة النتائج المطلوب عرضها اختياريّ.
showDeleted boolean تحديد ما إذا كان سيتم تضمين إدخالات قائمة التقويم المحذوفة في النتيجة اختياريّ. القيمة التلقائية هي "خطأ".
showHidden boolean تحديد ما إذا كان سيتم عرض الإدخالات المخفية اختياريّ. القيمة التلقائية هي "خطأ".
showOwnOrganizationOnly boolean تحديد ما إذا كان سيتم عرض التقاويم التابعة للمؤسسة فقط لا تنطبق هذه المَعلمة إلا على مستخدمي Google Workspace. اختياريّ. القيمة التلقائية هي "خطأ".
syncToken string رمز تم الحصول عليه من الحقل nextSyncToken الذي تم عرضه في آخر صفحة من نتائج طلب القائمة السابق يؤدي هذا الرمز إلى احتواء نتيجة طلب القائمة هذا على الإدخالات التي تم تغييرها منذ ذلك الحين فقط. إذا تم تغيير حقول للقراءة فقط، مثل خصائص التقويم أو قوائم التحكّم بالوصول، لن يتم عرض الإدخال. ستظهر دائمًا في مجموعة النتائج جميع الإدخالات المحذوفة والمخفية منذ طلب القائمة السابق، ولا يُسمح بضبط showDeleted أو showHidden على "خطأ".
لضمان اتساق حالة العميل، لا يمكن تحديد معامِلات طلب البحث minAccessRole وshowOwnOrganizationOnly معًا مع nextSyncToken.
إذا انتهت صلاحية syncToken، سيعرض الخادم رمز استجابة 410 GONE، وعلى العميل محو مساحة التخزين وإجراء مزامنة كاملة بدون أي syncToken.
مزيد من المعلومات عن المزامنة الجزئية
اختياريّ. القيمة التلقائية هي عرض جميع الإدخالات.

التفويض

يتطلب هذا الطلب تفويضًا باستخدام نطاق واحد على الأقل من النطاقات التالية:

النطاق
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

لمزيد من المعلومات، يُرجى الاطّلاع على صفحة المصادقة والتفويض.

نص الطلب

لا تُدرِج نص طلب مع هذه الطريقة.

الردّ

إذا كانت الاستجابة ناجحة، تعرض هذه الطريقة نص استجابة بالبنية التالية:

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
اسم السمة القيمة الوصف ملاحظات
kind string نوع المجموعة ("calendar#calendarList")
etag etag علامة ETag للمجموعة
nextPageToken string رمز يُستخدَم للوصول إلى الصفحة التالية من هذه النتيجة يتم حذفه إذا لم تتوفّر نتائج أخرى، وفي هذه الحالة يتم توفير nextSyncToken.
items[] list التقاويم المتوفّرة في قائمة تقاويم المستخدم
nextSyncToken string رمز يُستخدَم في وقت لاحق لاسترداد الإدخالات التي تم تغييرها منذ عرض هذه النتيجة فقط يتم حذفه إذا كانت هناك نتائج أخرى، وفي هذه الحالة يتم توفير nextPageToken.

جرِّبها الآن.

استخدِم أداة "مستكشف واجهات برمجة التطبيقات" أدناه لطلب هذه الطريقة من البيانات المباشرة والاطّلاع على الردّ.