Method: customLists.list

يسرد القوائم المخصَّصة.

ويتم تحديد الترتيب من خلال المَعلمة orderBy.

طلب HTTP

GET https://displayvideo.googleapis.com/v1/customLists

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

معلمات طلب البحث

المَعلمات
pageSize

integer

حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 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".

يجب ألا يزيد طول هذا الحقل عن 500 حرف.

يمكنك الرجوع إلى دليل طلبات LIST للفلترة للحصول على مزيد من المعلومات.
advertiserId

string (int64 format)

رقم تعريف المعلِن على "مساحة العرض والفيديو 360" الذي يمكنه الوصول إلى القوائم المخصّصة التي تم جلبها.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
الحقول
customLists[]

object (CustomList)

قائمة القوائم المخصَّصة.

لن يتم ملء هذه القائمة إذا كانت فارغة.
nextPageToken

string

رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة customLists.list لاسترداد الصفحة التالية من النتائج.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/display-video

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.