Method: advertisers.locationLists.list

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

طلب HTTP

GET https://displayvideo.googleapis.com/v5/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 Overview.