Google IMA DAI SDK APIs

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, getTitle, getVastMediaHeight, getVastMediaWidth, getWrapperAdIds, 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>:

Class 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

Class 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		زمان شروع این نقطه نشانه.

Class 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: شیء را با اطلاعات جاری‌سازی برمی‌گرداند.

Enum 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_INITIALIZED, THIRD_QUARTILE

فهرست انواع رویداد پشتیبانی‌شده توسط «کیت توسعه نرم‌افزار IMA».

مقادیر

مقدار	شرح
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)

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

برمی‌گرداند 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)

زمان جاری‌سازی را با آگهی‌ها برای زمان محتوای داده‌شده برمی‌گرداند. زمان محتوای داده‌شده را برای جاری‌سازی‌های زنده برمی‌گرداند.

Returns number: زمان جاری‌سازی که با زمان محتوای داده‌شده مطابقت دارد وقتی آگهی‌ها درج می‌شوند.

پارامتر	نوع	شرح
contentTime	number	زمان محتوا بدون هیچ آگهی (به ثانیه).

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

فیلدها

adTagParameters, apiKey, streamActivityMonitorId

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

مشخصات

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

Class google.ima.dai.api.VODStreamRequest

فیلدها

contentSourceId، videoId

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

سازنده:

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

مشخصات

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

ثابت google.ima.VERSION

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