حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و200. وفي حال عدم تحديد ذلك، سيتم ضبط القيمة التلقائية على 100. تعرض رمز الخطأ INVALID_ARGUMENT إذا تم تحديد قيمة غير صالحة.
pageToken
string
يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الاستدعاء السابق إلى طريقة customLists.list. إذا لم يتم تحديد ذلك، سيتم عرض الصفحة الأولى من النتائج.
orderBy
string
الحقل الذي سيتم ترتيب القائمة بناءً عليه. القيم المقبولة هي:
customListId (تلقائي)
displayName
يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثال: displayName desc
filter
string
تسمح هذه السياسة بالفلترة حسب حقول القائمة المخصّصة.
البنية المتوافقة:
لا يمكن أن تحتوي تعبيرات الفلاتر للقوائم المخصّصة إلّا على قيد واحد على الأكثر.
ويكون للقيود الشكل {field} {operator} {value}.
يجب أن تستخدم جميع الحقول عامل التشغيل HAS (:).
الحقول المتاحة:
displayName
أمثلة:
جميع القوائم المخصّصة التي يحتوي الاسم المعروض لها على "Google": displayName:"Google".
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة customLists.list لاسترداد الصفحة التالية من النتائج.