Method: customLists.list

تعرض هذه الطريقة قوائم العملاء.

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

طلب HTTP

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