الصف: StreamRequest

ima.StreamRequest

class   static

الشركة المصنِّعة

StreamRequest

new StreamRequest()

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

الخصائص

adTagParameters

ثابتة

سلسلة

اختيارية: يمكنك تجاهل مجموعة محدودة من مَعلمات علامات الإعلانات في طلب البث. تقدّم مقالة توفير مَعلمات الاستهداف لتدفق المحتوى مزيدًا من المعلومات. يمكنك أيضًا استخدام المَعلمتَين dai-ot وdai-ov لتحديد خيارك المفضّل من بين صيغ البث. اطّلِع على مقالة تجاهل مَعلمات صيغة البث لمزيد من المعلومات.

adUiNode

ثابتة

roSGNode

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

apiKey

ثابتة

سلسلة

اختيارية: يمكن استخدام هذه المفاتيح للمصادقة على طلبات البث. يجب إعداد مفاتيح مصادقة DAI في واجهة مستخدم "إعلانات الفيديو الديناميكية".

assetKey

ثابتة

سلسلة

هذه الميزة مطلوبة لأحداث البث المباشر. ويُستخدم هذا المعرّف لتحديد دفق الفيديو الذي يجب تشغيله. طلب البث المباشر مفتاح مادة العرض هو معرّف يمكن العثور عليه في واجهة مستخدم "إدارة حملة DoubleClick".

authToken

ثابتة

سلسلة

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

contentSourceId

ثابتة

سلسلة

هذا الحقل مطلوب لأحداث البث عند الطلب. يتم الحصول على cmsid من "مصدر محتوى الفيديو" في "إدارة الفيديو على DoubleClick" ضمن واجهة مستخدم "إدارة الفيديو على DoubleClick".

customAssetKey

ثابتة

سلسلة

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

التنسيق

ثابتة

ima.StreamFormat

تمثّل هذه السمة تنسيق البث. القيمة التلقائية هي ima.StreamFormat.HLS.

networkCode

ثابتة

سلسلة

رمز الشبكة للناشر الذي يرسل طلب البث رموز الشبكة مطلوبة لطلبات البث التي يتم إرسالها باستخدام createPodLiveStreamRequest أو createPodVodStreamRequest. هذه الرموز مطلوبة أيضًا لطلبات البث المباشر التي يتم إجراؤها باستخدام Cloud Stitching باستخدام createVideoStitcherLiveStreamRequest أو createVideoStitcherVodStreamRequest أو createVideoStitcherVodStreamRequestWithVodConfig. هذه الرموز اختيارية ويُنصح باستخدامها لطلبات البث المباشر التي يتم إجراؤها باستخدام createLiveStreamRequest أو createVodStreamRequest. تؤدي إضافة رمز الشبكة إلى تطبيق الإعدادات المحدّدة في واجهة مستخدم "مدير الإعلانات"، مثل تفعيل الإعلانات المحدودة الآلية. بالنسبة إلى عرض الإعلانات في Pod ودمجها في السحابة الإلكترونية، تؤدي إضافة رمز الشبكة إلى تحديد موقع البث وتشغيله. للعثور على رمز الشبكة، يُرجى الاطّلاع على هذه المقالة.

اللاعب

ثابتة

(ima.Player أو Invalid)

تنفيذ واجهة المشغّل

ppid

ثابتة

سلسلة

تمّ الإيقاف. استخدِم adTagParameters. اختيارية: المعرّف المقدَّم من الناشر لجمهور DFP

streamActivityMonitorId

ثابتة

سلسلة

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

videoId

ثابتة

سلسلة

هذا الحقل مطلوب لأحداث البث عند الطلب. معرّف مصدر محتوى الفيديو

videoObject

ثابتة

(roVideo أو Invalid)

عنصر الفيديو (مثل Video roSGNode) المسؤول عن تشغيل الفيديو على تطبيق العميل. سيتم استطلاع هذا العنصر للحصول على بيانات مختلفة لاستخدامها في تحديد توقيت أحداث ID3 المباشرة بتنسيق HLS بشكل صحيح.

videoStitcherSessionOptions

ثابتة

مصفوفة V

تُستخدَم خيارات الجلسة لضبط مَعلمات خاصة بأداة VideoStitcher من أجل VideoStitcher streamRequests.

الطُرق

createLiveStreamRequest

ثابتة

‫createLiveStreamRequest(assetKey, apiKey, networkCode) تعرض ima.StreamRequest

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

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

المرتجعات

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

createPodLiveStreamRequest

ثابتة

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) returns StreamRequest

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

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

المرتجعات

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

createPodVodStreamRequest

ثابتة

createPodVodStreamRequest(networkCode) returns StreamRequest

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

المَعلمة
networkCode	سلسلة رمز شبكة "مدير إعلانات Google"

المرتجعات

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

createStreamRequest

ثابتة

تعرض الدالة createStreamRequest() القيمة ima.StreamRequest

المرتجعات

ima.StreamRequest كائن ima.StreamRequest فارغ

createVideoStitcherLiveStreamRequest

ثابتة

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) returns ima.StreamRequest

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

المَعلمة
customAssetKey	سلسلة
networkCode	سلسلة
liveConfigId	سلسلة
المنطقة	سلسلة
projectNumber	سلسلة
oAuthToken	سلسلة

المرتجعات

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

createVideoStitcherVodStreamRequest

ثابتة

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) returns ima.StreamRequest

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

المَعلمة
adTagUrl	سلسلة
networkCode	سلسلة
contentSourceUrl	سلسلة
المنطقة	سلسلة
projectNumber	سلسلة
oAuthToken	سلسلة

المرتجعات

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

createVideoStitcherVodStreamRequestWithVodConfig

ثابتة

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) returns ima.StreamRequest

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

المَعلمة
vodConfigId	سلسلة
networkCode	سلسلة
المنطقة	سلسلة
projectNumber	سلسلة
oAuthToken	سلسلة

المرتجعات

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

createVodStreamRequest

ثابتة

يعيد createVodStreamRequest(contentSourceId، videoId، apiKey، networkCode) ima.StreamRequest

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

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

المرتجعات

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