IMA DAI SDK برای Roku،IMA DAI SDK برای Roku

1. 1. ایما
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.همراه
   6. ima.CuePoint
   7. ima.خطا
   8. ima.ErrorEvent
   9. ima.بازیکن
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

کلاس امام

روش ها

disableLogging ، getStreamManager ، initSdk ، requestStream

توابع جهانی که IMA SDK را کنترل می کنند.

disableLogging()

گزارش SDK را غیرفعال می کند. ورود به سیستم به طور پیش فرض روشن خواهد بود.

getStreamManager()

اگر مدیر جریانی موجود باشد، آن را برمی‌گرداند. اگر مدیر جریان هنوز در دسترس نباشد، Invalid برگردانده می شود. اگر خطایی در ایجاد مدیر جریان وجود داشته باشد، یک شی خطا برگردانده می شود.

object برمی گرداند: مدیر جریان یا شیء خطا.

initSdk(settings)

SDK را راه اندازی می کند.

پارامتر	تایپ کنید	توضیحات
settings	object	شی تنظیمات IMA اختیاری.

requestStream(streamRequest)

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

object برمی گرداند: یک خطا یا نامعتبر در صورت عدم وجود خطا

پارامتر	تایپ کنید	توضیحات
streamRequest	object

بازگشت به بالا

کلاس ima.AdBreakInfo

فیلدها

adPosition ، مدت ، podIndex ، timeOffset ، totalAds

روش ها

createAdBreakInfo

حاوی اطلاعاتی درباره وقفه تبلیغاتی است. توسط SDK به تماس‌های رویداد ارسال شد.

خواص

نام	تایپ کنید	توضیحات
adPosition		نمایه آگهی در استراحت آگهی. این شاخص برای تبلیغات مستقل 1 است.
duration		حداکثر مدت وقفه بر حسب ثانیه، یا -1 اگر نامشخص باشد.
podIndex		برای جاری‌سازی‌های زنده، شناسه استراحت را به‌عنوان فهرست غلاف یا 0 برای پیش‌پول برمی‌گرداند. هیچ پست فهرستی در جریان‌های زنده وجود ندارد. پیش‌فرض روی -2 است. برای ویدیوی درخواستی (VOD)، نمایه غلاف آگهی را برمی‌گرداند. برای یک pod preroll، 0 را برمی‌گرداند. برای midroll ها، 1 ، 2 ، ...، n را برمی گرداند. برای یک pod postroll، 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_ED , SKIPPANGED , START_STATE , 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 , universalAdIDrappers ,

روش ها

createAdInfo

حاوی اطلاعاتی در مورد یک آگهی است. توسط SDK به تماس‌های رویداد ارسال شد.

خواص

نام	تایپ کنید	توضیحات
adBreakInfo		اطلاعات مربوط به کل وقفه این آگهی است.
adDescription		توضیحات آگهی
adId		شناسه آگهی یا یک رشته خالی در صورت ناشناخته بودن.
adSystem		سیستم تبلیغاتی که افراد خلاق را تامین می کند.
adTitle		عنوان آگهی.
advertiserName		نام تبلیغ کننده که توسط طرف ارائه دهنده تعریف شده است.
companions		تبلیغات همراه مشخص شده در پاسخ VAST.
creativeAdId		کد ISCI (شناسه تجاری استاندارد صنعتی) برای یک آگهی. این شناسه آگهی خلاقیت انتخاب شده در پاسخ VAST است.
creativeId		شناسه خلاقیت انتخاب شده برای آگهی.
currentTime		زمان فعلی در یک آگهی در ثانیه یا -1 در صورت ناشناخته بودن.
dealId		اولین شناسه معامله موجود در زنجیره بسته بندی آگهی فعلی را از بالا شروع می کند.
duration		مدت زمان این آگهی واحد بر حسب ثانیه یا -1 در صورت ناشناخته بودن.
skipOffset		مدت زمانی که طول می کشد تا تبلیغ قابل رد شدن باشد یا -1 در صورت ناشناخته شدن.
universalAdIDRegistry		رشته ای که برای شناسایی نشانی وب سایت رجیستری استفاده می شود که شناسه آگهی جهانی خلاقیت انتخاب شده در آن فهرست شده است.
universalAdIDValue		شناسه آگهی جهانی خلاقیت انتخاب شده برای آگهی.
wrappers		آرایه ای از ima.WrapperInfo با اطلاعات لفاف برای این آگهی. ترتیب از لفاف بیرونی به داخل خواهد بود.

createAdInfo()

ima.AdInfo را برمی‌گرداند:

بازگشت به بالا

کلاس ایما.همراه

فیلدها

apiFramework ، creativeType ، ارتفاع ، ردیابی رویدادها ، آدرس اینترنتی ، عرض

روش ها

createCompanion

حاوی اطلاعاتی در مورد همراهان یک آگهی است.

خواص

نام	تایپ کنید	توضیحات
apiFramework		API برای اجرای این تبلیغ مورد نیاز است، یا اگر در دسترس نباشد نامعتبر است.
creativeType		نشان دهنده نوع خلاقانه است که معمولاً یک mimetype است.
height		ارتفاع همراه بر حسب پیکسل. 0 در صورت در دسترس نبودن
trackingEvents		نقشه ای از ردیابی رویدادها که در آن کلید رویداد است و مقدار آن لیستی از آدرس های اینترنتی برای پینگ روی آن رویداد است.
url		URL برای منبع ثابت این همراه.
width		عرض همدم بر حسب پیکسل. 0 در صورت در دسترس نبودن

createCompanion()

ima.Companion را برمی‌گرداند:

بازگشت به بالا

کلاس ima.CuePoint

فیلدها

پایان ، بازی کرده ، شروع کنید

روش ها

createCuePoint

حاوی اطلاعاتی درباره یک نقطه نشانه است.

خواص

نام	تایپ کنید	توضیحات
end		زمان پایان برای یک نقطه نشانه در ثانیه. این مربوط به یک وقفه تبلیغاتی است.
hasPlayed		یک بولی که نشان می دهد نقطه نشانه قبلاً پخش شده است.
start		زمان شروع برای یک نقطه نشانه در ثانیه. این مربوط به یک وقفه تبلیغاتی است.

createCuePoint()

ima.CuePoint را برمی‌گرداند:

بازگشت به بالا

Class ima. Error

فیلدها

شناسه ، اطلاعات ، نوع

روش ها

ایجاد خطا

در صورت وجود خطا، شیء به کنترل کننده خطا ارسال می شود.

خواص

نام	تایپ کنید	توضیحات
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		کلید API ارائه شده توسط سرور پذیرفته نشد.

بازگشت به بالا

Class ima.Player

روش ها

adBreakEnded ، adBreakStarted ، allVideoComplete ، createPlayer ، loadUrl

adBreakEnded(adBreakInfo)

اختیاری. زمانی که وقفه تبلیغاتی تمام شده بود تماس گرفته شد.

پارامتر	تایپ کنید	توضیحات
adBreakInfo	ima.AdBreakInfo	حاوی اطلاعاتی درباره وقفه تبلیغاتی است.

adBreakStarted(adBreakInfo)

اختیاری. زمانی که وقفه تبلیغاتی شروع شده تماس گرفته می شود.

پارامتر	تایپ کنید	توضیحات
adBreakInfo	ima.AdBreakInfo	حاوی اطلاعاتی درباره وقفه تبلیغاتی است.

allVideoComplete()

اختیاری. وقتی همه ویدیوها کامل شد تماس گرفته شد.

createPlayer()

یک شی IMA Player خالی ایجاد می کند. برای پخش تبلیغات باید تابع loadUrl را پیاده سازی کنید. سایر عملکردها اختیاری هستند.

ima.Player برمی‌گرداند:

loadUrl(streamInfo)

زمانی که پخش کننده باید شروع به پخش آدرس اینترنتی کند، تماس گرفته می شود. برای بارگیری جریان باید این روش را پیاده سازی کنید.

پارامتر	تایپ کنید	توضیحات
streamInfo	ima.StreamInfo	حاوی اطلاعات مورد نیاز برای پخش محتوا است.

بازگشت به بالا

کلاس ima.StreamFormat

فیلدها

DASH ، HLS

قالب جریان را تعریف می کند.

خواص

نام	تایپ کنید	توضیحات
DASH
HLS

بازگشت به بالا

کلاس ima.StreamInfo

فیلدها

قالب , مانیفست , streamId , streamType , زیرنویس

روش ها

createStreamInfo

اطلاعات مربوط به جریان از sdk به پخش کننده منتقل شد.

خواص

نام	تایپ کنید	توضیحات
format		فرمت ویدیو: hls یا خط تیره. در ima.StreamFormat تعریف شده است.
manifest		URL برای جریان.
streamId		یک شناسه منحصر به فرد برای جریان.
streamType		نوع ویدیو: زنده یا درخواستی. در ima.StreamType تعریف شده است.
subtitles		زیرنویس در صورت موجود بودن در غیر این صورت نامعتبر است.

createStreamInfo()

ima.StreamInfo را برمی‌گرداند:

بازگشت به بالا

Class ima.StreamManager

روش ها

addEventListener , createStreamManager , enableInteractiveAds , getContentTime , getCuePoints , getPreviousCuePoint , getStreamTime , loadThirdPartyStream , onMessage , جایگزینAdTagParameters , start

شیء برای مدیریت پخش جریان.

addEventListener(event, callback)

یک شنونده برای رویداد مشخص شده اضافه می کند. برای رویدادهای پشتیبانی شده، ثابت AdEvents را ببینید.

پارامتر	تایپ کنید	توضیحات
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

ima.StreamManager را برمی گرداند:

پارامتر	تایپ کنید	توضیحات
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

پشتیبانی نمی شود. در عوض داده‌ها را مستقیماً از آگهی همراه به RAF ارسال کنید. این در حال حاضر ممنوع است.

getContentTime(streamTime)

زمانی را بر حسب میلی ثانیه برای یک جریان VOD دریافت می‌کند که نشان‌دهنده زمان محتوای بدون تبلیغات است. برای جزئیات بیشتر، سؤالات متداول را ببینید. برای دریافت زمان محتوا برای زمان جاری جاری در -1 عبور کنید.

Returns Integer : زمان محتوا مربوط به زمان پخش داده شده است.

پارامتر	تایپ کنید	توضیحات
streamTime	Integer	زمان در جریان.

getCuePoints()

تمام نقاط نشانه مربوط به تمام وقفه های تبلیغاتی را برمی گرداند. این فقط برای محتوای ویدیوی درخواستی معتبر است که همه وقفه‌های تبلیغاتی از قبل مشخص شده باشند. همه زمان ها نشان دهنده زمان پخش در ثانیه است. برای جریان‌های API Cloud Stitching، ویژگی hasPlayed هر ima.CuePoint همیشه نادرست است.

Returns Object : آرایه ای با تمام نقاط نشانه.

getPreviousCuePoint(time)

نقطه نشانه قبل از این زمان را برمی گرداند. نقطه نشانه نشان دهنده وقفه تبلیغاتی است. همه زمان ها نشان دهنده زمان پخش در ثانیه است.

ima.CuePoint را برمی‌گرداند: یک شی با شروع، پایان و hasPlayed. اگر نقطه نشانه در دسترس نباشد، نامعتبر است.

پارامتر	تایپ کنید	توضیحات
time	Float	زمان جستجو، -1 زمان فعلی را نشان می‌دهد و برای همه جریان‌های دیگر، Invalid .

getStreamTime(contentTime)

زمان پخش جریانی را از زمان محتوا برای VOD در میلی ثانیه دریافت می کند. برای جزئیات بیشتر، سؤالات متداول را ببینید.

Returns Integer : زمان پخش متناظر با زمان محتوای داده شده.

پارامتر	تایپ کنید	توضیحات
contentTime	Integer	زمان مطالب.

loadThirdPartyStream(streamManifest, streamSubtitle)

ابرداده تبلیغات را بارگیری می کند و تابع loadUrl را با داده های streamManifestUrl و streamSubtitle ارائه شده فراخوانی می کند. این تابع فقط زمانی کار می کند که نوع درخواست جریان ima.StreamType.POD_VOD باشد.

پارامتر	تایپ کنید	توضیحات
streamManifest	string	نشانی وب مانیفست جریان با تبلیغات درج شده است.
streamSubtitle	ifArray >|Invalid ifArray >|Invalid	زیرنویس‌ها با جریان مرتبط هستند، یا اگر وجود نداشته باشند، Invalid .

onMessage(msg)

تمام پیام‌های دریافتی از شی Video را مدیریت می‌کند. باید برای هر پیام دریافتی در roMessagePort فراخوانی شود.

پارامتر	تایپ کنید	توضیحات
msg	object	پیام از پورت roVideo.

replaceAdTagParameters(adTagParameters)

جایگزین همه پارامترهای برچسب آگهی می شود تا برای درخواست های تبلیغاتی آتی برای پخش زنده استفاده شود. توجه داشته باشید که این تماس برای جریان های VOD غیرفعال است.

پارامتر	تایپ کنید	توضیحات
adTagParameters	string	پارامترهای برچسب آگهی جدید.

start()

پخش جریان را شروع می کند.

بازگشت به بالا

کلاس ima.StreamRequest

فیلدها

adTagParameters , adUiNode , apiKey , assetKey , authToken , contentSourceId , customAssetKey , قالب , networkCode , player , ppid , streamActivityMonitorId , videoId , videoObject , videoStitcherSession Options

روش ها

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

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

خواص

نام	تایپ کنید	توضیحات
adTagParameters		اختیاری. می‌توانید مجموعه محدودی از پارامترهای برچسب آگهی را در درخواست جریان خود لغو کنید. ارائه پارامترهای هدفمند به جریان شما اطلاعات بیشتری را ارائه می دهد. همچنین می توانید از پارامترهای dai-ot و dai-ov برای ترجیح نوع جریان استفاده کنید. برای اطلاعات بیشتر به لغو پارامترهای نوع جریان مراجعه کنید.
adUiNode		یک گره نمودار صحنه که در آن رابط کاربری تبلیغات نمایش داده می شود. IMA عناصری مانند چرا این آگهی و دکمه های Skip را در طول تبلیغات روی این عنصر قرار می دهد. عنصر باید کل عنصر ویدیو را پوشش دهد.
apiKey		اختیاری. از این کلیدها می توان برای احراز هویت درخواست های جریان استفاده کرد. کلیدهای احراز هویت DAI باید در رابط کاربری DFP تنظیم شوند.
assetKey		برای پخش زنده مورد نیاز است. این برای تعیین اینکه کدام جریان باید پخش شود استفاده می شود. کلید دارایی درخواست پخش جریانی زنده یک شناسه است که در رابط کاربری DFP یافت می شود.
authToken		نشانه مجوز درخواست جریان. به جای کلید API برای مجوز دقیق تر محتوا استفاده می شود. ناشر می‌تواند مجوزهای تک تک جریان‌های محتوا را بر اساس این نشانه کنترل کند.
contentSourceId		برای جریان های درخواستی مورد نیاز است. cmsid از منبع محتوای ویدیوی DFP در رابط کاربری DFP می آید.
customAssetKey		کلید دارایی سفارشی برای تعیین اینکه کدام جریان باید پخش شود استفاده می شود. کلیدهای دارایی سفارشی برای درخواست‌های پخش جریانی سرویس غلاف مورد نیاز است.
format		قالب جریان. پیش‌فرض ima.StreamFormat.HLS است.
networkCode		کد شبکه برای ناشر درخواست کننده جریان. کدهای شبکه برای درخواست‌های پخش جریانی Pod که با createPodLiveStreamRequest یا createPodVodStreamRequest ارائه می‌شوند، مورد نیاز است. این کدها همچنین برای درخواست‌های پخش جریانی Cloud stitching که با createVideoStitcherLiveStreamRequest، createVideoStitcherVodStreamRequest، یا createVideoStitcherVodStreamRequestWithVodConfig، مورد نیاز هستند. این کدها اختیاری هستند و برای درخواست‌های جریان سرویس کامل که با createLiveStreamRequest یا createVodStreamRequest انجام می‌شوند، توصیه می‌شوند. افزودن کد شبکه تنظیمات انتخاب شده در رابط کاربری Ad Manager را اعمال می‌کند، مانند فعال کردن تبلیغات محدود برنامه‌ای. برای سرویس Pod و دوخت ابری، افزودن کد شبکه جریان را مکان‌یابی و پخش می‌کند. برای یافتن کد شبکه، این مقاله را ببینید.
player		پیاده سازی رابط بازیکن.
ppid		منسوخ شده است. از adTagParameters استفاده کنید. اختیاری. یک ناشر DFP Audience شناسه ارائه کرده است .
streamActivityMonitorId		شناسه مورد استفاده برای رفع اشکال جریان با نظارت بر فعالیت جریان. این برای ارائه یک روش راحت برای اجازه دادن به ناشران برای یافتن گزارش جریان در ابزار نظارت بر فعالیت جریان استفاده می‌شود.
videoId		برای جریان های درخواستی مورد نیاز است. شناسه منبع محتوای ویدیویی.
videoObject		شیء ویدیویی (مانند Video roSGNode) که مسئول پخش ویدیو در برنامه مشتری است. این شی برای داده های مختلف مورد نظرسنجی قرار می گیرد تا در زمان بندی مناسب رویدادهای Live HLS ID3 استفاده شود.
videoStitcherSessionOptions		گزینه های جلسه برای تنظیم پارامترهای خاص استیچر ویدیو برای VideoStitcher streamRequests استفاده می شود.

createLiveStreamRequest(assetKey, apiKey, networkCode)

ویژگی های مورد نیاز یک Live StreamRequest را راه اندازی می کند. استفاده از این API باعث می شود که سایر ویژگی های StreamType نادیده گرفته شود. If any required parameters are empty strings, error logging occurs and the API returns a generic StreamRequest , with no properties ignored.

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

پارامتر	تایپ کنید	توضیحات
assetKey	string
apiKey	string	پارامتر به ویژگی ima.StreamRequest برگشتی ima.StreamRequest.apiKey اختصاص داده شده است. اگر کلید API وجود ندارد، یک رشته خالی ارسال کنید.
networkCode	string	کد شبکه برای ناشر درخواست کننده جریان. گنجاندن کد شبکه اختیاری است، اما توصیه می شود.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

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

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

پارامتر	تایپ کنید	توضیحات
customAssetKey	string
networkCode	string
apiKey	string	پارامتر اختیاری اختصاص داده شده به ویژگی ima.StreamRequest بازگشتی ima.StreamRequest.apiKey . پیش فرض رشته خالی است.

createPodVodStreamRequest(networkCode)

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

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

پارامتر	تایپ کنید	توضیحات
networkCode	string	کد شبکه Google Ad Manager

createStreamRequest()

ima.StreamRequest را برمی گرداند: یک شی خالی ima.StreamRequest .

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

ویژگی های مورد نیاز یک Video Stitcher Live StreamRequest را راه اندازی می کند. استفاده از این API باعث می شود که سایر ویژگی های StreamType نادیده گرفته شود. اگر هر یک از پارامترهای مورد نیاز رشته‌های خالی باشد، ثبت خطا رخ می‌دهد و API یک 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 را راه اندازی می کند. استفاده از این API باعث می شود که سایر ویژگی های StreamType نادیده گرفته شود. اگر هر یک از پارامترهای مورد نیاز رشته‌های خالی باشد، ثبت خطا رخ می‌دهد و API یک 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 VOD StreamRequest را با استفاده از vodConfigId ایجاد شده از استیچر ویدیوی ابری، راه اندازی می کند. استفاده از این API باعث می شود که سایر ویژگی های StreamType نادیده گرفته شود. If any required parameters are empty strings, error logging occurs and the API returns a generic StreamRequest , with no properties ignored.

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

پارامتر	تایپ کنید	توضیحات
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

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

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

پارامتر	تایپ کنید	توضیحات
contentSourceId	string
videoId	string
apiKey	string	پارامتر به ویژگی ima.StreamRequest برگشتی ima.StreamRequest.apiKey اختصاص داده شده است. اگر کلید API وجود ندارد، یک رشته خالی ارسال کنید.
networkCode	string	کد شبکه برای ناشر درخواست کننده جریان. گنجاندن کد شبکه اختیاری است، اما توصیه می شود.

بازگشت به بالا

کلاس ima.StreamType

فیلدها

زنده ، VOD

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

خواص

نام	تایپ کنید	توضیحات
LIVE		ویدیو به صورت زنده است.
VOD		ویدیو در صورت درخواست است.

بازگشت به بالا

کلاس ima.WrapperInfo

فیلدها

adId , adSystem , creativeAdId , creativeId , dealId

روش ها

createWrapperInfo

حاوی اطلاعاتی در مورد لفاف است.

خواص

نام	تایپ کنید	توضیحات
adId		شناسه آگهی یا یک رشته خالی در صورت ناشناخته بودن.
adSystem		نام اعلام شده سیستم تبلیغاتی یا و رشته خالی در صورت ناشناخته بودن.
creativeAdId		شناسه آگهی در خلاقیت یا یک رشته خالی در صورت ناشناخته بودن.
creativeId		شناسه خلاقیت یا یک رشته خالی در صورت ناشناخته بودن.
dealId		شناسه معامله یا یک رشته خالی در صورت ناشناخته بودن.

createWrapperInfo()

ima.WrapperInfo را برمی‌گرداند:

بازگشت به بالا