APIهای Google IMA DAI SDK

1. 1. google.ima.dai.api.Ad
   2. google.ima.dai.api.AdPodInfo
   3. google.ima.dai.api.AdProgressData
   4. google.ima.dai.api.CompanionAd
   5. google.ima.dai.api.CuePoint
   6. google.ima.dai.api.LiveStreamRequest
   7. google.ima.dai.api.StreamData
   8. google.ima.dai.api.StreamEvent
   9. google.ima.dai.api.StreamEvent.Type
   10. google.ima.dai.api.StreamManager
   11. google.ima.dai.api.StreamRequest
   12. google.ima.dai.api.VODStreamRequest
   13. google.ima.VERSION

کلاس google.ima.dai.api.Ad

مواد و روش ها

getAdId ، getAdPodInfo ، getAdSystem ، getAdvertiserName ، getApiFramework ، getCompanionAds ، getCreativeAdId ، getCreativeId ، getDealId ، getDescription ، getDuration ، getTitleMediaVMeaids ، getCreativeAdId ، getWrapperAdSystems ، getWrapperCreativeIds

کلاسی که یک شی آگهی را در حین درج آگهی پویا نشان می دهد. این کلاس زیرمجموعه ای از ویژگی های ima.Ad را نشان می دهد.

getAdId()

string را برمی گرداند:

getAdPodInfo()

google.ima.dai.api.AdPodInfo را برمی‌گرداند:

getAdSystem()

string را برمی گرداند:

getAdvertiserName()

string را برمی گرداند:

getApiFramework()

string را برمی گرداند:

getCompanionAds()

Array.< google.ima.dai.api.CompanionAd > :

getCreativeAdId()

string را برمی گرداند:

getCreativeId()

string را برمی گرداند:

getDealId()

string را برمی گرداند:

getDescription()

string را برمی گرداند:

getDuration()

number برگشت:

getTitle()

string را برمی گرداند:

getVastMediaHeight()

number برگشت:

getVastMediaWidth()

number برگشت:

getWrapperAdIds()

Array.<string> :

getWrapperAdSystems()

Array.<string> :

getWrapperCreativeIds()

Array.<string> :

کلاس google.ima.dai.api.AdPodInfo

مواد و روش ها

getAdPosition ، getMaxDuration ، getPodIndex ، getTimeOffset ، getTotalAds

کلاسی که نشان دهنده یک شی اطلاعات آگهی در حین درج آگهی پویا است. این کلاس زیر مجموعه ای از ویژگی های ima.AdPodInfo را نشان می دهد.

getAdPosition()

number برگشت:

getMaxDuration()

number برگشت:

getPodIndex()

number برگشت:

getTimeOffset()

number برگشت:

getTotalAds()

number برگشت:

کلاس google.ima.dai.api.AdProgressData

زمینه های

adBreakDuration , adPosition , currentTime , duration , totalAds

کلاسی برای تعیین داده های پیشرفت تبلیغات.

خواص

نام	تایپ کنید	شرح
adBreakDuration
adPosition
currentTime
duration
totalAds

کلاس google.ima.dai.api.CompanionAd

مواد و روش ها

getAdSlotId ، getContent ، getContentType ، getHeight ، getWidth

کلاسی که نشان دهنده یک شیء تبلیغاتی همراه در حین درج آگهی پویا است. این کلاس زیرمجموعه ای از ویژگی های ima.CompanionAd را نشان می دهد.

getAdSlotId()

string را برمی گرداند:

getContent()

string را برمی گرداند:

getContentType()

string را برمی گرداند:

getHeight()

number برگشت:

getWidth()

number برگشت:

کلاس google.ima.dai.api.CuePoint

زمینه های

پایان ، بازی ، شروع

یک کلاس برای مشخص کردن ویژگی‌های یک نقطه نشانه، که نشان‌دهنده یک وقفه تبلیغاتی در جریان‌های DAI VOD است.

خواص

نام	تایپ کنید	شرح
end		زمان پایان برای این نقطه نشانه.
played		اگر این نقطه نشانه بازی شده باشد.
start		زمان شروع این نقطه نشانه.

کلاس google.ima.dai.api.LiveStreamRequest

زمینه های

assetKey

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

سازنده :

پارامتر	تایپ کنید	شرح
opt_liveStreamRequest	Object	شی ای که قبلاً دارای ویژگی های درخواست جریان اختصاص داده شده است.

خواص

نام	تایپ کنید	شرح
assetKey		این برای تعیین اینکه کدام جریان باید پخش شود استفاده می شود. کلید دارایی درخواست پخش جریانی زنده یک شناسه است که در رابط کاربری DFP یافت می شود.

کلاس google.ima.dai.api.StreamData

زمینه های

adProgressData , cuepoints , errorMessage , streamId , subtitles , url

یک کلاس برای تعیین داده های جریان.

خواص

نام	تایپ کنید	شرح
adProgressData		اطلاعات مربوط به زمان برای آگهی در حال پخش.
cuepoints		نشانه های تبلیغاتی برای جریان درخواستی. اینها ممکن است با پیشرفت جریان تغییر کنند. این فقط در شنونده رویداد برای CUEPOINTS_CHANGED AdEvent پر می شود.
errorMessage
streamId
subtitles
url

کلاس google.ima.dai.api.StreamEvent

مواد و روش ها

getAd ، getStreamData

این نوع رویداد توسط مدیر جریان به عنوان یک اعلان هنگام تغییر وضعیت جریان مطرح می شود.

getAd()

google.ima.dai.api.Ad را برمی گرداند: شیء را با اطلاعات آگهی برمی گرداند.

getStreamData()

google.ima.dai.api.StreamData را برمی گرداند: شیء را با اطلاعات جریان برمی گرداند.

فهرست google.ima.dai.api.StreamEvent.Type

زمینه های

AD_BREAK_ENDED , AD_BREAK_STARTED , AD_PROGRESS , CLICK , COMPLETE , CUEPOINTS_CHANGED , ERROR , FIRST_QUARTILE , LOADED , MIDPOINT , STARTED , STREAM_INITIALIZEDQUARTI

فهرست انواع رویدادهای پشتیبانی شده توسط IMA SDK.

ارزش های

ارزش	شرح
AD_BREAK_ENDED	زمانی که وقفه تبلیغاتی به پایان می رسد فعال می شود.
AD_BREAK_STARTED	با شروع وقفه تبلیغاتی فعال می شود.
AD_PROGRESS	هنگامی که به‌روزرسانی پیشرفت آگهی وجود دارد، فعال می‌شود.
CLICK	هنگامی که در حین پخش یک تبلیغ روی عنصر کلیک کلیک یا ضربه زده می شود، ارسال می شود.
COMPLETE	هنگامی که یک تبلیغ کامل می شود فعال می شود.
CUEPOINTS_CHANGED	هنگامی که نقاط نشانه تغییر می کنند، برای جریان های درخواستی ارسال می شود.
ERROR	هنگامی که خطایی رخ می دهد فعال می شود.
FIRST_QUARTILE	هنگامی که یک تبلیغ به ربع اول خود می رسد فعال می شود.
LOADED	وقتی مانیفست جریان در دسترس باشد فعال می شود.
MIDPOINT	هنگامی که یک تبلیغ به نقطه میانی خود می رسد، فعال می شود.
STARTED	با شروع یک تبلیغ فعال می شود.
STREAM_INITIALIZED	هنگامی که جریان مقداردهی اولیه می شود فعال می شود.
THIRD_QUARTILE	زمانی که یک تبلیغ به ربع سوم خود می رسد فعال می شود.

کلاس google.ima.dai.api.StreamManager

مواد و روش ها

contentTimeForStreamTime , onTimedMetadata , previousCuePointForStreamTime , processMetadata , requestStream , setClickElement , streamTimeForContentTime

جریانهای درج آگهی پویا را مدیریت می کند. تعاملات با باطن DAI را مدیریت می کند و پینگ های ردیابی و همچنین انتقال جریان و رویدادهای تبلیغاتی را به ناشر انجام می دهد. این مدیر از BaseAdsManager ارث نمی برد زیرا مدیر یک تبلیغ خاص نیست، بلکه مدیر کل جریان است.

سازنده :

پارامتر	تایپ کنید	شرح
videoElement	HTMLVideoElement	عنصر پخش کننده ویدیو واقعی.

contentTimeForStreamTime(streamTime)

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

number بازگشت: زمان محتوایی که با زمان پخش جریانی داده شده پس از حذف تبلیغات مطابقت دارد.

پارامتر	تایپ کنید	شرح
streamTime	number	زمان پخش با تبلیغات درج شده (در ثانیه).

onTimedMetadata(metadata)

در فرهنگ لغت فراداده پردازش شده عبور می کند. فرهنگ لغت از کلید "TXXX" با رشته فوق داده تعریف شده توسط کاربر به عنوان مقدار انتظار دارد. اگر پخش کننده شما متادیتای خام ارائه می کند، به جای آن با ima.dai.api.StreamManager.processMetadata تماس بگیرید.

پارامتر	تایپ کنید	شرح
metadata	Object	فرهنگ لغت فراداده.

previousCuePointForStreamTime(streamTime)

نقطه نشانه قبلی را برای زمان پخش داده شده برمی گرداند. اگر چنین نقطه نشانه ای وجود نداشته باشد، باطل برمی گردد. این برای پیاده‌سازی ویژگی‌هایی مانند snap back استفاده می‌شود و زمانی فراخوانی می‌شود که ناشر تشخیص دهد که کاربر برای بازگرداندن کاربر به یک وقفه تبلیغاتی به دنبال آن بوده است.

google.ima.dai.api.CuePoint را برمی گرداند: نقطه نشانه قبلی برای زمان پخش داده شده.

پارامتر	تایپ کنید	شرح
streamTime	number	زمان پخشی که به دنبال آن بود.

processMetadata(type, data, timestamp)

فراداده های زمان بندی شده را برای پخش جریانی زنده پردازش می کند. اگر پخش‌کننده ویدیوی شما متادیتای تجزیه‌نشده را همراه با مُهرهای زمانی ارائه می‌دهد، استفاده کنید، در غیر این صورت، با ima.dai.api.StreamManager.onTimedMetadata تماس بگیرید.

پارامتر	تایپ کنید	شرح
type	string	برای ابرداده تایپ کنید. باید 'ID3' باشد.
data	Uint8Array	داده های برچسب خام برای ID3، باید کل تگ باشد.
timestamp	number	زمانی که داده ها باید پردازش شوند.

requestStream(streamRequest)

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

پارامتر	تایپ کنید	شرح
streamRequest	google.ima.dai.api.StreamRequest	شامل پارامترهایی برای بارگیری فراداده جریان است.

setClickElement(clickElement)

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

پارامتر	تایپ کنید	شرح
clickElement	Element	عنصری که به عنوان کلیک روی تبلیغ استفاده می شود.

streamTimeForContentTime(contentTime)

زمان پخش جریانی را با تبلیغات برای یک زمان محتوای معین برمی گرداند. زمان محتوای داده شده را برای پخش جریانی زنده برمی گرداند.

number بازگشت: زمان پخش جریانی که با زمان محتوای داده شده پس از درج تبلیغات مطابقت دارد.

پارامتر	تایپ کنید	شرح
contentTime	number	زمان محتوا بدون تبلیغات (در ثانیه).

کلاس google.ima.dai.api.StreamRequest

زمینه های

adTagParameters ، apiKey ، streamActivityMonitorId

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

خواص

نام	تایپ کنید	شرح
adTagParameters		می‌توانید مجموعه محدودی از پارامترهای برچسب آگهی را در درخواست جریان خود لغو کنید. ارائه پارامترهای هدفمند به جریان شما اطلاعات بیشتری را ارائه می دهد. می‌توانید از پارامترهای dai-ot و dai-ov برای ترجیح نوع جریان استفاده کنید. برای اطلاعات بیشتر به لغو پارامترهای متغیر جریان مراجعه کنید.
apiKey		کلید API درخواست جریان. از طریق رابط کاربری مدیریت DFP پیکربندی شده و در اختیار ناشر قرار می‌گیرد تا قفل محتوای خود را باز کند. برنامه هایی را که سعی در دسترسی به محتوا دارند تأیید می کند.
streamActivityMonitorId		شناسه مورد استفاده برای رفع اشکال جریان با نظارت بر فعالیت جریان. این برای ارائه یک روش راحت برای اجازه دادن به ناشران برای یافتن گزارش جریان در ابزار نظارت بر فعالیت جریان استفاده می‌شود.

کلاس google.ima.dai.api.VODStreamRequest

زمینه های

ContentSourceId , videoId

کلاسی برای مشخص کردن خصوصیات درخواست جریان VOD.

سازنده :

پارامتر	تایپ کنید	شرح
opt_VODStreamRequest	Object	شی ای که قبلاً دارای ویژگی های درخواست جریان اختصاص داده شده است.

خواص

نام	تایپ کنید	شرح
contentSourceId		شناسه منحصر به فرد برای محتوای ناشر، از یک CMS. برای جریان های درخواستی مورد نیاز است.
videoId		شناسه منبع محتوای ویدیویی. برای جریان های درخواستی مورد نیاز است.

google.ima.VERSION ثابت

رشته ای حاوی نسخه کامل SDK.