مرجع API PAL SDK Roku

1. 1. ایما
   2. ima.NonceLoader
   3. ima.NonceManager
   4. ima.NonceRequest

کلاس امام

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

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

کلاس ima.NonceLoader

مواد و روش ها

createNonceLoader ، loadNonceManager

کتابخانه دسترسی برنامه‌ریزی شده به ناشران اجازه می‌دهد سیگنال‌هایی را جمع‌آوری کنند که می‌توان از آن برای باز کردن قفل تقاضای AdX استفاده کرد. برای هر درخواست آگهی، در صورت نیاز با تنظیم کننده های مربوطه تماس بگیرید و سپس با loadNonceManager تماس بگیرید. سپس ناشران می توانند NonceManager.getNonce() را فراخوانی کنند تا رشته ای را که باید به درخواست های تبلیغاتی به عنوان مقدار به

createNonceLoader()

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

loadNonceManager(request)

ima.NonceManager را برمی‌گرداند: یک مدیر nonce برای ایجاد یک nonce برای درخواست آگهی.

پارامتر	تایپ کنید	شرح
request	ima.NonceRequest	درخواست حاوی اطلاعاتی در مورد غیر مورد درخواست.

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

کلاس ima.NonceManager

مواد و روش ها

getNonce , poll , sendAdClick , sendAdImpression , sendAdTouch , sendPlaybackEnd , sendPlaybackStart

یک nonce و گزارش رویداد آن را برای یک جلسه پخش محتوا مدیریت می کند. روش‌های چرخه عمر جلسه پخش محتوا، از جمله ima.NonceManager.sendAdClick ، ima.NonceManager.sendAdTouch ، ima.NonceManager.sendPlaybackStart ، و sendPlaybackEnd باید فراخوانی شوند، زیرا این رویدادهای مربوطه برای فعال کردن کسب درآمد برنامه‌ای رخ می‌دهند.

getNonce()

Returns String : nonce تولید شده برای این مدیر هنگام بارگیری. این مقدار برای یک نمونه NonceManager هرگز تغییر نخواهد کرد. این مقدار nonce فقط برای یک جلسه پخش محتوا تا حداکثر مدت زمان 6 ساعت معتبر است.

poll()

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

sendAdClick()

به سرورهای تبلیغات Google اطلاع می‌دهد که یک کلیک روی یک تبلیغ در طول جلسه پخش محتوا انجام شده است.

sendAdImpression()

منسوخ. از ima.NonceManager.sendPlaybackStart و ima.NonceManager.sendPlaybackEnd/code>.


sendAdTouch(touch)

به سرورهای تبلیغات Google اطلاع می‌دهد که در جلسه پخش محتوا، کاربر به غیر از کلیک روی آگهی (به عنوان مثال، پرش، بی‌صدا کردن، ضربه زدن و غیره) روی آن کلیک کرده یا روی آن کلیک کرده است.

پارامتر	تایپ کنید	شرح
touch	roInputEvent|String	کلید دریافت شده از onKeyEvent (در صورت استفاده از SceneGraph)، یا roInputEvent در غیر این صورت.

sendPlaybackEnd()

به سرورهای تبلیغاتی Google اطلاع می دهد که پخش برای جلسه پخش محتوای داده شده به پایان رسیده است. زمانی که پخش به پایان می‌رسد (مثلاً زمانی که پخش‌کننده به پایان پخش می‌رسد، یا زمانی که کاربر در اواسط راه از پخش خارج می‌شود، یا زمانی که کاربر از کانال خارج می‌شود، یا زمانی که به آیتم محتوای بعدی در تنظیمات فهرست پخش می‌رود) این مورد باید فراخوانی شود. . این روش تماس‌های ناهمزمان با سرورهای Google را که در sendPlaybackStart شروع شده‌اند، پایان می‌دهد.

sendPlaybackStart()

به سرورهای تبلیغات Google اطلاع می‌دهد که پخش برای جلسه پخش محتوا آغاز شده است. این باید در "شروع پخش کننده ویدئو" نامیده شود. این ممکن است در پاسخ به یک اقدام آغاز شده توسط کاربر (کلیک برای پخش) یا یک اقدام آغاز شده توسط کانال (پخش خودکار) باشد. این روش تماس‌های ناهمزمان با سرورهای Google را برای جمع‌آوری سیگنال مورد نیاز برای نظارت و شناسایی IVT آغاز می‌کند.

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

کلاس ima.NonceRequest

زمینه های

adWillAutoPlay ، adWillPlayMuted ، پخش مداوم ، توضیحات URL ، کارگردانی شده برای کودک یا سن ناشناس، نمادهای پشتیبانی شده ، ppid ، sessionId ، storageAllowed ، supportedApiFrameworks ، videoHeight ، videoWidth

مواد و روش ها

createNonceRequest

اطلاعاتی که یک ناشر می تواند هنگام درخواست PAL nonce ارائه دهد.

خواص

نام	تایپ کنید	شرح
adWillAutoPlay		اگر آگهی بدون انتظار برای تعامل کاربر پخش شود، روی true تنظیم کنید. اگر آگهی قبل از پخش منتظر تعامل کاربر باشد، روی false تنظیم کنید.
adWillPlayMuted		اگر تبلیغ در حالت بی صدا پخش شود، روی true تنظیم کنید. اگر آگهی بدون صدا پخش شود، روی false تنظیم کنید.
continuousPlayback		اگر پخش کننده قصد دارد به طور مداوم ویدیوهای محتوا را یکی پس از دیگری مانند پخش تلویزیونی یا لیست پخش ویدیو پخش کند، روی true تنظیم کنید. در غیر این صورت روی false تنظیم کنید.
descriptionUrl		نشانی اینترنتی توضیحات محتوایی که طی آن تبلیغ پخش می شود. هر رشته URL توضیحاتی بیش از 500 کاراکتر نادیده گرفته می شود و از nonce حذف می شود.
directedForChildOrUnknownAge		این که آیا درخواست تبلیغ به یک کودک یا کاربر با سن ناشناخته (TFCD یا TFUA) ارسال شود. مقدار پیش فرض نادرست است.
iconsSupported		آیا نمادهای VAST توسط پخش کننده ویدیو پشتیبانی می شوند یا خیر. در Roku این مقدار باید همیشه نادرست باشد.
ppid		ناشر شناسه ارائه کرد. هر PPID بیش از 200 کاراکتر نادیده گرفته می شود. توجه: PPID برای شخصی سازی استفاده نخواهد شد. اگر استفاده از ppid برای شخصی‌سازی مناسب است، آن را به صورت جداگانه در متن واضح در درخواست آگهی خود قرار دهید.
sessionId		شناسه جلسه یک شناسه تصادفی موقت است. این به طور انحصاری برای دربندی فرکانس استفاده می شود. شناسه جلسه باید UUID باشد.
storageAllowed		آیا رضایت ذخیره سازی (رضایت هدف 1) از مشخصات IAB TCF V2 توسط کاربر اعطا شده است یا خیر. پیش فرض ها به درست است.
supportedApiFrameworks		آرایه‌ای از رشته‌ها را می‌پذیرد که نشان‌دهنده چارچوب‌های API است که توسط پخش‌کننده پشتیبانی می‌شود، همانطور که در لیست AdCOM 1.0 "API Frameworks" تعریف شده است https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list- -api-frameworks-. مثال: ["2"،"7"،"9"] نشان می دهد که این پخش کننده از VPAID 2.0، OMID 1.0 و SIMID 1.1 پشتیبانی می کند.
videoHeight		ارتفاع عنصر ویدیوی تبلیغاتی.
videoWidth		عرض عنصر ویدیوی تبلیغاتی.

createNonceRequest()

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

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