يسرد القوائم المخصَّصة.
ويتم تحديد الترتيب من خلال المَعلمة orderBy
.
طلب HTTP
GET https://displayvideo.googleapis.com/v2/customLists
يستخدم عنوان URL بنية تحويل الترميز gRPC.
معلمات طلب البحث
المَعلمات | |
---|---|
pageSize |
حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين |
pageToken |
يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة |
orderBy |
الحقل الذي سيتم ترتيب القائمة وفقًا له. القيم المقبولة هي:
يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "تنازلي" إلى اسم الحقل. مثال: |
filter |
تسمح بالفلترة حسب حقول القائمة المخصّصة. البنية المتوافقة:
الحقول المتاحة:
أمثلة:
يجب ألا يزيد طول هذا الحقل عن 500 حرف. يمكنك الرجوع إلى دليل طلبات الفلاتر |
معلمة الاتحاد accessor . مطلوبة. يحدّد كيان "مساحة العرض والفيديو 360" الذي يتم تقديم الطلب من خلاله. لن يعرض طلب LIST إلا كيانات القائمة المخصّصة التي يمكن لكيان "مساحة العرض والفيديو 360" المحدّد ضمن accessor الوصول إليها. يمكن أن يكون الحقل "accessor " واحدًا فقط مما يلي: |
|
advertiserId |
رقم تعريف المعلِن على "مساحة العرض والفيديو 360" الذي يمكنه الوصول إلى القوائم المخصّصة التي تم جلبها |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"customLists": [
{
object ( |
الحقول | |
---|---|
customLists[] |
قائمة القوائم المخصَّصة. لن يتم إدخال هذه القائمة إذا كانت فارغة. |
nextPageToken |
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل |
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/display-video
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.