يتم تحديد الترتيب من خلال المعلَمة orderBy. وإذا لم يتم تحديد filter في entityStatus، لن يتم تضمين الحملات التي تحتوي على ENTITY_STATUS_ARCHIVED في النتائج.
طلب HTTP
GET https://displayvideo.googleapis.com/v2/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 لاسترداد الصفحة التالية من النتائج.