Method: advertisers.creatives.list

تعرض هذه الطريقة تصاميم الإعلانات لدى معلِن معيّن.

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

طلب HTTP

GET https://displayvideo.googleapis.com/v5/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"
  • جميع تصاميم الإعلانات النشطة التي تبلغ أبعادها 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 Overview.