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.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-07 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-11-07 (حسب التوقيت العالمي المتفَّق عليه)"],[[["Lists creatives, ordered by `creativeId`, `createTime`, `mediaDuration`, or `dimensions`, for a given advertiser."],["Filter creatives by `approvalStatus`, `creativeId`, `creativeType`, `dimensions`, `dynamic`, `entityStatus`, `exchangeReviewStatus`, `lineItemIds`, `maxDuration`, `minDuration`, or `updateTime`."],["Archived creatives are excluded unless explicitly filtered for."],["Results are paginated, with control over page size and retrieval of subsequent pages using tokens."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."]]],[]]