Settings: list

تعرض هذه الطريقة جميع إعدادات المستخدم الذي تمت مصادقته. جرّب الميزة الآن.

طلب

طلب HTTP

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

المعلمات

اسم المعلَمة القيمة الوصف
مَعلمات طلب البحث الاختيارية
maxResults integer الحد الأقصى لعدد الإدخالات التي يتم عرضها في صفحة نتائج واحدة القيمة التلقائية هي 100 إدخال. لا يمكن أن يتجاوز حجم الصفحة 250 إدخالاً. اختيارية:
pageToken string رمز مميّز يحدّد صفحة النتائج المطلوب عرضها اختيارية:
syncToken string الرمز المميّز الذي تم الحصول عليه من حقل nextSyncToken الذي تم عرضه في الصفحة الأخيرة من النتائج من طلب القائمة السابق. ويؤدي ذلك إلى أن تحتوي نتيجة طلب القائمة هذا على الإدخالات التي تم تغييرها منذ ذلك الحين فقط.
إذا انتهت صلاحية syncToken، سيستجيب الخادم برمز الاستجابة 410 GONE، وعلى العميل محو مساحة التخزين وإجراء مزامنة كاملة بدون أي syncToken.
مزيد من المعلومات عن المزامنة المتزايدة
اختياري: الإعداد التلقائي هو عرض جميع الإدخالات.

التفويض

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

النطاق
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly
https://www.googleapis.com/auth/calendar.settings

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

نص الطلب

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

الردّ

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

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

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

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