APIهای Google IMA DAI SDK

    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

روش ها

کلاسی که یک شی آگهی را در حین درج آگهی پویا نشان می دهد. این کلاس زیرمجموعه ای از ویژگی های 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

روش ها

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

getAdPosition()


number برگشت:

getMaxDuration()


number برگشت:

getPodIndex()


number برگشت:

getTimeOffset()


number برگشت:

getTotalAds()


number برگشت:

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

فیلدها

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

خواص

نام تایپ کنید توضیحات
adBreakDuration

adPosition

currentTime

duration

totalAds

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

روش ها

کلاسی که نشان دهنده یک شیء تبلیغاتی همراه در حین درج آگهی پویا است. این کلاس زیرمجموعه ای از ویژگی های 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

فیلدها

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

سازنده :
پارامتر تایپ کنید توضیحات
opt_liveStreamRequest Object

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

خواص

نام تایپ کنید توضیحات
assetKey

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

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

فیلدها

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

خواص

نام تایپ کنید توضیحات
adProgressData

اطلاعات مربوط به زمان برای آگهی در حال پخش.

cuepoints

نشانه های تبلیغاتی برای جریان درخواستی. اینها ممکن است با پیشرفت جریان تغییر کنند. این فقط در شنونده رویداد برای CUEPOINTS_CHANGED AdEvent پر می شود.

errorMessage

streamId

subtitles

url

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

روش ها

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

getAd()


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

getStreamData()


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

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

فیلدها

فهرست انواع رویدادهای پشتیبانی شده توسط 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

روش ها

جریانهای درج آگهی پویا را مدیریت می کند. تعاملات با باطن 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

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

apiKey

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

streamActivityMonitorId

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

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

فیلدها

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

سازنده :
پارامتر تایپ کنید توضیحات
opt_VODStreamRequest Object

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

خواص

نام تایپ کنید توضیحات
contentSourceId

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

videoId

شناسه منبع محتوای ویدیویی. برای جریان های درخواستی مورد نیاز است.

google.ima.VERSION ثابت

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