الفئة: إعلان

الطُرق

المعرّف الإعلاني

دالة getAdId() تعرض سلسلة

يُستخدم رقم تعريف الإعلان لمزامنة الإعلانات الرئيسية والإعلانات المصاحبة.

المرتجعات

string رقم تعريف الإعلان، أو السلسلة الفارغة في حال عدم توفّر هذه المعلومات

الحصول على معلومات AdPod

تعرض getAdPodInfo() AdPodInfo

تعرض معلومات مجموعة الإعلانات المتسلسلة.

المرتجعات

non-null AdPodInfo معلومات مجموعة الإعلانات المتسلسلة.

الحصول على النظام

تعرض سلسلة AdAd() سلسلة.

معلومات خادم الإعلان المصدر المضمّنة في استجابة الإعلان.

المرتجعات

string خادم الإعلانات المصدر للإعلان، أو السلسلة الفارغة في حال عدم توفُّر هذه المعلومات.

الحصول على اسم المعلن

get_Name() على سلسلة

اسم المعلِن كما هو محدّد من جانب جهة العرض.

المرتجعات

string اسم المعلِن أو السلسلة الفارغة في حال عدم توفّر هذه المعلومات.

GetApiframework

تعرض getApiframework() سلسلة

تحديد واجهة برمجة التطبيقات اللازمة لتنفيذ الإعلان. ويتوافق ذلك مع واجهة برمجة التطبيقات apiframework المحدّدة بشكل كبير.

المرتجعات

nullable string يحتاج إطار عمل واجهة برمجة التطبيقات إلى تنفيذ الإعلان أو يكون فارغًا في حال عدم توفّر هذه المعلومات.

GetCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, settings) يعرض مصفوفة من الإعلانات المصاحبة غير الفارغة

يحصل على الإعلانات المصاحبة لهذا الإعلان استنادًا إلى حجم الشريحة الإعلانية المصاحبة. يتم تطبيق الإعدادات المتقدّمة للاختيار بشكل اختياري. يُرجى العِلم أنّ هذه الطريقة لن تعرض سوى صفيف غير فارغ لمثيلات الإعلانات التي تم الحصول عليها في حدث بدء أو بعده. على وجه التحديد، ستعرض الإعلانات من الفعالية التي تم تحميلها صفيفًا فارغًا.

المَعلمة

عرض الشرائح

عدد

عرض الخانة الإعلانية المصاحبة.

ارتفاع adSlot

عدد

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

الإعدادات

عنصر اختياري

إعدادات CompanionAdSelection

إعدادات الاختيار للإعلانات المصاحبة.

يجب ألا تكون القيمة فارغة.

المرتجعات

non-null Array of non-null CompanionAd مصفوفة من الإعلانات المصاحبة التي تتطابق مع الإعدادات وحجم الخانة.

GetContentType

دالة getContentType() تعرض سلسلة

يعرض نوع المحتوى في تصميم الإعلان المحدد حاليًا أو سلسلة فارغة إذا لم يتم اختيار أي تصميم إعلان أو لم يكن نوع المحتوى متاحًا. بالنسبة إلى الإعلانات الخطية، لن يكون نوع المحتوى متاحًا إلا بعد فعالية Start (اختيار) عند اختيار ملف الوسائط.

المرتجعات

string نوع المحتوى، سلسلة فارغة إذا لم تكن متوفرة.

الحصول على رقم تعريف تصميم الإعلان

في حال اختيار المعرّف الإعلاني get AdAd()

تعرض رمز ISCI (المعرّف التجاري العادي للقطاع) لأحد الإعلانات أو سلسلة فارغة في حال عدم توفّر الرمز. هذا هو رقم تعريف الإعلان لتصميم الإعلان في استجابة نموذج عرض إعلانات الفيديو (VAST).

المرتجعات

string 

الحصول على رقم تعريف تصميم الإعلان

في حال الحصول على سلسلة بيانات على المعرّف_الإبداعي()

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

المرتجعات

string رقم تعريف تصميم الإعلان المحدّد للإعلان، أو السلسلة الفارغة إذا كانت هذه المعلومات غير متاحة.

GetDealId

دالة getDealId() تعرض سلسلة

عرض رقم تعريف الصفقة الأول المتاح في سلسلة برامج التضمين للإعلان الحالي، بدءًا من أعلى الصفحة عرض السلسلة الفارغة إذا لم تكن متاحة.

المرتجعات

string 

الحصول على الوصف

دالة getDescription() تعرض سلسلة

لعرض وصف هذا الإعلان من استجابة نموذج عرض إعلانات الفيديو (VAST).

المرتجعات

string الوصف فارغ في حال عدم تحديده.

GetDuration

تعرض getDuration() رقم

لعرض مدة تصميم الإعلان الذي تم اختياره، أو -1 لتصميمات الإعلانات غير الخطية.

المرتجعات

number مدة المواد الإبداعية التي تم اختيارها بالثواني، إذا كانت غير خطيّة، -1

GetHeight

تعرض الدالة getHeight() رقم

لعرض ارتفاع تصميم الإعلان غير الخطي.

المرتجعات

number ارتفاع تصميم الإعلان غير الخطي أو 0 لتصميم إعلان خطي.

GetMediaUrl

دالة getMediaUrl() تعرض سلسلة

يعرض عنوان URL لملف الوسائط الذي تم اختياره من الإعلان بناءً على إعدادات اختيار الوسائط المستخدمة حاليًا. لعرض قيمة فارغة إذا كانت هذه المعلومات غير متاحة. متوفّر في حدث Start (ابدأ).

المرتجعات

nullable string 

GetMin اقتراحDuration

تعرض getMinsuggestDuration() رقم

يتم عرض الحدّ الأدنى المقترَح بالثواني إلى أنه يجب عرض تصميم الإعلان غير الخطي. تعرض -2 إذا كان الحد الأدنى المقترَح غير معروف. بالنسبة إلى تصميم الإعلان الخطي، يتم عرض مدة الإعلان بالكامل.

المرتجعات

number الحد الأدنى المقترَح بالثواني لعرض تصميم الإعلان.

getSkipTimeset

تعرض getSkipOffset() رقم

عدد الثواني التي يتم خلالها تشغيل الفيديو قبل أن يصبح الإعلان قابلاً للتخطي. يتم عرض القيمة -1 للإعلانات غير القابلة للتخطي أو إذا كانت غير متاحة.

المرتجعات

number الإزاحة بالثواني أو -1.

الحصول على عنوان URL للاستطلاع

في حال توفّر سلسلة SearchUrlUrl()

عرض عنوان URL المرتبط بالاستطلاع للإعلان المحدّد. عرض قيمة فارغة إذا لم يكن متوفرًا.

المرتجعات

nullable string 

GetTitle

دالة getTitle() تعرض سلسلة

عرض عنوان هذا الإعلان من استجابة نموذج عرض إعلانات الفيديو (VAST)

المرتجعات

string العنوان فارغ إذا لم يتم تحديده.

الحصول على معلَمات الزيارات

تعرض gettraffickingParameters() كائنًا يحتوي على خصائص سلسلة

تحصل على معلّمات مخصّصة مرتبطة بالإعلان في وقت الإعلان.

المرتجعات

non-null Object with string properties ربط مفاتيح عدد الزيارات بقيمها أو العنصر فارغ في حال عدم توفّر هذه المعلومات

gettraffickingParametersString

gettraffickingParametersString() تعرض سلسلة

تحصل على معلّمات مخصّصة مرتبطة بالإعلان في وقت الإعلان. لعرض نسخة سلسلة أولية من المعلَمات المُحلَّلة من getTraffickingParameters.

المرتجعات

string معلَمة عدد الزيارات، أو السلسلة الفارغة في حال عدم توفّر هذه المعلومات.

الحصول على عناصر

تعرض getUiElements() مصفوفة من السلاسل.

تعرض عناصر واجهة المستخدم التي يتم عرضها عند تشغيل هذا الإعلان. يمكنك الرجوع إلى UiElements للاطّلاع على العناصر المحتمَلة في المصفوفة المعروضة.

المرتجعات

non-null Array of string عناصر واجهة المستخدم التي يتم عرضها

GetUniversalAdIdRegistry

تعرض سلسلة UniversalAdIdRegistry() السلسلة

قاعدة بيانات المسجّلين المرتبطة بكتالوج UniversalAdId لتصميم الإعلان المحدّد للإعلان

منهي العمل به
استخدِم ad.getUniversalAdIds() بدلاً من ذلك.
المرتجعات

string تعرض قيمة السجل أو "غير معروف" إذا لم تكن متاحة.

getUniversalAdIdValue

في انتظارك سلسلة بيانات أردت عرض UniversalUniversalIdValue()

UniversalAdId لتصميم الإعلان المُحدَّد للإعلان.

منهي العمل به
استخدِم ad.getUniversalAdIds() بدلاً من ذلك.
المرتجعات

string عرض قيمة رقم التعريف أو "غير معروف" إذا لم يكن متوفرًا.

الحصول على أرقام تعريف الإعلانات العامة

تعرض دالة UniversalAdIds() مصفوفة من UniversalAdIdInfo غير فارغة.

قائمة أرقام تعريف الإعلانات العامة لتصميم الإعلان المحدد للإعلان.

المرتجعات

non-null Array of non-null UniversalAdIdInfo يعرض قائمة معلومات رقم تعريف الإعلان العام التي تنطبق على هذا الإعلان.

GetVastMediaBitrate

تعرض getVastMediaBitrate() رقمًا

عند اختيار كل من تصميم الإعلان وملف الوسائط من خلال حزمة تطوير البرامج (SDK)، سيؤدي ذلك إلى عرض معدل نقل البيانات لملف الوسائط كما هو موضّح في الاستجابة الشاسعة.

المرتجعات

number معدل نقل البيانات لملف الوسائط الذي تم اختياره أو 0.

GetVastMediaHeight

تعرض getVastMediaHeight() رقمًا)

عرض ارتفاع وسائط نموذج عرض إعلانات الفيديو لتصميم الإعلان المحدد.

المرتجعات

number ارتفاع وسائط نموذج عرض إعلانات الفيديو (VAST) لتصميم الإعلان المحدّد أو 0 في حال عدم اختيار أيٍّ منهما.

GetVastMediaWidth

تعرض getVastMediaWidth() رقم

لعرض عرض وسائط نموذج عرض إعلانات الفيديو لتصميم الإعلان المحدد.

المرتجعات

number عرض وسائط نموذج عرض إعلانات الفيديو (VAST) لتصميم الإعلان المحدّد أو 0 في حال عدم اختيار أي إعلان.

الحصول على عرض

تعرض دالة getWidth() رقم

لعرض عرض تصميم الإعلان المحدد.

المرتجعات

number عرض تصميم الإعلان غير الخطي أو 0 لعرض تصميم إعلان خطي.

الحصول على أرقام تعريف الإعلانات

تعرض getWrapperAdIds() مصفوفة من السلاسل.

الأرقام التعريفية للإعلانات التي تُستخدم في إعلانات برامج التضمين تبدأ أرقام التعريف المعروضة عند الإعلان المضمّن (الداخلي) وتمرّ إلى الإعلان الخارجي الذي يحتوي على برنامج التضمين. يتم عرض صفيف فارغ في حال عدم ظهور إعلانات برامج تضمين.

المرتجعات

non-null Array of string أرقام تعريف الإعلانات، بدءًا من الإعلان المضمّن أو مصفوفة فارغة في حال عدم توفّر إعلانات برامج تضمين.

الحصول على أنظمة الأنظمة الأساسية

تعرض getWrapperAdSystems() صفيف من السلسلة.

أنظمة الإعلانات المستخدمة لإعلانات برامج التضمين وتبدأ أنظمة الإعلانات المعروضة عند الإعلان المضمّن ثم تمرّ إلى أقصى إعلان تضمين. يتم عرض صفيف فارغ في حال عدم ظهور إعلانات برامج تضمين.

المرتجعات

non-null Array of string أنظمة الإعلانات المستخدَمة، بدءًا من الإعلان المضمّن أو مصفوفة فارغة في حال عدم توفّر إعلانات عن برامج تضمين.

الحصول على أرقام تعريف تصميمات الإعلانات

تعرض getWrapperCreativeIds() مصفوفة من السلاسل.

أرقام تعريف تصميمات الإعلانات المحدّدة المستخدمة لإعلانات برامج التضمين. وتبدأ أرقام تعريف تصميمات الإعلانات التي تظهر عند الإعلان المضمّن وتمرّ إلى أعلى إعلان تضمين. ويتم عرض مصفوفة فارغة إذا لم تكن هناك إعلانات برامج تضمين.

المرتجعات

non-null Array of string أرقام تعريف تصميمات الإعلانات، بدءًا من الإعلان المضمّن أو مصفوفة فارغة في حال عدم توفّر إعلانات عن برامج تضمين

خطي

isis() تعرض القيمة المنطقية

تشير إلى ما إذا كان وضع التشغيل الحالي للإعلان خطي أو غير خطي. وإذا كانت القيمة صحيحة، يشير ذلك إلى أنّ الإعلان في وضع التشغيل الخطي، أمّا إذا كان خطأً، يشير إلى وضع غير خطي. يتحقّق المشغّل من الموقع الخطي ويعدّل حالته وفقًا لتفاصيل موضع الإعلان. عندما يكون الإعلان في الوضع الخطي، يوقف المشغّل الفيديو مؤقتًا. إذا كان التنسيق "صحيح" خطيًا في البداية، وكان الإعلان ما قبل التشغيل (محدّدًا خارجيًا)، قد يختار المشغّل تأخير تحميل الفيديو المخصّص للمحتوى إلى أن يقترب من نهاية تشغيل الإعلان.

المرتجعات

boolean صحيح إذا كان الإعلان خطيًا أو غير صحيح بخلاف ذلك.