کلاس: StreamRequest

ایما درخواست جریان

کلاس استاتیک

سازنده

درخواست جریان

درخواست جریان جدید ()

برای تعیین ویژگی‌های درخواست جریان استفاده می‌شود.

خواص

پارامترهای adTag

استاتیک

رشته

اختیاری. شما می‌توانید مجموعه محدودی از پارامترهای برچسب تبلیغ را در درخواست پخش زنده خود لغو کنید. ارائه پارامترهای هدف‌گیری به پخش زنده شما اطلاعات بیشتری را ارائه می‌دهد. همچنین می‌توانید از پارامترهای dai-ot و dai-ov برای اولویت نوع پخش زنده استفاده کنید. برای اطلاعات بیشتر به بخش لغو پارامترهای نوع پخش زنده مراجعه کنید.

adUiNode

استاتیک

roSGNode

یک گره گراف صحنه که رابط کاربری تبلیغ در آن نمایش داده می‌شود. IMA عناصری مانند «چرا این تبلیغ» و دکمه‌های «رد شدن» را در طول تبلیغات روی این عنصر قرار می‌دهد. این عنصر باید کل عنصر ویدیو را بپوشاند.

کلید API

استاتیک

رشته

اختیاری. این کلیدها می‌توانند برای تأیید اعتبار درخواست‌های جریان استفاده شوند. کلیدهای تأیید اعتبار DAI باید در رابط کاربری DFP تنظیم شوند.

کلید دارایی

استاتیک

رشته

برای پخش زنده الزامی است. این برای تعیین اینکه کدام پخش باید پخش شود استفاده می‌شود. کلید دارایی درخواست پخش زنده، شناسه‌ای است که می‌توان آن را در رابط کاربری DFP یافت.

توکن احراز هویت

استاتیک

رشته

توکن مجوز درخواست جریان. به جای کلید API برای مجوزدهی دقیق‌تر محتوا استفاده می‌شود. ناشر می‌تواند مجوزهای جریان‌های محتوای فردی را بر اساس این توکن کنترل کند.

شناسه منبع محتوا

استاتیک

رشته

برای پخش‌های درخواستی مورد نیاز است. cmsid از منبع محتوای ویدیویی DFP در رابط کاربری DFP می‌آید.

کلید دارایی سفارشی

استاتیک

رشته

کلید دارایی سفارشی برای تعیین اینکه کدام استریم باید پخش شود استفاده می‌شود. کلیدهای دارایی سفارشی برای درخواست‌های استریم سرویس‌دهی پاد مورد نیاز هستند.

قالب

استاتیک

قالب جریانی ایما

قالب جریان. پیش‌فرض ima.StreamFormat.HLS است.

کد شبکه

استاتیک

رشته

کد شبکه برای ناشری که درخواست پخش زنده را انجام می‌دهد. کدهای شبکه برای درخواست‌های پخش زنده Pod که با createPodLiveStreamRequest یا createPodVodStreamRequest انجام می‌شوند، مورد نیاز هستند. این کدها همچنین برای درخواست‌های پخش زنده Cloud که با createVideoStitcherLiveStreamRequest، createVideoStitcherVodStreamRequest یا createVideoStitcherVodStreamRequestWithVodConfig انجام می‌شوند، مورد نیاز هستند. این کدها اختیاری هستند و برای درخواست‌های پخش زنده Full service که با createLiveStreamRequest یا createVodStreamRequest انجام می‌شوند، توصیه می‌شوند. افزودن کد شبکه، تنظیمات انتخاب شده در رابط کاربری Ad Manager، مانند فعال‌سازی تبلیغات محدود برنامه‌ریزی‌شده، را اعمال می‌کند. برای پخش زنده Pod و Cloud stitching، افزودن کد شبکه، پخش زنده را پیدا و پخش می‌کند. برای یافتن کد شبکه، به این مقاله مراجعه کنید.

بازیکن

استاتیک

( ima.Player یا نامعتبر)

پیاده‌سازی رابط کاربری پخش‌کننده.

پی پی دی

استاتیک

رشته

منسوخ شده. از adTagParameters استفاده کنید. اختیاری. شناسه ارائه شده توسط ناشر مخاطب DFP.

شناسه‌ی مانیتور فعالیت جریانی

استاتیک

رشته

شناسه‌ای که برای اشکال‌زدایی جریان با ابزار نظارت بر فعالیت جریان استفاده می‌شود. این شناسه برای فراهم کردن روشی آسان برای ناشران جهت یافتن گزارش جریان در ابزار نظارت بر فعالیت جریان استفاده می‌شود.

شناسه ویدیو

استاتیک

رشته

برای پخش آنلاین بر اساس تقاضا مورد نیاز است. شناسه منبع محتوای ویدیو.

شیء ویدئو

استاتیک

(roVideo یا نامعتبر)

شیء ویدیویی (مانند Video roSGNode) مسئول پخش ویدیو در برنامه کلاینت است. این شیء برای داده‌های مختلف جهت استفاده در زمان‌بندی صحیح رویدادهای Live HLS ID3 مورد بررسی قرار می‌گیرد.

گزینه‌های جلسه‌ی ویدیو

استاتیک

آرایه V

گزینه‌های جلسه برای تنظیم پارامترهای خاص استیکر ویدیو برای درخواست‌های جریان VideoStitcher استفاده می‌شوند.

روش‌ها

درخواست پخش زنده ایجاد کنید

استاتیک

تابع createLiveStreamRequest(assetKey, apiKey, networkCode) مقدار ima.StreamRequest را برمی‌گرداند.

ویژگی‌های مورد نیاز یک درخواست پخش زنده (Live StreamRequest را مقداردهی اولیه می‌کند. استفاده از این API باعث می‌شود سایر ویژگی‌های مختص به StreamType نادیده گرفته شوند. اگر هر یک از پارامترهای مورد نیاز رشته‌های خالی باشند، گزارش خطا رخ می‌دهد و API یک StreamRequest عمومی را برمی‌گرداند که هیچ ویژگی نادیده گرفته شده‌ای ندارد.

پارامتر
کلید دارایی	رشته
کلید API	رشته پارامتری که به ویژگی ima.StreamRequest مربوط به ima.StreamRequest.apiKey نسبت داده می‌شود. اگر هیچ کلید API وجود ندارد، یک رشته خالی ارسال کنید.
کد شبکه	رشته کد شبکه برای ناشری که درخواست پخش زنده را می‌دهد. گنجاندن کد شبکه اختیاری است، اما توصیه می‌شود.

بازگشت‌ها

ima.StreamRequest ima.StreamRequest با ویژگی‌های زنده مورد نیاز.

درخواست ایجادPodLiveStreak

استاتیک

تابع createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) درخواست جریان (StreamRequest) را برمی‌گرداند.

ویژگی‌های مورد نیاز ima.StreamRequest مربوط به Pod Live را مقداردهی اولیه می‌کند. استفاده از این API باعث می‌شود سایر ویژگی‌های خاص ima.StreamType نادیده گرفته شوند. اگر پارامترهای مورد نیاز رشته‌های خالی باشند، گزارش خطا رخ می‌دهد و API یک StreamRequest عمومی را برمی‌گرداند که هیچ ویژگی نادیده گرفته شده‌ای ندارد.

پارامتر
کلید دارایی سفارشی	رشته
کد شبکه	رشته
کلید API	رشته پارامتر اختیاری که به ویژگی ima.StreamRequest از ima.StreamRequest.apiKey نسبت داده می‌شود؛ مقدار پیش‌فرض آن رشته‌ی خالی است.

بازگشت‌ها

شیء StreamRequest ima.StreamRequest با ویژگی‌های مورد نیاز PodLive.

درخواست ایجادPodVodStream

استاتیک

تابع createPodVodStreamRequest(networkCode) درخواست جریان (StreamRequest) را برمی‌گرداند.

ویژگی‌های مورد نیاز یک ima.StreamRequest را برای ثبت یک جریان VOD هنگام استفاده از DAI Pod serveing ​​با یک video stitcher شخص ثالث، مقداردهی اولیه می‌کند. این تابع نوع درخواست را روی ima.StreamType.POD_VOD تنظیم می‌کند و تمام ویژگی‌های مورد نیاز را برای داده‌های از دست رفته اعتبارسنجی می‌کند. اعتبارسنجی‌های ناموفق، خطایی را در کنسول اشکال‌زدایی ثبت می‌کنند.

پارامتر
کد شبکه	رشته کد شبکه مدیریت تبلیغات گوگل

بازگشت‌ها

StreamRequest یک شیء ima.StreamRequest است. اگر تمام ویژگی‌های مورد نیاز مشخص شده باشند، نوع درخواست روی ima.StreamType.POD_VOD تنظیم می‌شود.

درخواست ایجاد جریان

استاتیک

تابع ()createStreamRequest مقدار ima.StreamRequest را برمی‌گرداند.

بازگشت‌ها

ima.StreamRequest یک شیء خالی از نوع ima.StreamRequest .

درخواست ایجاد دوخت ویدیو (VideoStitcher) پخش زنده

استاتیک

تابع createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) مقدار ima.StreamRequest را برمی‌گرداند.

ویژگی‌های مورد نیاز یک StreamRequest زنده‌ی Video Stitcher را مقداردهی اولیه می‌کند. استفاده از این API باعث می‌شود سایر ویژگی‌های مختص StreamType نادیده گرفته شوند. اگر هر یک از پارامترهای مورد نیاز رشته‌های خالی باشند، گزارش خطا رخ می‌دهد و API یک StreamRequest عمومی را برمی‌گرداند که هیچ ویژگی نادیده گرفته شده‌ای ندارد.

پارامتر
کلید دارایی سفارشی	رشته
کد شبکه	رشته
شناسه پیکربندی زنده	رشته
منطقه	رشته
شماره پروژه	رشته
oAuthToken	رشته

بازگشت‌ها

ima.StreamRequest ima.StreamRequest با ویژگی‌های مورد نیاز VideoStitcherLive.

درخواست دوخت ویدیو (video stitcher) در VodStream

استاتیک

تابع createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) مقدار ima.StreamRequest را برمی‌گرداند.

ویژگی‌های مورد نیاز یک StreamRequest مربوط به Video Stitcher VOD را مقداردهی اولیه می‌کند. استفاده از این API باعث می‌شود سایر ویژگی‌های مختص StreamType نادیده گرفته شوند. اگر هر یک از پارامترهای مورد نیاز رشته‌های خالی باشند، گزارش خطا رخ می‌دهد و API یک StreamRequest عمومی را برمی‌گرداند که هیچ ویژگی نادیده گرفته شده‌ای ندارد.

پارامتر
آدرس تبلیغ	رشته
کد شبکه	رشته
محتواSourceUrl	رشته
منطقه	رشته
شماره پروژه	رشته
oAuthToken	رشته

بازگشت‌ها

ima.StreamRequest ima.StreamRequest با ویژگی‌های مورد نیاز VideoStitcherVod.

پیکربندی createVideoStitcherVodStreamRequestWithVodConfig

استاتیک

تابع createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) مقدار ima.StreamRequest را برمی‌گرداند.

ویژگی‌های مورد نیاز یک Video Stitcher VOD StreamRequest با استفاده از vodConfigId ایجاد شده از cloud video stitcher مقداردهی اولیه می‌کند. استفاده از این API باعث می‌شود سایر ویژگی‌های خاص StreamType نادیده گرفته شوند. اگر هر یک از پارامترهای مورد نیاز رشته‌های خالی باشند، ثبت خطا رخ می‌دهد و API یک StreamRequest عمومی را برمی‌گرداند که هیچ ویژگی نادیده گرفته شده‌ای ندارد.

پارامتر
شناسه پیکربندی vod	رشته
کد شبکه	رشته
منطقه	رشته
شماره پروژه	رشته
oAuthToken	رشته

بازگشت‌ها

ima.StreamRequest ima.StreamRequest با ویژگی‌های مورد نیاز VideoStitcherVod.

درخواست ایجادVodStream

استاتیک

تابع createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) مقدار ima.StreamRequest را برمی‌گرداند.

ویژگی‌های مورد نیاز یک VOD به ima.StreamRequest را مقداردهی اولیه می‌کند. استفاده از این API باعث می‌شود سایر ویژگی‌های خاص ima.StreamType نادیده گرفته شوند. اگر هر یک از پارامترهای مورد نیاز رشته‌های خالی باشند، گزارش خطا رخ می‌دهد و API یک StreamRequest عمومی را برمی‌گرداند که هیچ ویژگی نادیده گرفته شده‌ای ندارد.

پارامتر
شناسه منبع محتوا	رشته
شناسه ویدیو	رشته
کلید API	رشته پارامتری که به ویژگی ima.StreamRequest مربوط به ima.StreamRequest.apiKey نسبت داده می‌شود. اگر هیچ کلید API وجود ندارد، یک رشته خالی ارسال کنید.
کد شبکه	رشته کد شبکه برای ناشری که درخواست پخش زنده را می‌دهد. گنجاندن کد شبکه اختیاری است، اما توصیه می‌شود.

بازگشت‌ها

ima.StreamRequest ima.StreamRequest با ویژگی‌های VOD مورد نیاز.