حزمة تطوير البرامج لإدراج إعلان ديناميكي لإعلانات الوسائط التفاعلية لنظام 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, getStreamManager, initSdk, requestStream

وظائف عامة تتحكّم في حزمة IMA SDK.

disableLogging()

توقِف هذه الوسيطة تسجيل بيانات حزمة تطوير البرامج (SDK). سيتم تفعيل التسجيل تلقائيًا.

getStreamManager()

تعرض هذه السمة أداة إدارة البث إذا كانت متاحة. إذا لم يكن مدير البث متاحًا بعد، سيتم عرض Invalid. في حال حدوث خطأ أثناء إنشاء أداة إدارة البث، سيتم عرض عنصر خطأ.

النتائج object: مدير البث أو عنصر الخطأ.

initSdk(settings)

تُستخدَم لتهيئة حزمة تطوير البرامج (SDK).

المَعلمة	النوع	الوصف
settings	object	عنصر إعدادات IMA الاختياري

requestStream(streamRequest)

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

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

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

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

Class ima.AdBreakInfo

الحقول

adPosition, duration, podIndex, timeOffset, totalAds

الطُرق

createAdBreakInfo

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

الخصائص

الاسم	النوع	الوصف
adPosition		فهرس الإعلان في فاصل الإعلانات الفهرس هو 1 للإعلانات المستقلة.
duration		الحدّ الأقصى لمدّة الاستراحة بالثواني، أو -1 إذا كانت المدة غير معروفة
podIndex		بالنسبة إلى البث المباشر، تعرض هذه السمة رقم تعريف الفاصل الإعلاني كفهرس الحزمة، أو 0 لإعلان ما قبل التشغيل. لا تتوفّر إعلانات ما بعد التشغيل في أحداث البث المباشر. القيمة التلقائية هي -2. بالنسبة إلى الفيديو عند الطلب (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, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED, START, THIRD_QUARTILE

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

الخصائص

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

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

الفئة ima.AdInfo

الحقول

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, creativeAdId, creativeId, currentTime, dealId, duration, skipOffset, universalAdIDRegistry, universalAdIDValue, wrappers

الطُرق

createAdInfo

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

الخصائص

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

createAdInfo()

المرتجعات ima.AdInfo:

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

الفئة ima.Companion

الحقول

adSlotId, apiFramework, companionClickThrough, creativeType, height, trackingEvents, url, width

الطُرق

createCompanion

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

الخصائص

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

createCompanion()

المرتجعات ima.Companion:

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

Class ima.CuePoint

الحقول

end, hasPlayed, start

الطُرق

createCuePoint

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

الخصائص

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

createCuePoint()

المرتجعات ima.CuePoint:

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

Class ima.Error

الحقول

id, info, type

الطُرق

createError

العنصر الذي تم تمريره إلى معالج الأخطاء في حال حدوث خطأ

الخصائص

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

createError()

المرتجعات ima.Error:

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

Class ima.ErrorEvent

الحقول

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

جميع الأخطاء التي قد ترسلها حزمة تطوير البرامج (SDK)

الخصائص

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

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

Class ima.Player

الطُرق

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl, streamInitialized

adBreakEnded(adBreakInfo)

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

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

adBreakStarted(adBreakInfo)

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

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

allVideoComplete()

اختياريّ. يتم استدعاء هذا الإجراء عند اكتمال جميع الفيديوهات.

createPlayer()

تُنشئ هذه الطريقة عنصر Player فارغًا من IMA. يجب تنفيذ الدالة loadUrl لتشغيل الإعلانات. أما الوظائف الأخرى، فهي اختيارية.

عمليات الإرجاع ima.Player:

loadUrl(streamInfo)

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

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

streamInitialized(streamInfo)

يتم استدعاؤه عند إعداد بث.

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

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

الفئة ima.StreamFormat

الحقول

DASH, HLS

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

الخصائص

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

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

الفئة ima.StreamInfo

الحقول

‫format وmanifest وstreamId وstreamType وsubtitles

الطُرق

createStreamInfo

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

الخصائص

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

createStreamInfo()

المرتجعات ima.StreamInfo:

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

Class ima.StreamManager

الطُرق

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters, start

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

addEventListener(event, callback)

تضيف هذه السمة أداة معالجة للحدث المحدّد. راجِع الثابت AdEvents للاطّلاع على الأحداث المتوافقة.

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

createStreamManager(streamRequest, streamInitResponse)

المرتجعات ima.StreamManager:

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

enableInteractiveAds()

غير متاح بدلاً من ذلك، مرِّر البيانات من الإعلان المصاحب إلى RAF مباشرةً. أصبحت هذه العملية غير صالحة.

getContentTime(streamTime)

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

القيمة المعروضة Integer: تعرض هذه السمة وقت المحتوى الذي يتوافق مع وقت البث المحدّد.

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

getCuePoints()

تعرِض هذه الطريقة جميع نقاط الإشارات التي تتوافق مع كل الفواصل الإعلانية. لا ينطبق ذلك إلا على محتوى الفيديو عند الطلب الذي تكون فيه كل الفواصل الإعلانية معروفة مسبقًا. تمثّل جميع الأوقات وقت البث بالثواني. بالنسبة إلى بث Cloud Stitching API، تكون قيمة السمة hasPlayed لكل ima.CuePoint هي false دائمًا.

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

getPreviousCuePoint(time)

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

النتائج ima.CuePoint: عنصر يتضمّن start وend وhasPlayed. تعرِض هذه السمة قيمة غير صالحة إذا لم تتوفّر أي نقطة إشارة.

المَعلمة	النوع	الوصف
time	Float	يشير الوقت المطلوب البحث عنه، -1، إلى الوقت الحالي، ويعرض Invalid لجميع أحداث البث الأخرى.

getStreamTime(contentTime)

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

عمليات الإرجاع 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()

يبدأ تشغيل البث.

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

Class ima.StreamRequest

الحقول

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, ppid, streamActivityMonitorId, videoId, videoObject, videoStitcherSessionOptions

الطُرق

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

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

الخصائص

الاسم	النوع	الوصف
adTagParameters		اختياريّ. يمكنك تجاهل مجموعة محدودة من مَعلمات علامات الإعلانات في طلب البث. توفير مَعلمات استهداف مصادر العرض لتدفق الفيديو تقدّم المزيد من المعلومات. يمكنك أيضًا استخدام المَعلمتَين dai-ot وdai-ov لتحديد خيارك المفضّل من بين صيغ البث. اطّلِع على مقالة تجاوز مَعلمات صيغة البث للحصول على مزيد من المعلومات.
adUiNode		عقدة الرسم البياني للمشهد حيث يتم عرض واجهة مستخدم الإعلان تضع IMA عناصر مثل زرّي لماذا يظهر هذا الإعلان؟ وتخطّي على هذا العنصر أثناء عرض الإعلانات. يجب أن يغطي العنصر عنصر الفيديو بالكامل.
apiKey		اختياريّ. يمكن استخدام هذه المفاتيح للمصادقة على طلبات البث. يجب إعداد مفاتيح مصادقة DAI في واجهة مستخدم "إعلانات الفيديو الديناميكية".
assetKey		هذه الميزة مطلوبة لأحداث البث المباشر. يُستخدَم هذا المعرّف لتحديد دفق الفيديو الذي يجب تشغيله. طلب البث المباشر مفتاح الأصل هو معرّف يمكن العثور عليه في واجهة مستخدم "إدارة حملة DoubleClick".
authToken		رمز التفويض المميز لطلب البث يُستخدم بدلاً من مفتاح واجهة برمجة التطبيقات للحصول على إذن أكثر صرامة بشأن المحتوى. يمكن للناشر التحكّم في أذونات بث المحتوى الفردية استنادًا إلى هذا الرمز المميّز.
contentSourceId		هذا الحقل مطلوب لأحداث البث عند الطلب. يتم الحصول على cmsid من "مصدر محتوى الفيديو" في "شبكة DoubleClick للنشر" ضمن واجهة المستخدم الخاصة بـ "شبكة DoubleClick للنشر".
customAssetKey		يُستخدم مفتاح مادة العرض المخصّص لتحديد البث الذي يجب تشغيله. يجب توفير مفاتيح مواد عرض مخصّصة لطلبات بثّ الإعلانات ضمن حزمة.
format		تنسيق البث القيمة التلقائية هي ima.StreamFormat.HLS.
networkCode		رمز الشبكة للناشر الذي يرسل طلب البث. رموز الشبكة مطلوبة لطلبات البث التي يتم إرسالها باستخدام createPodLiveStreamRequest أو createPodVodStreamRequest. هذه الرموز مطلوبة أيضًا لطلبات بث Cloud Stitching التي يتم إجراؤها باستخدام createVideoStitcherLiveStreamRequest أو createVideoStitcherVodStreamRequest أو createVideoStitcherVodStreamRequestWithVodConfig. هذه الرموز اختيارية ويُنصح باستخدامها لطلبات بث الخدمة الكاملة التي يتم إجراؤها باستخدام createLiveStreamRequest أو createVodStreamRequest. تؤدي إضافة رمز الشبكة إلى تطبيق الإعدادات المحدّدة في واجهة مستخدم "مدير الإعلانات"، مثل تفعيل "الإعلانات المحدودة" الآلية. بالنسبة إلى عرض الإعلانات في Pod وخياطة المحتوى على السحابة الإلكترونية، تؤدي إضافة رمز الشبكة إلى تحديد موقع البث وتشغيله. للعثور على رمز الشبكة، يُرجى الاطّلاع على هذه المقالة.
player		تنفيذ لواجهة المشغّل
ppid		تمّ الإيقاف. استخدِم adTagParameters. اختياريّ. معرّف مقدَّم من الناشر خاص بـ "جمهور DFP"
streamActivityMonitorId		المعرّف الذي سيتم استخدامه لتصحيح أخطاء مصدر البيانات باستخدام أداة مراقبة نشاط البث. تُستخدَم هذه السمة لتوفير طريقة سهلة تتيح للناشرين العثور على سجلّ بث في أداة مراقبة نشاط البث.
videoId		هذا الحقل مطلوب لأحداث البث عند الطلب. معرّف مصدر محتوى الفيديو
videoObject		عنصر الفيديو (مثل Video roSGNode) المسؤول عن تشغيل الفيديو على تطبيق العميل، وسيتم استطلاع هذا العنصر للحصول على بيانات مختلفة لاستخدامها في تحديد توقيت أحداث ID3 المباشرة في HLS بشكل صحيح.
videoStitcherSessionOptions		تُستخدَم خيارات الجلسة لضبط مَعلمات خاصة بأداة VideoStitcher من أجل طلبات البث.

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

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

المَعلمة	النوع	الوصف
assetKey	string
apiKey	string	المَعلمة المعيّنة للسمة ima.StreamRequest.apiKey الخاصة بالكائن ima.StreamRequest الذي تم عرضه. إذا لم يكن هناك مفتاح لواجهة برمجة التطبيقات، مرِّر سلسلة فارغة.
networkCode	string	رمز الشبكة للناشر الذي يرسل طلب البث إنّ تضمين رمز الشبكة هو إجراء اختياري، ولكن ننصح به.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

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

تعرض هذه الطريقة الكائن StreamRequest: ima.StreamRequest مع سمات PodLive المطلوبة.

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

createPodVodStreamRequest(networkCode)

تهيئة السمات المطلوبة لعنصر ima.StreamRequest من أجل تسجيل بث فيديو عند الطلب عند استخدام ميزة "عرض الإعلانات داخل الحزمة" في "إدراج الإعلانات الديناميكي" مع أداة ربط فيديو تابعة لجهة خارجية تضبط هذه الدالة نوع الطلب على 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)

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

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

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

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

تهيئة الخصائص المطلوبة لفيديو عند الطلب (VOD) في Video Stitcher StreamRequest باستخدام vodConfigId تم إنشاؤه من خدمة Video Stitcher المستندة إلى السحابة الإلكترونية يؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي خصائص أخرى خاصة بـ StreamType. إذا كانت أيّ من المَعلمات المطلوبة عبارة عن سلاسل فارغة، سيتم تسجيل الخطأ وستعرض واجهة برمجة التطبيقات StreamRequest عامًا، بدون تجاهل أيّ خصائص.

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

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

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

المَعلمة	النوع	الوصف
contentSourceId	string
videoId	string
apiKey	string	المَعلمة المعيّنة للسمة ima.StreamRequest.apiKey الخاصة بالكائن ima.StreamRequest الذي تم عرضه. إذا لم يكن هناك مفتاح لواجهة برمجة التطبيقات، مرِّر سلسلة فارغة.
networkCode	string	رمز الشبكة للناشر الذي يرسل طلب البث إنّ تضمين رمز الشبكة هو إجراء اختياري، ولكن ننصح به.

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

Class ima.StreamType

الحقول

محتوى مباشر، فيديوهات عند الطلب

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

الخصائص

الاسم	النوع	الوصف
LIVE		تم نشر الفيديو.
VOD		الفيديو متاح عند الطلب.

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

الفئة ima.WrapperInfo

الحقول

adId, adSystem, creativeAdId, creativeId, dealId

الطُرق

createWrapperInfo

يحتوي على معلومات حول غلاف.

الخصائص

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

createWrapperInfo()

المرتجعات ima.WrapperInfo:

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