Method: advertisers.locationLists.list

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

طلب HTTP

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