Method: advertisers.locationLists.list

تعرض قوائم المواقع الجغرافية استنادًا إلى معرّف معلِن معيّن.

طلب HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/locationLists

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

مَعلمات المسار

المعلمات
advertiserId

string (int64 format)

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

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

المعلمات
pageSize

integer

حجم الصفحة المطلوب. يجب أن تتراوح بين 1 و200. يتم ضبط القيمة تلقائيًا على 100 في حال عدم ضبطها. تعرض رمز الخطأ INVALID_ARGUMENT إذا تم تحديد قيمة غير صالحة.
pageToken

string

رمز مميّز لصفحة من النتائج التي يجب أن يعرضها الخادم

وعادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الطلب السابق لاستخدام طريقة locationLists.list. إذا لم يتم تحديدها، سيتم عرض الصفحة الأولى من النتائج.
orderBy

string

الحقل الذي يتم ترتيب القائمة حسبه القيم المقبولة هي:

  • locationListId (تلقائي)
  • displayName

يكون ترتيب الفرز التلقائي تصاعديًا. لتحديد الترتيب التنازلي لحقل معيّن، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثال: displayName desc
filter

string

يسمح بالفلترة حسب حقول قائمة المواقع الجغرافية.

بنية الجملة المتوافقة:

  • تتألّف عبارات الفلاتر من قيد واحد أو أكثر.
  • يمكن دمج القيود باستخدام عوامل التشغيل المنطقية AND أو OR. تُستخدَم AND ضمنيًا في تسلسل القيود.
  • يكون التنسيق الخاص بالحظر على النحو التالي: {field} {operator} {value}.
  • يجب أن تستخدم جميع الحقول عامل التشغيل EQUALS (=).

الحقول المتوافقة:

  • locationType

أمثلة:

  • قائمة جميع المواقع الجغرافية الإقليمية: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • قائمة المواقع الجغرافية القريبة: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

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

نص الطلب

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

نص الاستجابة

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

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

object (LocationList)

قائمة قوائم المواقع الجغرافية.

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

string

رمز مميز لاسترداد الصفحة التالية من النتائج.

نقْل هذه القيمة في حقل pageToken في الطلب اللاحق لطريقة locationLists.list لاسترداد الصفحة التالية من النتائج.

نطاقات التفويض

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

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

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