Method: advertisers.creatives.list

يسرد تصميمات الإعلانات في أحد المعلنين.

يتم تحديد الترتيب من خلال المَعلمة orderBy. إذا لم يتم تحديد filter x entityStatus، لن يتم تضمين تصميمات الإعلانات التي تحتوي على ENTITY_STATUS_ARCHIVED في النتائج.

طلب HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/creatives

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

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

المعلمات
advertiserId

string (int64 format)

مطلوب. الرقم التعريفي للمعلِن المطلوب إدراج تصميمات إعلانات له

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

المعلمات
pageSize

integer

حجم الصفحة المطلوب يجب أن تتراوح بين 1 و200. إذا لم يتم تحديد قيمة، سيتم ضبطها تلقائيًا على 100. تُعرِض رمز الخطأ INVALID_ARGUMENT في حال تحديد قيمة غير صالحة.

pageToken

string

رمز مميّز لصفحة من النتائج التي يجب أن يعرضها الخادم وعادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الطلب السابق لاستخدام طريقة creatives.list. إذا لم يتم تحديدها، سيتم عرض الصفحة الأولى من النتائج.

orderBy

string

الحقل الذي يتم ترتيب القائمة حسبه القيم المقبولة هي:

  • creativeId (تلقائي)
  • createTime
  • mediaDuration
  • dimensions (يتم الترتيب حسب العرض أولاً، ثم حسب الارتفاع)

يكون ترتيب الفرز التلقائي تصاعديًا. لتحديد ترتيب تنازلي للحقل، يجب إضافة لاحقة "desc" إلى اسم الحقل. مثال: createTime desc

filter

string

السماح بالفلترة حسب حقول تصميم الإعلان

بنية متوافقة:

  • تتألّف عبارات الفلاتر من قيد واحد أو أكثر.
  • يمكن دمج القيود باستخدام عوامل التشغيل المنطقية AND أو OR. سلسلة من القيود تستخدم ضمنيًا AND.
  • يكون التنسيق الخاص بالحظر على النحو التالي: {field} {operator} {value}.
  • يجب أن يستخدم الحقل lineItemIds عامل التشغيل HAS (:).
  • يجب أن يستخدم الحقل updateTime عاملَي التشغيل GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=).
  • يجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).
  • بالنسبة إلى الحقول entityStatus وminDuration وmaxDuration وupdateTime وdynamic، يمكن أن يكون هناك قيد واحد بحد أقصى.

الحقول المتوافقة:

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions (إدخال بصيغة {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (الإدخال في شكل {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (يجب إدخال القيمة على شكل {duration}s. يمكن استخدام الثواني فقط)
  • minDuration (يجب إدخال القيمة على شكل {duration}s. يمكن استخدام الثواني فقط)
  • updateTime (إدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)

ملاحظات:

  • بالنسبة إلى updateTime، تعكس قيمة حقل مورد تصميم الإعلان آخر مرة تم فيها تعديل تصميم الإعلان، بما في ذلك التعديلات التي أجراها النظام (مثل التعديلات على مراجعة تصميم الإعلان).

أمثلة:

  • جميع تصميمات الإعلانات المدمجة مع المحتوى: creativeType="CREATIVE_TYPE_NATIVE"
  • جميع تصميمات الإعلانات النشطة بالأبعاد 300x400 أو 50x100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • كل تصاميم الإعلانات الديناميكية التي تمت الموافقة عليها من قِبل AdX أو AppNexus، بحيث تكون مدتها 5 ثوانٍ و200 ملي ثانية على الأقل: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • جميع تصميمات إعلانات الفيديو المرتبطة بمعرّف العنصر 1 أو 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • العثور على تصميمات الإعلانات باستخدام معرّفات متعددة لتصاميم الإعلانات: creativeId=1 OR creativeId=2
  • جميع تصميمات الإعلانات التي يكون وقت تعديلها أكبر من أو يساوي ‎2020-11-04T18:54:47Z (بتنسيق ISO 8601): updateTime>="2020-11-04T18:54:47Z"

يجب ألا يزيد طول هذا الحقل عن 500 حرف.

يمكنك الرجوع إلى دليل طلبات فلترة LIST للحصول على مزيد من المعلومات.

نص الطلب

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

نص الاستجابة

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

تمثيل JSON
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
الحقول
creatives[]

object (Creative)

قائمة تصميمات الإعلانات.

لن تظهر هذه القائمة إذا كانت فارغة.

nextPageToken

string

رمز مميّز لاسترداد الصفحة التالية من النتائج نقْل هذه القيمة في حقل pageToken في الطلب اللاحق لطريقة ListCreativesRequest لاسترداد الصفحة التالية من النتائج. إذا كان هذا الحقل خاليًا، فهذا يعني أن هذه هي الصفحة الأخيرة.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/display-video

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على بروتوكول OAuth 2.0.