Roku için IMA DAI SDK'sı

    1. ima
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Ima sınıfı

Yöntemler

IMA SDK'yı kontrol eden global işlevler.

disableLogging()

SDK günlük kaydını devre dışı bırakır. Günlük kaydı varsayılan olarak açık olacaktır.

getStreamManager()

Varsa bir akış yöneticisi döndürür. Akış yöneticisi henüz müsait değilse Geçersiz değeri döndürülür. Akış yöneticisi oluşturulurken bir hata meydana geldiyse bir hata nesnesi döndürülür.

object değerini döndürür: Akış yöneticisi veya hata nesnesi.

initSdk(settings)

SDK'yı başlatır.

Parametre Tür Açıklama
settings object

İsteğe bağlı IMA ayarları nesnesi.

requestStream(streamRequest)

Bir eşzamansız akış isteği başlatır. Control, bu yöntemi çağırdıktan hemen sonra oynatıcıya geri döner.

object hatası: Hata yoksa geçersiz veya hata döndürür

Parametre Tür Açıklama
streamRequest object

Başa dön

ima.AdBreakInfo Sınıfı

Alanlar

Yöntemler

Reklam arası ile ilgili bilgiler içerir. SDK tarafından etkinlik geri çağırmalarına geçirilir.

Özellikler

Ad Tür Açıklama
adPosition

Reklam arasındaki reklamın dizini. Bağımsız reklamlar için 1 olacaktır.

duration

Saniye cinsinden aranın maksimum süresi veya bilinmiyorsa -1.

podIndex

Canlı yayınlar için her zaman -1 döndürülür. Seç-izle video (VOD) için reklam kapsülünün dizinini döndürür. Videodan önce gösterilen reklam kapsülü için 0 değerini döndürür. Videonun ortasında gösterilen reklamlar için 1, 2, ..., n değerini döndürür. Videodan sonra gösterilen reklam kapsülü için n+1...n+x değerini döndürür. Bu reklam bir kapsülün parçası değilse veya bu kapsül bir oynatma listesinin parçası değilse varsayılan olarak 0 olur.

timeOffset

İçerikteki kapsülün saniye cinsinden konumu. Videodan önce gösterilen reklam 0, videodan sonra gösterilen reklam -1 ve videonun ortasında gösterilen reklamlar kapsülün planlanan zamanını döndürür.

totalAds

Bu reklam arasında yer alan toplam reklam sayısı. Bağımsız reklamlar için 1 olacaktır.

createAdBreakInfo()


ima.AdBreakInfo değerini döndürür:

Başa dön

ima.AdEvent sınıfı

Alanlar

Reklam yöneticisi tarafından tetiklenen etkinlikler.

Özellikler

Ad Tür Açıklama
AD_PERIOD_ENDED

Akış reklamdan veya seçenek listesinden içeriğe her geçişte tetiklenir. Bu, bir reklam ikinci kez oynatıldığında veya bir reklama arandığında bile tetiklenir.

AD_PERIOD_STARTED

Akış içerikten reklama veya seçenek listesine her geçtiğinde tetiklenir. Bu, bir reklam ikinci kez oynatıldığında veya bir reklama arandığında bile tetiklenir.

COMPLETE

Reklamın oynatılması tamamlandığında tetiklenir.

ERROR

Hata oluştuğunda tetiklenir.

FIRST_QUARTILE

Reklam video yer imleci ilk çeyreği geçtiğinde tetiklenir.

MIDPOINT

Reklam video yer imleci orta noktayı geçtiğinde tetiklenir.

PROGRESS

Reklamın ilerleme durumu güncellendikten sonra tetiklenir.

SKIPPABLE_STATE_CHANGED

Reklam atlanabilir durumu değiştiğinde tetiklenir.

SKIPPED

Bir reklam atlandığında tetiklenir.

START

Bir reklam oynatılmaya başladığında tetiklenir.

THIRD_QUARTILE

Reklam video yer imleci üçüncü çeyreği geçtiğinde tetiklenir.

Başa dön

ima.AdInfo Sınıfı

Alanlar

Yöntemler

Reklam hakkında bilgi içerir. SDK tarafından etkinlik geri çağırmalarına geçirilir.

Özellikler

Ad Tür Açıklama
adBreakInfo

Bu reklamın bulunduğu aranın tamamıyla ilgili bilgiler.

adDescription

Reklamın açıklaması.

adId

Reklamın kimliği veya bilinmiyorsa boş dize.

adSystem

Reklam öğesini sağlayan reklam sistemi.

adTitle

Reklamın başlığı.

advertiserName

Sunum yapan tarafça tanımlandığı şekliyle reklamveren adı.

companions

VAST yanıtında belirtilen tamamlayıcı reklamlar.

currentTime

Bir reklamdaki saniye cinsinden geçerli süre veya bilinmiyorsa -1 değeri.

duration

Bu tek reklamın saniye cinsinden süresi veya bilinmiyorsa -1 sayısı.

universalAdIDRegistry

Seçilen reklam öğesinin Evrensel Reklam Kimliğinin kataloga eklendiği kayıt otoritesi web sitesinin URL'sini tanımlamak için kullanılan dize.

universalAdIDValue

Reklam için seçilen reklam öğesinin Evrensel Reklam Kimliği.

wrappers

Bu reklam için sarmalayıcı bilgilerini içeren ima.WrapperInfo dizisi. Sıra, dış sarmalayıcıdan iç sarmalayıcıya doğru olacaktır.

createAdInfo()


ima.AdInfo değerini döndürür:

Başa dön

ima.Companion sınıfı

Alanlar

Yöntemler

Bir reklamın tamamlayıcıları hakkında bilgi içerir.

Özellikler

Ad Tür Açıklama
apiFramework

Bu reklamı yürütmek için gerekli API. Mevcut değilse Geçersiz.

creativeType

Reklam türünü genellikle bir mimetype olarak temsil eder.

height

Tamamlayıcının piksel cinsinden yüksekliği. Kullanılamazsa 0.

trackingEvents

Anahtarın etkinlik olduğu, değerin ise söz konusu etkinlikle ilgili ping'lenecek URL'lerin listesi olduğu izleme etkinliklerinin haritası.

url

Bu tamamlayıcı öğenin statik kaynağının URL'si.

width

Tamamlayıcının piksel cinsinden genişliği. Kullanılamazsa 0.

createCompanion()


ima.Companion değerini döndürür:

Başa dön

ima.CuePoint sınıfı

Alanlar

Yöntemler

Bir işaret noktası hakkında bilgi içerir.

Özellikler

Ad Tür Açıklama
end

İşaret noktasının saniye cinsinden bitiş zamanı. Bu, bir reklam arasına karşılık gelir.

hasPlayed

İşaret noktasının zaten oynatıldığını gösteren bir boole.

start

İşaret noktasının saniye cinsinden başlangıç zamanı. Bu, bir reklam arasına karşılık gelir.

createCuePoint()


ima.CuePoint değerini döndürür:

Başa dön

Sınıf ima.Error

Alanlar

Yöntemler

Bir hata olması durumunda nesne hata işleyiciye iletildi.

Özellikler

Ad Tür Açıklama
id

Hatanın kimliği. Hata kodlarının listesi için ErrorEvent sabitine bakın.

info

Hatayla ilgili ek bilgiler.

type

Bu nesnenin türünü belirtmek için her zaman hata değerine ayarlanır.

createError()


ima.Error değerini döndürür:

Başa dön

ima.ErrorEvent sınıfı

Alanlar

SDK'nın geri gönderebileceği tüm hatalar.

Özellikler

Ad Tür Açıklama
BAD_STREAM_REQUEST

Akış isteği doğru şekilde doldurulamadı.

COULD_NOT_LOAD_STREAM

Akış yüklenemedi.

ERROR

Bilinmeyen bir hata.

INVALID_RESPONSE

Sunucu yanıtı geçerli değildi.

STREAM_API_KEY_NOT_VALID

Sağlanan API anahtarı, sunucu tarafından kabul edilmedi.

Başa dön

Sınıf ima.Player

Yöntemler

adBreakEnded(adBreakInfo)

İsteğe bağlı. Bir reklam arası sona erdiğinde çağrılır.

Parametre Tür Açıklama
adBreakInfo ima.AdBreakInfo

Reklam arasıyla ilgili bilgileri içerir.

adBreakStarted(adBreakInfo)

İsteğe bağlı. Bir reklam arası başladığında çağrılır.

Parametre Tür Açıklama
adBreakInfo ima.AdBreakInfo

Reklam arasıyla ilgili bilgileri içerir.

allVideoComplete()

İsteğe bağlı. Tüm video tamamlandığında çağrılır.

createPlayer()

Boş bir IMA Player nesnesi oluşturur. Reklamları oynatmak için loadUrl işlevini uygulamanız gerekir. Diğer işlevler isteğe bağlıdır.

ima.Player değerini döndürür:

loadUrl(streamInfo)

Oynatıcının bir URL'yi oynatmaya başlaması gerektiğinde çağrılır. Akışı yüklemek için bu yöntemi uygulamanız gerekir.

Parametre Tür Açıklama
streamInfo ima.StreamInfo

İçeriği oynatmak için gereken bilgileri içerir.

Başa dön

ima.StreamFormat Sınıfı

Alanlar

Akışın biçimini tanımlar.

Özellikler

Ad Tür Açıklama
DASH

HLS

Başa dön

ima.StreamInfo Sınıfı

Alanlar

Yöntemler

SDK'dan oynatıcıya akışla ilgili olarak iletilen bilgiler.

Özellikler

Ad Tür Açıklama
format

Videonun biçimi: "hls" veya "kısa çizgi". ima.StreamFormat içinde tanımlanmıştır.

manifest

Akışın URL'si.

streamId

Akış için benzersiz bir kimlik.

streamType

Videonun türü: canlı veya istek üzerine. ima.StreamType'ta tanımlanır.

subtitles

Varsa altyazılar. Değilse geçersiz olur.

createStreamInfo()


ima.StreamInfo değerini döndürür:

Başa dön

ima.StreamManager sınıfı

Yöntemler

Akış oynatmayı yönetme nesnesi.

addEventListener(event, callback)

Belirtilen etkinlik için bir işleyici ekler. Desteklenen etkinlikler için AdEvents sabit değerine bakın.

Parametre Tür Açıklama
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


ima.StreamManager değerini döndürür:

Parametre Tür Açıklama
streamRequest ima.StreamRequest

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Desteklenmiyor. Bunun yerine, verileri tamamlayıcı reklamdan doğrudan RAF'ye aktarın. Bu artık işlem yok.

getContentTime(streamTime)

VOD akışı için milisaniye cinsinden bir zaman alır. Bu süre, içerikte reklamsız olarak geçen süreyi temsil eder. https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq adresine göz atın -1'de geçerli yayın süresi geçişinin içerik süresini öğrenmek için.

Integer değerini döndürür: Belirtilen yayın süresine karşılık gelen içerik süresi.

Parametre Tür Açıklama
streamTime Integer

Akıştaki süre.

getCuePoints()

Tüm reklam aralarına karşılık gelen tüm işaret noktalarını döndürür. Bu, yalnızca tüm reklam aralarının önceden bilindiği seç-izle video içerikleri için geçerlidir. Tüm zamanlar, akış süresini saniye cinsinden gösterir.

Object değerini döndürür: Tüm işaret noktalarını içeren bir dizi.

getPreviousCuePoint(time)

Bu zamandan önceki işaret noktasını döndürür. İşaret noktası bir reklam arasını belirtir. Tüm zamanlar, akış süresini saniye cinsinden gösterir.

ima.CuePoint değerini döndürür: start, end ve hasPlayed değerlerine sahip bir nesnedir. İşaret noktası yoksa "Geçersiz" değerini döndürür.

Parametre Tür Açıklama
time Float

Bakılacak süre; -1 değeri, geçerli saati belirtir.

getStreamTime(contentTime)

VOD için içerik süresinden yayın süresini milisaniye cinsinden alır. https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq adresine göz atın

Integer değerini döndürür: Belirtilen içerik süresine karşılık gelen yayın süresi.

Parametre Tür Açıklama
contentTime Integer

İçeriğin zamanı.

loadThirdPartyStream(streamManifest, streamSubtitle)

Reklam meta verilerini yükler ve sağlanan streamManifestUrl ve streamSubtitle verileriyle loadUrl işlevini çağırır. Bu işlev yalnızca akış isteği türü ima.StreamType.POD_VOD olduğunda çalışır.

Parametre Tür Açıklama
streamManifest string

Reklamların birleştirilmiş akış manifesti URL'si.

streamSubtitle ifArray>|Invalid

Altyazılar akışla ilişkilendirilir veya yoksa Invalid.

onMessage(msg)

Video nesnesinden gelen tüm mesajları işler. roMessagePort'ta alınan her ileti için çağrılmalıdır.

Parametre Tür Açıklama
msg object

roVideo bağlantı noktasından gelen mesaj.

replaceAdTagParameters(adTagParameters)

Canlı yayının yaklaşan reklam isteklerinde kullanılacak tüm reklam etiketi parametrelerini değiştirir. Bu çağrının VOD akışları için işlemsiz olduğunu unutmayın.

Parametre Tür Açıklama
adTagParameters string

Yeni reklam etiketi parametreleri.

start()

Akışın oynatılmasını başlatır.

Başa dön

ima.StreamRequest Sınıfı

Alanlar

Yöntemler

Akış isteğinin özelliklerini belirtmek için kullanılır.

Özellikler

Ad Tür Açıklama
adTagParameters

İsteğe bağlı. Akış isteğinizde sınırlı bir reklam etiketi parametresi grubunu geçersiz kılabilirsiniz. Akışınıza hedefleme parametreleri sağlamak daha fazla bilgi sağlar. Akış varyantı tercihi için dai-ot ve dai-ov parametrelerini de kullanabilirsiniz. Daha fazla bilgi için Akış varyantı parametrelerini geçersiz kılma bölümüne bakın.

adUiNode

Reklam kullanıcı arayüzünün gösterildiği bir sahne grafiği düğümü. IMA, reklamlar sırasında bu öğeye Neden Bu Reklam ve Atla düğmeleri gibi öğeler yerleştirir. Öğe, video öğesinin tamamıyla yer paylaşımlı olmalıdır.

apiKey

İsteğe bağlı. Bu anahtarlar, akış isteklerinin kimliğini doğrulamak için kullanılabilir. DAI kimlik doğrulama anahtarları, DFP kullanıcı arayüzünde ayarlanmalıdır.

assetKey

Canlı yayınlar için gereklidir. Bu, hangi yayının oynatılacağını belirlemek için kullanılır. Canlı yayın isteği öğe anahtarı, DFP kullanıcı arayüzünde bulunan bir tanımlayıcıdır.

authToken

Akış isteği yetkilendirme jetonu. Daha sıkı içerik yetkilendirmesi için API anahtarının yerine kullanılır. Yayıncı, bu jetona göre içerik akışı yetkilendirmelerini ayrı ayrı kontrol edebilir.

contentSourceId

İsteğe bağlı yayınlar için gereklidir. cmsid, DFP kullanıcı arayüzündeki DFP Video İçeriği Kaynağı'ndan gelir.

customAssetKey

Özel öğe anahtarı, hangi akışın oynatılacağını belirlemek için kullanılır. Kapsül yayınlama yayın istekleri için özel öğe anahtarları gerekir.

format

Akışın biçimi. Varsayılan olarak ima.StreamFormat.HLS değerine ayarlanır.

networkCode

Akış isteğinde bulunan yayıncının ağ kodu. Kapsül yayınlama istekleri için ağ kodları gerekir.

player

Oynatıcı arayüzünün uygulaması.

ppid

Kullanımdan kaldırıldı. adTagParameters kullanın. İsteğe bağlı. DFP Audience yayıncı tarafından sağlanan tanımlayıcı.

streamActivityMonitorId

Akış etkinliği izleyicisiyle akışta hata ayıklamak için kullanılacak kimlik. Bu, yayıncıların akış etkinliği izleme aracında bir akış günlüğünü bulmalarına olanak tanıyan rahat bir yol sağlamak için kullanılır.

videoId

İsteğe bağlı yayınlar için gereklidir. Video içeriği kaynağının tanımlayıcısı.

videoObject

İstemci uygulamasında video oynatmadan sorumlu video nesnesi (Video roSGNode gibi). Bu nesne, Canlı HLS ID3 etkinliklerinin doğru zamanlanmasında kullanılmak üzere çeşitli veriler için sorgulanır.

createLiveStreamRequest(assetKey, apiKey)

Canlı StreamRequest için gerekli özellikleri başlatır. Bu API'nin kullanılması, StreamType özelliğine özgü diğer tüm özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlük kaydı oluşur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

Gerekli Live özelliklerine sahip ima.StreamRequest: ima.StreamRequest nesnesini döndürür.

Parametre Tür Açıklama
assetKey string

apiKey string

Döndürülen StreamRequest apiKey mülküne atanacak isteğe bağlı parametre; varsayılan olarak boş dize olur.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Canlı Kapsül ima.StreamRequest için gerekli özellikleri başlatır. Bu API'nin kullanılması, ima.StreamType özelliğine özel diğer tüm özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlük kaydı oluşur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

Zorunlu PodLive özelliklerine sahip ima.StreamRequest nesnesini döndürür: StreamRequest.

Parametre Tür Açıklama
customAssetKey string

networkCode string

apiKey string

Döndürülen ima.StreamRequest ima.StreamRequest.apiKey mülküne atanacak isteğe bağlı parametre; varsayılan olarak boş dize olur.

createPodVodStreamRequest(networkCode)

Üçüncü taraf bir video birleştiriciyle DAI Kapsülü yayınlama kullanılırken VOD akışı kaydetmek için ima.StreamRequest öğesinin gerekli özelliklerini başlatır. Bu işlev, istek türünü ima.StreamType.POD_VOD olarak ayarlar ve eksik veriler için gerekli tüm özellikleri doğrular. Başarısız olan doğrulamalar, hata ayıklama konsoluna bir hata kaydeder.

StreamRequest: bir ima.StreamRequest nesnesi döndürür. Tüm gerekli özellikler belirtilirse istek türü ima.StreamType.POD_VOD olarak ayarlanır.

Parametre Tür Açıklama
networkCode string

Google Ad Manager ağ kodu

createStreamRequest()


ima.StreamRequest değerini döndürür: Boş bir ima.StreamRequest nesnesi.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Video Stitcher Live StreamRequest için gerekli özellikleri başlatır. Bu API'nin kullanılması StreamType özelliğine özel diğer tüm özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlük kaydı oluşur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

Gerekli VideoStitcherLive özelliklerine sahip ima.StreamRequest: ima.StreamRequest nesnesini döndürür.

Parametre Tür Açıklama
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Video Stitcher VOD için gerekli özellikleri başlatır StreamRequest. Bu API'nin kullanılması StreamType özelliğine özel diğer tüm özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlük kaydı oluşur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

Gerekli VideoStitcherVod özelliklerine sahip ima.StreamRequest: ima.StreamRequest nesnesini döndürür.

Parametre Tür Açıklama
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey)

VOD ima.StreamRequest için gerekli özellikleri başlatır. Bu API'nin kullanılması, ima.StreamType özelliğine özgü diğer özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlük kaydı oluşur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

Gerekli VOD özelliklerine sahip ima.StreamRequest: ima.StreamRequest nesnesini döndürür.

Parametre Tür Açıklama
contentSourceId string

videoId string

apiKey string

Döndürülen ima.StreamRequest ima.StreamRequest.apiKey mülküne atanacak isteğe bağlı parametre; varsayılan olarak boş dize olur.

Başa dön

ima.StreamType Sınıfı

Alanlar

Oyuncudan oynatmasının istendiği akışın türünü tanımlar. Videodan önce gösterilen reklamlar ve seç-izle videolar, yayının başlangıcından itibaren oynatılmalıdır.

Özellikler

Ad Tür Açıklama
LIVE

Video yayında.

VOD

Video isteğe bağlıdır.

Başa dön

ima.WrapperInfo Sınıfı

Alanlar

Yöntemler

Sarmalayıcı hakkında bilgi içerir.

Özellikler

Ad Tür Açıklama
adId

Reklamın kimliği veya bilinmiyorsa boş dize.

adSystem

Reklam sisteminin bildirilen adı veya bilinmiyorsa boş dize.

creativeAdId

Reklam öğesindeki reklam kimliği veya bilinmiyorsa boş dize.

creativeId

Reklam öğesinin kimliği veya bilinmiyorsa boş dize.

dealId

Fırsat kimliği veya bilinmiyorsa boş dize.

createWrapperInfo()


ima.WrapperInfo değerini döndürür:

Başa dön