الفئة ima
الطُرق
الدوال العامة التي تتحكّم في حزمة تطوير البرامج لإعلانات الوسائط التفاعلية.
disableLogging()
لإيقاف تسجيل حزمة تطوير البرامج (SDK). سيتم تفعيل التسجيل تلقائيًا.
getStreamManager()
عرض مدير بث في حال توفّره
في حال عدم توفّر مدير البث بعد، يتم عرض الخيار "غير صالح".
إذا حدث خطأ أثناء إنشاء مدير البث، يتم عرض عنصر الخطأ.
عرض object
: مدير البث أو كائن الخطأ.
initSdk(settings)
يقوم بتهيئة SDK.
المَعلمة | النوع | الوصف |
---|---|---|
settings |
object |
كائن إعدادات إعلانات الوسائط التفاعلية الاختياري. |
requestStream(streamRequest)
لبدء طلب بث غير متزامن
يعود عنصر التحكم إلى المشغّل فورًا بعد استدعاء هذه الطريقة.
عرض 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 |
|
يتم الإطلاق عندما يتخطى رأس تشغيل الإعلان الربع الأول. |
ICON_FALLBACK_IMAGE_CLOSED |
|
يتم الإطلاق عندما يغلق المستخدم مربّع حوار الصورة الاحتياطية للرمز. |
ICON_FALLBACK_IMAGE_SHOWN |
|
يتم الإطلاق عند عرض الصورة الاحتياطية للرمز. |
MIDPOINT |
|
يتم إطلاقه عندما يتخطى رأس تشغيل الإعلان نقطة المنتصف. |
PROGRESS |
|
يتم الإطلاق عند وجود تحديث لتقدّم الإعلان. |
SKIPPABLE_STATE_CHANGED |
|
يتم الإطلاق عند تغيير حالة إعلان قابل للتخطّي. |
SKIPPED |
|
يتم الإطلاق عند تخطي إعلان. |
START |
|
يتم إطلاقه عند بدء تشغيل الإعلان. |
THIRD_QUARTILE |
|
يتم إطلاقه عندما يتخطى رأس تشغيل الإعلان الربع الثالث. |
فئة ima.AdInfo
الحقول
الطُرق
يحتوي على معلومات عن إعلان تم تمريرها إلى عمليات استدعاء الأحداث من خلال حزمة تطوير البرامج (SDK).
أماكن إقامة
الاسم | النوع | الوصف |
---|---|---|
adBreakInfo |
|
معلومات ذات صلة بالفاصل الذي يوجد فيه هذا الإعلان بالكامل. |
adDescription |
|
وصف الإعلان. |
adId |
|
رقم تعريف الإعلان أو سلسلة فارغة إذا كانت غير معروفة. |
adSystem |
|
نظام الإعلانات الذي يوفّر تصميم الإعلان. |
adTitle |
|
عنوان الإعلان. |
advertiserName |
|
اسم المعلِن على النحو المحدّد من قِبل الجهة التي تعرض الإعلانات |
companions |
|
الإعلانات المصاحبة المحددة في استجابة VAST. |
currentTime |
|
الوقت الحالي ضمن الإعلان بالثواني أو -1 إذا كان غير معروف. |
duration |
|
مدة هذا الإعلان الفردي بالثواني أو -1 إذا كانت غير معروفة. |
skipOffset |
|
الوقت الذي يستغرِقه الإعلان ليصبح قابلاً للتخطّي أو -1 إذا كان غير معروف. |
universalAdIDRegistry |
|
سلسلة يتم استخدامها لتحديد عنوان URL للموقع الإلكتروني لقاعدة بيانات المسجّلين حيث يتم فهرسة رقم تعريف الإعلان العام لتصميم الإعلان المحدّد |
universalAdIDValue |
|
رقم تعريف الإعلان العام لتصميم الإعلان المحدّد. |
wrappers |
|
مصفوفة من ima.WrapperInfo تتضمن معلومات برنامج تضمين لهذا الإعلان. سيكون الترتيب من الغلاف الخارجي إلى الداخلي. |
createAdInfo()
الإرجاع ima.AdInfo
:
فئة ima.Companion
الحقول
الطُرق
يحتوي على معلومات عن الإعلانات المصاحبة للإعلان.
أماكن إقامة
الاسم | النوع | الوصف |
---|---|---|
apiFramework |
|
واجهة برمجة التطبيقات اللازمة لتنفيذ هذا الإعلان، أو "غير صالحة" إذا كانت غير متوفرة. |
creativeType |
|
يمثل نوع التصميم عادةً نوع MIME. |
height |
|
ارتفاع الإعلان المصاحب بالبكسل. 0 في حال عدم توفّره. |
trackingEvents |
|
خريطة لأحداث التتبُّع التي يكون فيها المفتاح هو الحدث، والقيمة هي قائمة بعناوين URL المطلوب إرسال إشارة إليها عند ذلك الحدث |
url |
|
تمثّل هذه السمة عنوان URL للمورد الثابت لهذا العنصر المصاحب. |
width |
|
عرض الإعلان المصاحب بالبكسل. 0 في حال عدم توفّره. |
createCompanion()
الإرجاع ima.Companion
:
فئة ima.CuePoint
الحقول
الطُرق
تحتوي على معلومات حول نقطة عرض أحداث
أماكن إقامة
الاسم | النوع | الوصف |
---|---|---|
end |
|
وقت انتهاء نقطة إشارة بالثواني. ويتجاوب هذا مع فاصل إعلاني. |
hasPlayed |
|
قيمة منطقية تشير إلى نقطة إشارة التشغيل سبق أن تم تشغيلها. |
start |
|
وقت بدء نقطة إشارة بالثواني. ويتجاوب هذا مع فاصل إعلاني. |
createCuePoint()
الإرجاع ima.CuePoint
:
الفئة 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 |
|
لم يقبل الخادم مفتاح واجهة برمجة التطبيقات الذي تم تقديمه. |
فئة 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 أو الشرطة تم تحديدها في ima.StreamFormat. |
manifest |
|
عنوان URL للبث. |
streamId |
|
معرّف فريد لمصدر البيانات |
streamType |
|
نوع الفيديو: مباشر أو مسجَّل تم تحديدها في ima.StreamType. |
subtitles |
|
الترجمات، إن توفّرت غير صالح إذا لم يكن كذلك. |
createStreamInfo()
الإرجاع ima.StreamInfo
:
فئة ima.StreamManager
الطُرق
عنصر لإدارة تشغيل البث.
addEventListener(event, callback)
إضافة مستمع للحدث المحدَّد يمكنك الاطّلاع على ثابت أحداث الإعلان
للأحداث المتوافقة.
المَعلمة | النوع | الوصف |
---|---|---|
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 |
الترجمة المرتبطة بالبث، أو |
onMessage(msg)
يعالج جميع الرسائل الواردة من عنصر الفيديو.
يجب طلبها لكل رسالة يتم تلقّيها في roMessagePort.
المَعلمة | النوع | الوصف |
---|---|---|
msg |
object |
الرسالة الواردة من منفذ roVideo |
replaceAdTagParameters(adTagParameters)
تستبدل جميع معلمات علامات الإعلان لاستخدامها في طلبات الإعلان القادمة للبث المباشر. يُرجى العِلم أنّه لا يمكن استخدام هذا الخيار في أحداث بث الفيديو عند الطلب.
المَعلمة | النوع | الوصف |
---|---|---|
adTagParameters |
string |
معلمات علامات الإعلان الجديدة. |
start()
لبدء تشغيل البث
فئة ima.StreamRequest
الحقول
الطُرق
يُستخدَم لتحديد خصائص طلب البث.
أماكن إقامة
الاسم | النوع | الوصف |
---|---|---|
adTagParameters |
|
اختياريّ. يمكنك إلغاء مجموعة محدودة من مَعلمات علامات الإعلانات في طلب البث. توفير معلمات استهداف ضمن البث: يمكنك توفير المزيد من المعلومات. يمكنك أيضًا استخدام المَعلمتَين dai-ot وdai-ov من أجل تحديد الإعدادات المفضّلة لخيارات البث. اطّلِع على إلغاء معلَمات خيارات البث المباشر للحصول على مزيد من المعلومات. |
adUiNode |
|
عقدة رسم بياني للمشهد يتم فيها عرض واجهة مستخدم الإعلان. تضع إعلانات الوسائط التفاعلية عناصر مثل زرَّي لماذا هذا الإعلان؟ والتخطي في هذا العنصر أثناء عرض الإعلانات. يجب أن يتراكب العنصر على سطح عنصر الفيديو بالكامل. |
apiKey |
|
اختياريّ. ويمكن استخدام هذه المفاتيح لمصادقة طلبات البث. يجب إعداد مفاتيح مصادقة DAI في واجهة مستخدم DDEX. |
assetKey |
|
مطلوب لأحداث البث المباشر ويستخدم هذا لتحديد البث الذي يجب تشغيله. مفتاح مادة العرض لطلب البث المباشر هو معرّف يمكن العثور عليه في واجهة مستخدم DDEX. |
authToken |
|
الرمز المميز لتفويض طلب البث. تُستخدم بدلاً من مفتاح واجهة برمجة التطبيقات للحصول على تفويض أكثر صرامة للمحتوى. ويمكن للناشر التحكم في تفويضات عمليات بث المحتوى الفردية بناءً على هذا الرمز. |
contentSourceId |
|
هذا الخيار مطلوب لأحداث البث عند الطلب. يأتي cmsid من مصدر محتوى الفيديو في DoubleClick في واجهة مستخدم DDEX. |
customAssetKey |
|
يُستخدَم مفتاح مادة العرض المخصّصة لتحديد البث الذي يجب تشغيله. يجب توفير مفاتيح مواد العرض المخصّصة لطلبات البث التي تعرض إعلانات البانر. |
format |
|
تنسيق البث. وتكون القيمة التلقائية هي |
networkCode |
|
رمز الشبكة للناشر الذي يقدّم طلب البث. يجب توفير رموز الشبكة لطلبات البث التي تعرض إعلانات الإعلانات المتسلسلة. |
player |
|
هو تطبيق لواجهة المشغِّل. |
ppid |
|
تمّ الإيقاف. استخدِم مَعلمة adTag. اختياريّ. المعرّف الذي قدّمه الناشر لدى "جمهور DoubleClick" |
streamActivityMonitorId |
|
رقم التعريف الذي سيتم استخدامه لتصحيح أخطاء البث باستخدام أداة مراقبة نشاط ساحة المشاركات. ويُستخدَم هذا الإجراء لتوفير طريقة ملائمة تسمح للناشرين بالعثور على سجلّ البث في أداة مراقبة نشاط البث. |
videoId |
|
هذا الخيار مطلوب لأحداث البث عند الطلب. معرّف لمصدر محتوى الفيديو |
videoObject |
|
تمثّل هذه السمة كائن الفيديو (مثل Video roSGNode) المسؤول عن تشغيل الفيديو على تطبيق العميل. وسيتم فحص هذا العنصر بحثًا عن بيانات مختلفة لاستخدامها في تحديد توقيت أحداث Live HLS ID3 بشكل صحيح. |
videoStitcherSessionOptions |
|
وتُستخدم خيارات الجلسة لضبط معلَمات خاصة بشكل أكثر دقّة لطلبات البث VideoStitcher. |
createLiveStreamRequest(assetKey, apiKey)
يؤدي إلى إعداد الخصائص المطلوبة لـ StreamRequest
المنشور. يؤدي استخدام
واجهة برمجة التطبيقات هذه إلى تجاهل أي سمات أخرى خاصة بـ StreamType
.
في حال كانت أي مَعلمات مطلوبة عبارة عن سلاسل فارغة، سيحدث تسجيل الأخطاء وتعرض واجهة برمجة التطبيقات
علامة StreamRequest
عامة، بدون تجاهل أي سمات.
عرض ima.StreamRequest
: عنصر ima.StreamRequest
به سمات Live مطلوبة.
المَعلمة | النوع | الوصف |
---|---|---|
assetKey |
string |
|
apiKey |
string |
مَعلمة اختيارية سيتم تخصيصها للسمة |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
تؤدي هذه السياسة إلى إعداد الخصائص المطلوبة لمجموعة Pod Live ima.StreamRequest
.
يؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي سمات أخرى خاصة بـ ima.StreamType
.
في حال كانت أي مَعلمات مطلوبة عبارة عن سلاسل فارغة، سيحدث تسجيل الأخطاء وتعرض واجهة برمجة التطبيقات
علامة StreamRequest
عامة، بدون تجاهل أي سمات.
عرض StreamRequest
: عنصر ima.StreamRequest
يتضمّن خصائص PodLive المطلوبة.
المَعلمة | النوع | الوصف |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
معلَمة اختيارية سيتم تخصيصها للسمة |
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)
يضبط السمات المطلوبة للفيديو المسجّل في أداة Video Stitcher
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)
يضبط السمات المطلوبة للفيديو عند الطلب ضمن أداة Video Stitcher
StreamRequest
باستخدام السمة vodConfigId
التي يتم إنشاؤها من
أداة دمج الفيديوهات على السحابة الإلكترونية.
يؤدي استخدام واجهة برمجة التطبيقات هذه إلى تجاهل أي سمات أخرى خاصة بـ StreamType
.
في حال كانت أي مَعلمات مطلوبة عبارة عن سلاسل فارغة، سيحدث تسجيل الأخطاء وتعرض واجهة برمجة التطبيقات
علامة StreamRequest
عامة، بدون تجاهل أي سمات.
عرض ima.StreamRequest
: عنصر ima.StreamRequest
مع
سمات VideoStitcherVod المطلوبة.
المَعلمة | النوع | الوصف |
---|---|---|
vodConfigId |
string |
|
networkCode |
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.StreamType
الحقول
تحدد نوع البث الذي يُطلب من اللاعب تشغيله. يجب أن يتم تشغيل إعلانات ما قبل التشغيل والفيديوهات المسجّلة من بداية البث.
أماكن إقامة
الاسم | النوع | الوصف |
---|---|---|
LIVE |
|
تم نشر الفيديو. |
VOD |
|
الفيديو متوفر عند الطلب. |
الفئة ima.WrapperInfo
الحقول
الطُرق
يحتوي على معلومات حول برنامج تضمين.
أماكن إقامة
الاسم | النوع | الوصف |
---|---|---|
adId |
|
رقم تعريف الإعلان أو سلسلة فارغة إذا كانت غير معروفة. |
adSystem |
|
الاسم المعلَن لنظام الإعلانات أو السلسلة الفارغة إذا كانت غير معروفة. |
creativeAdId |
|
رقم تعريف الإعلان في تصميم الإعلان أو سلسلة فارغة إذا كان غير معروف |
creativeId |
|
رقم تعريف تصميم الإعلان أو سلسلة فارغة إذا كان غير معروف |
dealId |
|
رقم تعريف الصفقة أو سلسلة فارغة إذا كان غير معروف. |
createWrapperInfo()
الإرجاع ima.WrapperInfo
: