Method: customLists.list

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

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

طلب HTTP

GET https://displayvideo.googleapis.com/v3/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 للحصول على مزيد من المعلومات.
مَعلمة الائتلاف accessor. مطلوب. لتحديد كيان "مساحة العرض والفيديو 360" الذي يتم تقديم الطلب من خلاله. لن يعرض طلب LIST سوى عناصر القوائم المخصّصة التي يمكن الوصول إليها من خلال عنصر "مساحة العرض والفيديو 360" المحدّد في accessor. يمكن أن يكون accessor واحدًا فقط مما يلي:
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.