Method: advertisers.creatives.list

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

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

طلب HTTP

GET https://displayvideo.googleapis.com/v2/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 (الترتيب حسب العرض أولاً، ثم حسب الارتفاع)

يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "تنازلي" إلى اسم الحقل. مثال: 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"
  • جميع تصميمات الإعلانات النشطة ذات أبعاد 300×400 أو 50×100: 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.