مطلوبة. رقم تعريف الشريك الذي يجب أن ينتمي إليه جميع المعلنين الذين تم جلبهم. يتيح النظام عرض بيانات المعلنِين لشريك واحد فقط في كلّ مرة.
pageSize
integer
حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و200. وفي حال عدم تحديد نوع السياسة، سيتم ضبط القيمة التلقائية على 100.
pageToken
string
يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة nextPageToken التي تم عرضها من الاستدعاء السابق إلى طريقة advertisers.list. في حال عدم تحديد أي خيار، سيتم عرض الصفحة الأولى من النتائج.
orderBy
string
الحقل الذي سيتم ترتيب القائمة وفقًا له. القيم المقبولة هي:
displayName (تلقائي)
entityStatus
updateTime
يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "تنازلي" إلى اسم الحقل. مثلاً: displayName desc
filter
string
تسمح بالفلترة حسب حقول المعلِن.
البنية المتوافقة:
وتتكون تعبيرات الفلاتر من قيد واحد أو أكثر.
يمكن دمج القيود باستخدام عاملَي التشغيل المنطقي AND أو OR.
يكون نوع القيود كالآتي {field} {operator} {value}.
يجب أن يستخدم الحقل updateTime عاملَي التشغيل GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=).
يجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).
الحقول المتاحة:
advertiserId
displayName
entityStatus
updateTime (إدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)
أمثلة:
جميع المعلنين النشطين ضمن شريك: entityStatus="ENTITY_STATUS_ACTIVE"
جميع المعلِنين الذين لديهم وقت تعديل أقل من أو يساوي 2020-11-04T18:54:47Z (بتنسيق ISO 8601): updateTime<="2020-11-04T18:54:47Z"
جميع المعلِنين الذين لديهم وقت تعديل أكبر من أو يساوي 2020-11-04T18:54:47Z (بتنسيق ISO 8601): updateTime>="2020-11-04T18:54:47Z"
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة advertisers.list لاسترداد الصفحة التالية من النتائج.