حزمة تطوير البرامج لإدراج إعلان ديناميكي لإعلانات الوسائط التفاعلية لنظام Roku

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

Class ima

الطُرق

الدوال الشاملة التي تتحكّم في حزمة تطوير البرامج لإعلانات الوسائط التفاعلية.

disableLogging()

يعمل على إيقاف تسجيل حزمة تطوير البرامج (SDK). سيكون التسجيل مفعّلاً بشكل تلقائي.

getStreamManager()

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

عرض object: مدير البث أو كائن الخطأ.

initSdk(settings)

يقوم بتهيئة SDK.

المَعلمة	النوع	الوصف
settings	object	عنصر إعدادات إعلانات الوسائط التفاعلية الاختياري.

requestStream(streamRequest)

بدء طلب بث غير متزامن يرجع عنصر التحكم "Control" إلى المشغّل فورًا بعد استدعاء هذه الطريقة.

عرض object: خطأ أو غير صالح إذا لم يكن هناك خطأ

المَعلمة	النوع	الوصف
streamRequest	object

الرجوع إلى الأعلى

معلومات الصف ima.AdBreakInfo

الحقول

الطُرق

يحتوي على معلومات حول الفاصل الإعلاني. تم تمرير هذه البيانات إلى معاودة الاتصال بالحدث من خلال حزمة تطوير البرامج (SDK).

أماكن إقامة

الاسم	النوع	الوصف
adPosition		فهرس الإعلان في الفاصل الإعلاني. سيكون الرقم 1 للإعلانات المستقلة.
duration		الحد الأقصى لمدة الفاصل بالثواني، أو -1 إذا كانت غير معروفة.
podIndex		بالنسبة إلى أحداث البث المباشر، يتم عرض القيمة -1 دائمًا. بالنسبة إلى الفيديو عند الطلب (VOD)، يعرض فهرس مجموعة الإعلانات المتسلسلة. بالنسبة إلى مجموعة الإعلانات المتسلسلة الخاصة بـ ما قبل التشغيل، تكون قيمة العرض 0. بالنسبة إلى الإعلانات أثناء التشغيل، يتم عرض 1، 2، ...، n. بالنسبة إلى مجموعة ما بعد التشغيل المتسلسلة، يتم عرض n+1...n+x. يتم ضبط إعداد مجموعة الإعلانات هذه على 0 إذا لم يكن هذا الإعلان جزءًا من مجموعة إعلانات متسلسلة، أو إذا لم يكن هذا الإعلان جزءًا من قائمة تشغيل.
timeOffset		تشير هذه السمة إلى موضع المجموعة في المحتوى بالثواني. تعرض إعلانات ما قبل التشغيل القيمة 0، وتعرض ما بعد التشغيل القيمة -1 وتعرض الإعلانات أثناء التشغيل الوقت المجدوَل لمجموعة الإعلانات المتسلسلة.
totalAds		إجمالي عدد الإعلانات المضمّنة في هذا الفاصل الإعلاني. سيكون الرقم 1 للإعلانات المستقلة.

createAdBreakInfo()

إرجاع ima.AdBreakInfo:

الرجوع إلى الأعلى

الفئة ima.AdEvent

الحقول

الأحداث التي أطلقها مدير الإعلانات.

أماكن إقامة

الاسم	النوع	الوصف
AD_PERIOD_ENDED		يتم تنشيطها في كل مرة ينتقل فيها البث من إعلان أو عنصر حاجب إلى المحتوى. سيتم تنشيط هذا النوع من الإعلانات حتى عند تشغيل إعلان مرة ثانية أو عند تقديم الفيديو أو ترجيعه إلى إعلان.
AD_PERIOD_STARTED		يتم تنشيطها في كل مرة ينتقل فيها البث من المحتوى إلى الإعلانات أو العناصر الحاجبة. سيتم تنشيط هذا النوع من الإعلانات حتى عند تشغيل إعلان مرة ثانية أو عند تقديم الفيديو أو ترجيعه إلى إعلان.
COMPLETE		يتم الإطلاق عند اكتمال تشغيل الإعلان.
ERROR		يتم تنشيطها عند حدوث خطأ.
FIRST_QUARTILE		يتم تنشيطها عندما يتجاوز رأس تشغيل الإعلان الربع الأول.
MIDPOINT		يتم إطلاقها عندما يتجاوز رأس تشغيل الإعلان نقطة المنتصف.
PROGRESS		يتم إطلاقها عند إجراء تحديث لتقدم أحد الإعلانات.
SKIPPABLE_STATE_CHANGED		يتم تنشيطها عندما تتغير حالة الإعلان القابل للتخطي.
SKIPPED		يتم تنشيطها عند تخطّي أحد الإعلانات.
START		يتم إطلاقه عند بدء تشغيل أحد الإعلانات.
THIRD_QUARTILE		يتم إطلاقها عندما يتجاوز رأس تشغيل الإعلان الربع الثالث.

الرجوع إلى الأعلى

الفئة ima.AdInfo

الحقول

الطُرق

يحتوي على معلومات حول إعلان. تم تمرير هذه البيانات إلى معاودة الاتصال بالحدث من خلال حزمة تطوير البرامج (SDK).

أماكن إقامة

الاسم	النوع	الوصف
adBreakInfo		معلومات ذات صلة بالفاصل الزمني الكامل الذي يظهر فيه هذا الإعلان.
adDescription		وصف الإعلان.
adId		رقم تعريف الإعلان أو سلسلة فارغة إذا كانت غير معروفة.
adSystem		النظام الإعلاني الذي يوفّر تصميم الإعلان.
adTitle		عنوان الإعلان.
advertiserName		اسم المعلِن، كما هو محدّد من قِبل الجهة التي تقدّم عرض الإعلانات.
companions		الإعلانات المصاحبة المحددة في استجابة نموذج عرض إعلانات الفيديو (VAST).
currentTime		الوقت الحالي داخل الإعلان بالثواني أو -1 إذا كان غير معروف.
duration		مدة هذا الإعلان المنفرد بالثواني أو -1 إذا كانت غير معروفة.
universalAdIDRegistry		سلسلة تُستخدَم لتحديد عنوان URL للموقع الإلكتروني لقاعدة بيانات المسجّلين حيث تتم فهرسة رقم تعريف الإعلان العام لتصميم الإعلان المحدّد.
universalAdIDValue		رقم تعريف الإعلان العام لتصميم الإعلان المحدّد.
wrappers		مصفوفة من ima.WrapperInfo مع معلومات برامج تضمين هذا الإعلان. سيكون الترتيب من المُغلّف الخارجي إلى الداخل.

createAdInfo()

إرجاع ima.AdInfo:

الرجوع إلى الأعلى

Class ima.Companion

الحقول

الطُرق

يحتوي على معلومات عن الإعلانات المصاحبة للإعلان.

أماكن إقامة

الاسم	النوع	الوصف
apiFramework		كانت واجهة برمجة التطبيقات مطلوبة لتنفيذ هذا الإعلان، أو غير صالحة في حال عدم توفّرها.
creativeType		تمثل هذه السمة نوع تصميم الإعلان عادةً نوع mime.
height		ارتفاع الإعلان المصاحب بالبكسل. 0 في حال عدم التوفّر.
trackingEvents		خريطة تتبُّع الأحداث حيث يكون المفتاح هو الحدث والقيمة هي قائمة بعناوين URL التي يتم فحصها عند رصد ذلك الحدث
url		عنوان URL للمصدر الثابت لهذا العنصر المصاحب.
width		عرض الإعلان المصاحب بالبكسل. 0 في حال عدم التوفّر.

createCompanion()

إرجاع ima.Companion:

الرجوع إلى الأعلى

الفئة ima.CuePoint

الحقول

الطُرق

يحتوي على معلومات حول نقطة عرض الإعلانات.

أماكن إقامة

الاسم	النوع	الوصف
end		وقت الانتهاء لنقطة إشارة بالثواني. ويتجاوب هذا مع فاصل إعلاني.
hasPlayed		قيمة منطقية تشير إلى أنّه سبق تشغيل نقطة الإشارات.
start		وقت بدء نقطة الإشارة بالثواني. ويتجاوب هذا مع فاصل إعلاني.

createCuePoint()

إرجاع ima.CuePoint:

الرجوع إلى الأعلى

Class ima.Error

الحقول

الطُرق

يتم تمرير الكائن إلى معالِج الأخطاء في حال حدوث خطأ.

أماكن إقامة

الاسم	النوع	الوصف
id		رقم تعريف الخطأ. راجِع الخطأ الثابت errorEvent للحصول على قائمة برموز الأخطاء.
info		معلومات إضافية حول الخطأ.
type		ويتم ضبطها دائمًا على "خطأ" للإشارة إلى نوع هذا الكائن.

createError()

إرجاع ima.Error:

الرجوع إلى الأعلى

الفئة ima.ErrorEvent

الحقول

جميع الأخطاء التي قد تُرسِلها حزمة SDK.

أماكن إقامة

الاسم	النوع	الوصف
BAD_STREAM_REQUEST		لم تتم تعبئة طلب البث بشكل صحيح.
COULD_NOT_LOAD_STREAM		تعذّر تحميل مجموعة البث.
ERROR		حدث خطأ غير معروف.
INVALID_RESPONSE		لم تكن استجابة الخادم صالحة.
STREAM_API_KEY_NOT_VALID		لم يقبل الخادم مفتاح واجهة برمجة التطبيقات الذي قدّمته.

الرجوع إلى الأعلى

Class ima.Player

الطُرق

adBreakEnded(adBreakInfo)

اختياريّ. يتم استدعاؤه عند انتهاء فاصل إعلاني.

المَعلمة	النوع	الوصف
adBreakInfo	ima.AdBreakInfo	تحتوي على معلومات حول الفاصل الإعلاني

adBreakStarted(adBreakInfo)

اختياريّ. يتم استدعاؤه عند بدء فاصل إعلاني.

المَعلمة	النوع	الوصف
adBreakInfo	ima.AdBreakInfo	تحتوي على معلومات حول الفاصل الإعلاني

allVideoComplete()

اختياريّ. يتم الاتصال به عند اكتمال كل الفيديو.

createPlayer()

تُنشئ كائن Player لإعلانات الوسائط التفاعلية فارغًا. يجب تنفيذ دالة loadUrl لتشغيل الإعلانات. الدوال الأخرى اختيارية.

إرجاع ima.Player:

loadUrl(streamInfo)

يتم استدعاؤه عندما يبدأ المشغِّل في تشغيل عنوان URL. يجب تنفيذ هذه الطريقة لتحميل البث

المَعلمة	النوع	الوصف
streamInfo	ima.StreamInfo	يحتوي على المعلومات اللازمة لتشغيل المحتوى.

الرجوع إلى الأعلى

الصف ima.StreamFormat

الحقول

تحدِّد هذه السياسة تنسيق مجموعة البث.

أماكن إقامة

الاسم	النوع	الوصف
DASH
HLS

الرجوع إلى الأعلى

الصف ima.StreamInfo

الحقول

الطُرق

المعلومات التي يتم تمريرها من حزمة تطوير البرامج (SDK) إلى المشغّل بشأن البث

أماكن إقامة

الاسم	النوع	الوصف
format		تمثّل هذه السمة تنسيق الفيديو: hls أو dash. محددة في ima.StreamFormat.
manifest		عنوان URL للبث.
streamId		رقم تعريف فريد لمصدر البيانات.
streamType		نوع الفيديو: مباشر أو مسجَّل يتم تحديدها في ima.StreamType.
subtitles		الترجمة، إن توفّرت غير صالح إذا لم يكن كذلك.

createStreamInfo()

إرجاع ima.StreamInfo:

الرجوع إلى الأعلى

الفئة ima.StreamManager

الطُرق

عنصر لإدارة تشغيل البث

addEventListener(event, callback)

لإضافة مستمع للحدث المحدَّد يمكنك الاطّلاع على ثابت Adالأحداث للأحداث المتوافقة.

المَعلمة	النوع	الوصف
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

إرجاع ima.StreamManager:

المَعلمة	النوع	الوصف
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

غير متوافق. وبدلاً من ذلك، مرِّر البيانات من الإعلان المصاحب إلى استراتيجية "RAF" مباشرةً. هذه بيئة مستقلة الآن.

getContentTime(streamTime)

يتم تخصيص وقت بالملي ثانية لبث الفيديو عند الطلب، ما يمثّل الوقت المستغرَق في المحتوى الخالي من الإعلانات. يمكنك الانتقال إلى https://developers.google.com/ad-manager/Dynamic-ad-insertion/sdk/roku/faq للحصول على وقت المحتوى الذي مرّ عليه وقت البث الحالي في -1.

عرض Integer: وقت المحتوى المقابل لوقت البث المحدّد.

المَعلمة	النوع	الوصف
streamTime	Integer	وقت البث.

getCuePoints()

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

تعرض هذه القيمة Object: مصفوفة تتضمّن جميع نقاط الإشارات.

getPreviousCuePoint(time)

لعرض نقطة عرض الإعلانات التي تسبق هذا الوقت. وتشير نقطة عرض الإعلانات إلى فاصل إعلاني. تمثّل جميع الأوقات وقت البث بالثواني.

تعرض ima.CuePoint: كائن به بداية ونهاية و hasPlayed. تعرض هذه السمة غير صالحة في حال عدم توفّر نقطة إشارة.

المَعلمة	النوع	الوصف
time	Float	وقت البحث، ويشير -1 إلى الوقت الحالي.

getStreamTime(contentTime)

لتوفير وقت للبث من وقت محتوى الفيديو عند الطلب بالمللي ثانية. يمكنك الاطّلاع على: https://developers.google.com/ad-manager/Dynamic-ad-insertion/sdk/roku/faq

عرض Integer: وقت البث المقابل لوقت المحتوى المحدّد.

المَعلمة	النوع	الوصف
contentTime	Integer	وقت المحتوى

loadThirdPartyStream(streamManifest, streamSubtitle)

تُحمِّل البيانات الوصفية للإعلان وتستدعي الدالة loadUrl باستخدام بيانات streamManifestUrl وstreamSubtitle المقدّمة. لا تعمل هذه الدالة إلا عندما يكون نوع طلب البث هو ima.StreamType.POD_VOD.

المَعلمة	النوع	الوصف
streamManifest	string	عنوان URL لبيان البث مع إعلانات تم تركيبها
streamSubtitle	ifArray>|Invalid	ترتبط الترجمة بالبث، أو Invalid إذا لم يتم ربطها.

onMessage(msg)

يعالج جميع الرسائل الواردة من عنصر الفيديو. يجب طلبه لكل رسالة يتم استلامها على roMessagePort.

المَعلمة	النوع	الوصف
msg	object	الرسالة من منفذ roVideo

replaceAdTagParameters(adTagParameters)

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

المَعلمة	النوع	الوصف
adTagParameters	string	معلمات علامة الإعلان الجديدة.

start()

لبدء تشغيل البث

الرجوع إلى الأعلى

الفئة ima.StreamRequest

الحقول

الطُرق

يُستخدَم لتحديد خصائص طلب البث.

أماكن إقامة

الاسم	النوع	الوصف
adTagParameters		اختياريّ. يمكنك إلغاء مجموعة محدودة من مَعلمات علامات الإعلان في طلب البث المباشر. يوفّر توفير مَعلمات استهداف البث مزيدًا من المعلومات. يمكنك أيضًا استخدام المَعلمتَين dai-ot وdai-ov لتحديد الإعدادات المفضّلة لخيارات البث. يمكنك الاطّلاع على مقالة إلغاء مَعلمات صيغ البث للحصول على مزيد من المعلومات.
adUiNode		عقدة رسم بياني للمشهد حيث يتم عرض واجهة مستخدم الإعلان. تضع إعلانات الوسائط التفاعلية عناصر مثل لماذا هذا الإعلان وزر التخطي على هذا العنصر أثناء عرض الإعلانات. يجب أن يظهر العنصر على سطح عنصر الفيديو بالكامل.
apiKey		اختياريّ. يمكن استخدام هذه المفاتيح لمصادقة طلبات البث. يجب إعداد مفاتيح مصادقة DAI في واجهة مستخدم LDAP.
assetKey		مطلوبة لأحداث البث المباشر يُستخدم هذا الإجراء لتحديد البث الذي يجب تشغيله. مفتاح مادة العرض لطلب البث المباشر هو معرّف يمكن العثور عليه في واجهة مستخدم التالي.
authToken		الرمز المميز لتفويض طلب البث المباشر. يُستخدم بدلاً من مفتاح واجهة برمجة التطبيقات للحصول على إذن أكثر صرامة بشأن المحتوى. يمكن للناشر التحكّم في تفويضات بث المحتوى الفردي بناءً على هذا الرمز المميّز.
contentSourceId		مطلوبة لأحداث البث المسجّلة. يأتي cmsid من مصدر محتوى فيديو DoubleClick في واجهة مستخدم DoubleClick.
customAssetKey		ويتمّ استخدام مفتاح مادة العرض المخصّص لتحديد البث الذي يجب تشغيله. تكون مفاتيح مواد العرض المخصّصة مطلوبة لطلبات بث عرض الإعلانات المتسلسلة.
format		تمثّل هذه السمة تنسيق ساحة المشاركات. وتكون الإعدادات التلقائية ima.StreamFormat.HLS.
networkCode		رمز الشبكة للناشر الذي يقدّم طلب البث تكون رموز الشبكة مطلوبة لطلبات بث عرض الإعلانات المتسلسلة.
player		تنفيذ واجهة المشغّل.
ppid		تمّ الإيقاف. استخدم adTagParameters. اختياريّ. المعرّف المقدَّم من الناشر للجمهور في BigQuery
streamActivityMonitorId		رقم التعريف الذي سيتمّ استخدامه لتصحيح أخطاء البثّ من خلال أداة مراقبة نشاط البث. يتم استخدام هذه البيانات لتوفير طريقة سهلة تتيح للناشرين العثور على سجلّ بث في أداة مراقبة نشاط البث.
videoId		مطلوبة لأحداث البث المسجّلة. معرّف لمصدر محتوى الفيديو
videoObject		كائن الفيديو (مثل Video roSGNode) المسؤول عن تشغيل الفيديو على تطبيق العميل. سيتم البحث في هذا العنصر عن بيانات متنوعة لاستخدامها في أحداث البث المباشر HLS ID3 بشكل صحيح.

createLiveStreamRequest(assetKey, apiKey)

يبدأ هذا الإعداد بالسمات المطلوبة لـ StreamRequest المباشر. يؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي سمات أخرى خاصة بـ StreamType. إذا كانت أي معلَمات مطلوبة عبارة عن سلاسل فارغة، يحدث تسجيل للأخطاء وتعرض واجهة برمجة التطبيقات علامة StreamRequest عامة، بدون تجاهل أي سمات.

عرض ima.StreamRequest: عنصر ima.StreamRequest مع خصائص مباشرة مطلوبة.

المَعلمة	النوع	الوصف
assetKey	string
apiKey	string	معلَمة اختيارية يتم تعيينها إلى السمة apiKey الخاصة بـ StreamRequest التي يتم عرضها، ويتم ضبطها تلقائيًا على سلسلة فارغة.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

يقوم هذا الإعداد بتهيئة السمات المطلوبة لـ ima.StreamRequest Pod Live. يؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي خصائص أخرى خاصة بـ ima.StreamType. إذا كانت أي معلَمات مطلوبة عبارة عن سلاسل فارغة، يحدث تسجيل للأخطاء وتعرض واجهة برمجة التطبيقات علامة StreamRequest عامة، بدون تجاهل أي سمات.

عرض StreamRequest: عنصر ima.StreamRequest مع خصائص PodLive المطلوبة.

المَعلمة	النوع	الوصف
customAssetKey	string
networkCode	string
apiKey	string	معلَمة اختيارية يتم ضبطها لسمة ima.StreamRequest.apiKey الخاصة بالسمة ima.StreamRequest المعروضة، ويتم ضبطها تلقائيًا على سلسلة فارغة.

createPodVodStreamRequest(networkCode)

تعمل هذه السياسة على إعداد السمات المطلوبة في ima.StreamRequest لتسجيل بث فيديو عند الطلب عند استخدام لوحة DAI Pod مع أداة دمج فيديوهات تابعة لجهة خارجية. تضبط هذه الدالة نوع الطلب على ima.StreamType.POD_VOD وتتحقّق من صحة جميع السمات المطلوبة للبيانات غير المتوفّرة. في حال تعذُّر عمليات التحقق من الصحة، سيتم تسجيل خطأ في وحدة تحكُّم تصحيح الأخطاء.

عرض StreamRequest: كائن ima.StreamRequest. وإذا تم تحديد جميع السمات المطلوبة، يتم ضبط نوع الطلب على ima.StreamType.POD_VOD.

المَعلمة	النوع	الوصف
networkCode	string	رمز شبكة "مدير إعلانات Google"

createStreamRequest()

عرض ima.StreamRequest: كائن ima.StreamRequest فارغ.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

يؤدي هذا الإعداد إلى إعداد الخصائص المطلوبة لميزة Video Stitcher Live. StreamRequest. ويؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي سمات أخرى خاصة بـ StreamType. إذا كانت أي معلَمات مطلوبة عبارة عن سلاسل فارغة، يحدث تسجيل للأخطاء وتعرض واجهة برمجة التطبيقات علامة StreamRequest عامة، بدون تجاهل أي سمات.

عرض ima.StreamRequest: عنصر ima.StreamRequest مع خصائص VideoStitcherLive المطلوبة.

المَعلمة	النوع	الوصف
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

تعمل هذه السياسة على إعداد السمات المطلوبة الخاصة بالفيديوهات عند الطلب في أداة "دمج الفيديو" StreamRequest. ويؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي سمات أخرى خاصة بـ StreamType. إذا كانت أي معلَمات مطلوبة عبارة عن سلاسل فارغة، يحدث تسجيل للأخطاء وتعرض واجهة برمجة التطبيقات علامة StreamRequest عامة، بدون تجاهل أي سمات.

عرض ima.StreamRequest: عنصر ima.StreamRequest مع خصائص VideoStitcherVod المطلوبة.

المَعلمة	النوع	الوصف
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

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

عرض ima.StreamRequest: عنصر ima.StreamRequest يتضمّن سمات مطلوبة عند الطلب

المَعلمة	النوع	الوصف
contentSourceId	string
videoId	string
apiKey	string	معلَمة اختيارية يتم ضبطها لسمة ima.StreamRequest.apiKey الخاصة بالسمة ima.StreamRequest المعروضة، ويتم ضبطها تلقائيًا على سلسلة فارغة.

الرجوع إلى الأعلى

الفئة ima.StreamType

الحقول

لتحديد نوع البث الذي يُطلب من المشغّل تشغيله. يجب أن يتم تشغيل إعلانات ما قبل التشغيل والفيديوهات عند الطلب من بداية البث.

أماكن إقامة

الاسم	النوع	الوصف
LIVE		الفيديو معروض على المنصة.
VOD		الفيديو مسجَّل.

الرجوع إلى الأعلى

معلومات الصف ima.WrapperInfo

الحقول

الطُرق

تحتوي على معلومات حول برنامج تضمين.

أماكن إقامة

الاسم	النوع	الوصف
adId		رقم تعريف الإعلان أو سلسلة فارغة إذا كانت غير معروفة.
adSystem		الاسم المُعلَن لنظام الإعلانات أو السلسلة الفارغة إذا كانت غير معروفة.
creativeAdId		رقم تعريف الإعلان على تصميم الإعلان أو سلسلة فارغة إذا كانت غير معروفة.
creativeId		رقم تعريف تصميم الإعلان أو سلسلة فارغة إذا كانت غير معروفة.
dealId		رقم تعريف الصفقة أو سلسلة فارغة إذا كانت غير معروفة.

createWrapperInfo()

إرجاع ima.WrapperInfo:

الرجوع إلى الأعلى