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

الفئة ima

الطُرق

disableLogging، getStreamManager، initSdk، requestStream

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

disableLogging()

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

getStreamManager()

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

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

initSdk(settings)

لإعداد حزمة تطوير البرامج (SDK).

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

requestStream(streamRequest)

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

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

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

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

الفئة ima.AdBreakInfo

الحقول

adPosition، duration، podIndex، timeOffset، totalAds

الطُرق

createAdBreakInfo

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

الخصائص

الاسم	النوع	الوصف
adPosition		فهرس الإعلان في الفاصل الإعلاني يكون المؤشر 1 للإعلانات الواقفة بمفردها.
duration		الحد الأقصى لمدة الاستراحة بالثواني، أو -1 إذا كانت غير معروفة
podIndex		بالنسبة إلى أحداث البث المباشر، يتم عرض رقم تعريف الاستراحة كفهرس مجموعة الفواصل الإعلانية، أو 0 لإعلان ما قبل التشغيل. لا تتوفّر إعلانات ما بعد التشغيل في أحداث البث المباشر. الإعداد التلقائي هو -2. بالنسبة إلى الفيديو عند الطلب، يتم عرض فهرس مجموعة الإعلانات. بالنسبة إلى مجموعة إعلانات ما قبل التشغيل، يتم عرض الرمز 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 لموقع التسجيل الإلكتروني الذي يتم فيه تصنيف معرّف Universal Ad ID لتصميم الإعلان المحدّد.
universalAdIDValue		رقم تعريف الإعلان العالمي لتصميم الإعلان المحدّد للإعلان.
wrappers		صفيف من ima.WrapperInfo يحتوي على معلومات الغلاف لهذا الإعلان. سيكون الترتيب من التغليف الخارجي إلى التغليف الداخلي.

createAdInfo()

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

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

الفئة ima.Companion

الحقول

apiFramework، creativeType، height، trackingEvents، url، width

الطُرق

createCompanion

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

الخصائص

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

createCompanion()

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

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

الفئة ima.CuePoint

الحقول

end، hasPlayed، start

الطُرق

createCuePoint

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

الخصائص

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

createCuePoint()

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

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

الفئة ima.Error

الحقول

‫id، info، type

الطُرق

createError

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

الخصائص

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

createError()

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

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

الفئة 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		لم يقبل الخادم مفتاح واجهة برمجة التطبيقات المقدَّم.

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

الفئة ima.Player

الطُرق

adBreakEnded، adBreakStarted، allVideoComplete، createPlayer، loadUrl، streamInitialized

adBreakEnded(adBreakInfo)

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

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

adBreakStarted(adBreakInfo)

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

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

allVideoComplete()

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

createPlayer()

تُنشئ عنصر IMA Player فارغًا. يجب تنفيذ الدالة 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:

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

الفئة 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()

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

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 باستخدام data 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، 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 في واجهة مستخدم "مساحة العرض في "إعلانات Google".
assetKey		مطلوب لأحداث البث المباشر. يُستخدَم هذا المقياس لتحديد البث الذي يجب تشغيله. طلب البث المباشر مفتاح مادة العرض هو معرّف يمكن العثور عليه في واجهة مستخدم "مساحة العرض في الفيديو".
authToken		رمز التفويض لطلب البث تُستخدَم بدلاً من مفتاح واجهة برمجة التطبيقات لمنح أذونات أكثر صرامة للوصول إلى المحتوى. يمكن للناشر التحكّم في أذونات أحداث البث الفردية للمحتوى استنادًا إلى هذا الرمز المميّز.
contentSourceId		مطلوب لأحداث البث عند الطلب. تأتي قيمة cmsid من مصدر محتوى الفيديو في DFP في واجهة مستخدم DFP.
customAssetKey		يُستخدَم مفتاح مادة العرض المخصّص لتحديد البث الذي يجب تشغيله. يجب توفُّر مفاتيح مواد العرض المخصّصة لطلبات بث مجموعات المقاطع الصوتية.
format		تنسيق البث الإعداد التلقائي هو ima.StreamFormat.HLS.
networkCode		رمز الشبكة للناشر الذي يُقدّم طلب البث رموزا الشبكة مطلوبة لطلبات بث مجموعات المحتوى التي يتم إجراؤها باستخدام createPodLiveStreamRequest أو createPodVodStreamRequest. تكون هذه الرموز مطلوبة أيضًا لطلبات بث المحتوى باستخدام ميزة "التجميع في السحابة الإلكترونية" التي تم إجراؤها باستخدام رمزي createVideoStitcherLiveStreamRequest أو createVideoStitcherVodStreamRequest أو createVideoStitcherVodStreamRequestWithVodConfig. هذه الرموز هي اختيارية وننصح باستخدامها لطلبات البث الكامل التي يتم إجراؤها باستخدام رمزينهما: createLiveStreamRequest أو createVodStreamRequest. تؤدي إضافة رمز الشبكة إلى تطبيق الإعدادات التي تم اختيارها في واجهة مستخدم "مدير إعلانات Google"، مثل تفعيل الإعلانات محدودة الميزانية programmatic. لعرض مجموعة البث ودمجها في السحابة الإلكترونية، تؤدي إضافة رمز الشبكة إلى تحديد موقع البث وتشغيله. للعثور على رمز الشبكة، يُرجى الاطّلاع على هذه المقالة.
player		واجهة المشغّل
ppid		تمّ الإيقاف. استخدِم adTagParameters. اختياريّ. معرّف مقدَّم من الناشر لشريحة جمهور في "مساحة العرض والفيديو من Google"
streamActivityMonitorId		رقم التعريف الذي سيتم استخدامه لتصحيح أخطاء البث باستخدام أداة مراقبة نشاط البث. ويُستخدَم ذلك لتوفير طريقة ملائمة للسماح للناشرين بالعثور على سجلّ بث في أداة "مراقبة نشاط البث".
videoId		مطلوب لأحداث البث عند الطلب. معرّف لمصدر محتوى الفيديو
videoObject		عنصر الفيديو (مثل عنصر roSGNode للفيديو) المسؤول عن تشغيل الفيديو في تطبيق العميل. سيتمّ الاستعلام عن هذا العنصر للحصول على بيانات مختلفة لاستخدامها في تحديد توقيت أحداث Live HLS ID3 بشكلٍ سليم.
videoStitcherSessionOptions		تُستخدَم خيارات الجلسة لضبط مَعلمات محدّدة لبرنامج ربط الفيديوهات VideoStitcher streamRequests.

createLiveStreamRequest(assetKey, apiKey, networkCode)

لإعداد السمات المطلوبة لبث مباشر StreamRequest يؤدي استخدام هذه الواجهة إلى تجاهل أي خصائص أخرى خاصة بـ 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.apiKey الخاصة بالima.StreamRequest المعروضة، ويتمّ ضبطها تلقائيًا على سلسلة فارغة.

createPodVodStreamRequest(networkCode)

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

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

يبدأ الإجراء بإعداد السمات المطلوبة لفيديو VOD StreamRequest باستخدام vodConfigId الذي تم إنشاؤه من أداة تركيب الفيديو في السحابة الإلكترونية. يؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي خصائص أخرى خاصة بـ 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	رمز الشبكة للناشر الذي يقدّم طلب البث إنّ تضمين رمز الشبكة اختياري، ولكننا ننصح به.

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

الفئة ima.StreamType

الحقول

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

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

الخصائص

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

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

الفئة ima.WrapperInfo

الحقول

adId، adSystem، creativeAdId، creativeId، dealId

الطُرق

createWrapperInfo

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

الخصائص

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

createWrapperInfo()

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

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