Method: advertisers.creatives.list

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

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

طلب HTTP

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

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

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

المعلمات
advertiserId

string (int64 format)

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

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

المعلمات
pageSize

integer

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

string

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

string

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

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

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

string

تسمح بالفلترة حسب خصائص تصميمات الإعلانات.

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

  • تتكون تعبيرات الفلاتر من قيد واحد أو أكثر.
  • يجب دمج القيود على الحقل نفسه من خلال السمة OR.
  • يجب دمج القيود المفروضة على الحقول المختلفة من خلال AND.
  • بين ( و)، قد تكون هناك قيود مجمَّعة من خلال OR للحقل نفسه فقط.
  • يكون للقيد {field} {operator} {value}.
  • يجب أن يكون عامل التشغيل EQUALS (=) في الحقول التالية:
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • يجب أن يكون عامل التشغيل HAS (:) في الحقول التالية:
    • lineItemIds
  • يجب أن يكون عامل التشغيل GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=) في الحقول التالية:
    • updateTime (إدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)
  • بالنسبة إلى entityStatus وminDuration وmaxDuration وupdateTime وdynamic، قد يكون هناك قيد واحد على الأكثر.
  • بالنسبة إلى dimensions، تكون القيمة في شكل "{width}x{height}".
  • بالنسبة إلى exchangeReviewStatus، تكون القيمة في شكل {exchange}-{reviewStatus}.
  • بالنسبة إلى minDuration وmaxDuration، تكون القيمة على شكل "{duration}s". تتم إتاحة الثواني فقط بدقة بالمللي ثانية.
  • بالنسبة إلى updateTime، تعكس قيمة حقل مورد تصميم الإعلان آخر مرة تمّ فيها تعديل تصميم إعلان، والذي يتضمّن التعديلات التي أجراها النظام (مثل تعديلات مراجعة تصميمات الإعلانات).
  • قد يكون هناك العديد من قيود lineItemIds للبحث في مقابل العديد من معرّفات العناصر المحتملة.
  • قد يكون هناك العديد من قيود creativeId للبحث في مقابل أرقام تعريف متعددة محتملة لتصميمات الإعلانات.

أمثلة:

  • جميع تصميمات الإعلانات المدمجة مع المحتوى: 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 (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" يجب ألا يزيد طول هذا الحقل عن 500 حرف.

نص الطلب

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

نص الاستجابة

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

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

object (Creative)

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

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

string

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

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

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

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

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