Method: advertisers.locationLists.list

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

طلب HTTP

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

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

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

المَعلمات
advertiserId

string (int64 format)

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

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

المَعلمات
pageSize

integer

حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و100. ويتم ضبط القيمة تلقائيًا على 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"

نص الطلب

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

نص الاستجابة

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

تمثيل 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.