APIهای Google IMA DAI SDK

1. 1. گوگل.ایما.دای.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
   10. google.ima.dai.api.StreamManager
   11. google.ima.dai.api.StreamRequest
   12. google.ima.dai.api.VODStreamRequest
   13. نسخه گوگل ایما

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

روش‌ها

getAdId ، getAdPodInfo ، getAdSystem ، getAdvertiserName ، getApiFramework ، getCompanionAds ، getCreativeAdId ، getCreativeId ، getDealId ، getDescription ، getDuration ، getTitle ، MediaMeast ، GetTitle . 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> :

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

روش‌ها

getAdPosition ، getMaxDuration ، getPodIndex ، getTimeOffset ، getTotalAds

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

روش‌ها

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

فیلدها

کلید دارایی

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

سازنده :

پارامتر	نوع	توضیحات
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()

google.ima.dai.api.Ad را برمی‌گرداند: شیء حاوی اطلاعات تبلیغ را برمی‌گرداند.

getStreamData()

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

نوع رویداد جریانی google.ima.dai.api.Enum

فیلدها

AD_BREAK_ENDED ، AD_BREAK_STARTED ، AD_PROGRESS ، کلیک ، تکمیل ، CUEPOINTS_CHANGED ، خطا ، ربع اول ، بارگذاری شده ، نقطه میانی ، شروع شده ، جریان_مقداردهی_شده ، ربع سوم

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

ارزش‌ها

ارزش	توضیحات
AD_BREAK_ENDED	با پایان یافتن یک تبلیغ، اخراج می‌شود.
AD_BREAK_STARTED	با شروع پخش تبلیغات، فعال می‌شود.
AD_PROGRESS	زمانی فعال می‌شود که به‌روزرسانی در روند پیشرفت یک تبلیغ وجود داشته باشد.
CLICK	زمانی ارسال می‌شود که هنگام پخش تبلیغ، روی عنصر کلیک کلیک شود یا ضربه زده شود.
COMPLETE	وقتی یک تبلیغ کامل شد، اخراج می‌شود.
CUEPOINTS_CHANGED	برای پخش‌های درخواستی، زمانی که نقاط شروع تغییر می‌کنند، ارسال می‌شود.
ERROR	هنگام بروز خطا اجرا می‌شود.
FIRST_QUARTILE	زمانی که یک تبلیغ به چارک اول خود می‌رسد، اجرا می‌شود.
LOADED	زمانی اجرا می‌شود که مانیفست استریم در دسترس باشد.
MIDPOINT	وقتی تبلیغ به نقطه میانی خود می‌رسد، اجرا می‌شود.
STARTED	با شروع تبلیغ، اخراج می‌شود.
STREAM_INITIALIZED	هنگام مقداردهی اولیه جریان (stream) اجرا می‌شود.
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 را برمی‌گرداند. این برای پیاده‌سازی ویژگی‌هایی مانند snap back استفاده می‌شود و زمانی فراخوانی می‌شود که ناشر تشخیص دهد کاربر به دنبال یک وقفه تبلیغاتی بوده است.

google.ima.dai.api.CuePoint را برمی‌گرداند: 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

فیلدها

پارامترهای adTag ، apiKey ، streamActivityMonitorId

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

خواص

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

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

فیلدها

شناسه منبع محتوا ، شناسه ویدیو

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

سازنده :

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

خواص

نام	نوع	توضیحات
contentSourceId		شناسه منحصر به فرد برای محتوای ناشر، از یک سیستم مدیریت محتوا. برای پخش‌های درخواستی مورد نیاز است.
videoId		شناسه منبع محتوای ویدیو. برای پخش آنلاین بر اساس تقاضا مورد نیاز است.

ثابت بودن نسخه گوگل

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