ويتم تحديد الترتيب من خلال المَعلمة orderBy. إذا لم يتم تحديد filter بحلول entityStatus، لن يتم تضمين الحملات التي تحتوي على ENTITY_STATUS_ARCHIVED في النتائج.
طلب HTTP
GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/campaigns
حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و200. وفي حال عدم تحديد ذلك، سيتم ضبط القيمة التلقائية على 100.
pageToken
string
يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الاستدعاء السابق إلى طريقة campaigns.list. إذا لم يتم تحديد ذلك، سيتم عرض الصفحة الأولى من النتائج.
orderBy
string
الحقل الذي سيتم ترتيب القائمة بناءً عليه. القيم المقبولة هي:
displayName (تلقائي)
entityStatus
updateTime
يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثال: displayName desc
filter
string
تسمح بالفلترة حسب حقول الحملة.
البنية المتوافقة:
تتألف تعبيرات الفلترة من قيد واحد أو أكثر.
يمكن دمج القيود من خلال عاملَي التشغيل المنطقي AND أو OR. تستخدم سلسلة من القيود السمة AND ضمنيًا.
ويكون للقيود الشكل {field} {operator} {value}.
يجب أن يستخدم الحقل updateTime عاملَي التشغيل GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=).
ويجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).
الحقول المتاحة:
campaignId
displayName
entityStatus
updateTime (إدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)
أمثلة:
جميع حملات ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSED التابعة لأحد المعلنين: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED")
جميع الحملات التي لها وقت تحديث أقل من أو يساوي 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 في الاستدعاء التالي إلى طريقة campaigns.list لاسترداد الصفحة التالية من النتائج.