Method: customLists.list

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

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

طلب HTTP

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