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 تحديد ما إذا كان سيتم تضمين إدخالات قائمة التقويم المحذوفة في النتيجة. اختياريّ. القيمة التلقائية هي False.
showHidden boolean تحديد ما إذا كان سيتم عرض الإدخالات المخفية أم لا اختياريّ. القيمة التلقائية هي False.
showOwnOrganizationOnly boolean تحديد ما إذا كان سيتم عرض إدخالات التقاويم من المؤسسة فقط لا تنطبق هذه المَعلمة إلا على مستخدمي Google Workspace. اختياريّ. القيمة التلقائية هي False.
syncToken string الرمز المميز الذي تم الحصول عليه من الحقل nextSyncToken الذي تم عرضه في آخر صفحة من النتائج من طلب القائمة السابق ويجعل نتيجة طلب القائمة هذا تحتوي فقط على الإدخالات التي تم تغييرها منذ ذلك الحين. إذا تم تغيير حقول للقراءة فقط، مثل خصائص التقويم أو قوائم التحكم بالوصول (ACL)، لن يتم عرض الإدخال. ستكون جميع الإدخالات المحذوفة والمخفية منذ طلب القائمة السابق دائمًا في مجموعة النتائج، ولا يُسمح بضبط 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.

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

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