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

Sınıf ima'sı

Yöntemler

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

disableLogging()

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

getStreamManager()

Varsa bir akış yöneticisi döndürür. Akış yöneticisi henüz kullanılabilir değilse Geçersiz değeri döndürülür. Akış yöneticisi oluşturulurken bir hata meydana geldiyse 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)

Eş zamansız akış isteği başlatır Kontrol, bu yöntem çağrıldıktan sonra oynatıcıya hemen geri döner.

object değerini döndürür: hata veya hata yoksa geçersizdir

Parametre Tür Açıklama
streamRequest object

Başa dön

ima.AdBreakInfo Sınıfı

Alanlar

Yöntemler

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

Özellikler

Ad Tür Açıklama
adPosition

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

duration

Aranın saniye cinsinden maksimum süresi veya bilinmiyorsa -1.

podIndex

Canlı yayınlar için her zaman -1 değerini döndürü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 değerine ayarlanır.

timeOffset

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

totalAds

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

createAdBreakInfo()


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

Başa dön

Sınıf ima.AdEvent

Alanlar

Reklam yöneticisi tarafından tetiklenen etkinlikler.

Özellikler

Ad Tür Açıklama
AD_PERIOD_ENDED

Akışın reklam veya seçenek listesinden içeriğe her geçişinde tetiklenir. Bu, bir reklam ikinci kez oynatıldığında veya bir reklamı ararken bile tetiklenir.

AD_PERIOD_STARTED

İçerikten reklama veya seçenek listesine geçiş her yapıldığında tetiklenir. Bu, bir reklam ikinci kez oynatıldığında veya bir reklamı ararken bile tetiklenir.

COMPLETE

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

ERROR

Bir hata oluştuğunda tetiklenir.

FIRST_QUARTILE

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

ICON_FALLBACK_IMAGE_CLOSED

Kullanıcı, simge yedek resim iletişim kutusunu kapattığında tetiklenir.

ICON_FALLBACK_IMAGE_SHOWN

Simgenin yedek resmi gösterildiğinde tetiklenir.

MIDPOINT

Reklam video yer imleci orta noktayı aştığında tetiklenir.

PROGRESS

Bir reklamın ilerleme durumuyla ilgili güncelleme olduğunda tetiklenir.

SKIPPABLE_STATE_CHANGED

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

SKIPPED

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

Sınıf ima.AdInfo

Alanlar

Yöntemler

Reklam hakkında bilgiler içerir. SDK tarafından etkinlik geri çağırmalarına iletilir.

Özellikler

Ad Tür Açıklama
adBreakInfo

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

adDescription

Reklamın açıklaması.

adId

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

adSystem

Reklam öğesini sağlayan reklam sistemi.

adTitle

Reklamın başlığı.

advertiserName

Reklamı sunan tarafın tanımladığı reklamveren adı.

companions

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

currentTime

Bir reklamdaki saniye cinsinden geçerli zaman veya bilinmiyorsa -1 cinsinden belirtilir.

duration

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

skipOffset

Reklamın atlanabilir hale gelmesi veya bilinmiyorsa -1 olması için gereken süre.

universalAdIDRegistry

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

universalAdIDValue

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

wrappers

Bu reklama ait sarmalayıcı bilgilerini içeren bir ima.WrapperInfo dizisi. Sıra, dış sarmalayıcıdan iç sarmalayıcıya olacaktır.

createAdInfo()


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

Başa dön

Class ima.Companion

Alanlar

Yöntemler

Bir reklamın tamamlayıcılarıyla ilgili bilgileri içerir.

Özellikler

Ad Tür Açıklama
apiFramework

Bu reklamı yürütmek için gereken API; mevcut değilse geçersiz.

creativeType

Reklam öğesi türünü genellikle bir mime türünü gösterir.

height

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

trackingEvents

Önemlinin etkinlik olduğu, değerin ise bu etkinliğe pinglenecek URL'lerin bir listesi olduğu izleme etkinliklerine ait bir harita.

url

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

width

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

createCompanion()


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

Başa dön

Sınıf ima.CuePoint

Alanlar

Yöntemler

İşaret noktası hakkında bilgiler içerir.

Özellikler

Ad Tür Açıklama
end

Bir işaret noktasının bitiş zamanı (saniye cinsinden). Bu bir reklam arasına karşılık gelir.

hasPlayed

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

start

Bir iş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

ima.Error sınıfı

Alanlar

Yöntemler

Hata olması durumunda hata işleyiciye nesne 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 ayarlayın.

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 doldurulmadı.

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ı. 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ı. 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ı yapılır.

createPlayer()

Boş bir IMA Player nesnesi oluşturur. Reklam 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

DASH ve HLS

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 tire. ima.StreamFormat'da tanımlanır.

manifest

Akışın URL'si.

streamId

Akış için benzersiz bir kimlik.

streamType

Videonun türü: canlı veya istek üzerine. ima.StreamType içinde tanımlanır.

subtitles

Varsa altyazılar. Değilse geçersizdir.

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 sabitine 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'a iletin. Bu artık işlem değil.

getContentTime(streamTime)

VOD akışı için, içerikte reklam içermeyen süreyi milisaniye cinsinden temsil eder. Şu adrese göz atın: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq -1 içindeki mevcut akış süresinin içerik süresini öğrenmek için.

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

Parametre Tür Açıklama
streamTime Integer

Akıştaki zaman.

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çeriği için geçerlidir. Tüm süreler, saniye cinsinden akış süresini temsil eder.

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ı, reklam arasını gösterir. Tüm süreler, saniye cinsinden akış süresini temsil eder.

ima.CuePoint değerini döndürür: Start, end ve hasPlayed özelliklerine sahip bir nesne. Döndürme İşaret noktası yoksa geçersizdir.

Parametre Tür Açıklama
time Float

Arama saati, -1 geçerli saati gösterir.

getStreamTime(contentTime)

VOD için içerik süresinden akış süresini milisaniye cinsinden alır. https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
sayfasını inceleyin.
Integer değerini döndürür: Belirtilen içerik zamanına karşılık gelen akış 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ış manifest URL'si.

streamSubtitle ifArray>|Invalid

Altyazılar akışla ilişkilendirilir. Altyazılar akışla ilişkilendirilirse 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)

Bir canlı yayına yönelik yaklaşan reklam istekleri için kullanılacak tüm reklam etiketi parametrelerini değiştirir. Bu görüşmenin VOD akışları için işlemsiz olduğunu unutmayın.

Parametre Tür Açıklama
adTagParameters string

Yeni reklam etiketi parametreleri.

start()

Akışı oynatmayı 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ğlayın, 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 gibi öğeleri yerleştirir. Öğe, video öğesinin tamamı ile 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ılması gerektiğini 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 ayrı ayrı içerik akışı yetkilendirmelerini kontrol edebilir.

contentSourceId

İsteğe bağlı canlı 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ılması gerektiğini belirlemek için kullanılır. Kapsül yayınlama akış 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 akış istekleri için ağ kodları gerekir.

player

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

ppid

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

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üğü bulmasına olanak tanıyan pratik bir yol sunmak için kullanılır.

videoId

İsteğe bağlı canlı 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). Canlı HLS ID3 etkinliklerinin doğru zamanlamasında kullanılacak çeşitli verilerin kullanılması için bu nesne yoklanır.

videoStitcherSessionOptions

Oturum seçenekleri, VideoStitcher akış İstekleri için video sabitleme parametrelerini ayarlamak üzere kullanılır.

createLiveStreamRequest(assetKey, apiKey)

Canlı StreamRequest öğesinin gerekli özelliklerini başlatır. Bu API'nin kullanılması, StreamType ürününe özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametreler boş dizelerse hata günlük kaydı gerçekleşir ve API, hiçbir özellik yoksayılmadan genel bir StreamRequest döndürür.

Gerekli Canlı ö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 özelliğine atanacak isteğe bağlı parametre; varsayılan olarak boş dize kullanılır.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Canlı Kapsül ima.StreamRequest özelliklerini başlatır. Bu API'nin kullanılması, ima.StreamType ürününe özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametreler boş dizelerse hata günlük kaydı gerçekleşir ve API, hiçbir özellik yoksayılmadan genel bir StreamRequest döndürür.

Gerekli PodLive özelliklerine sahip StreamRequest: ima.StreamRequest nesneyi döndürür.

Parametre Tür Açıklama
customAssetKey string

networkCode string

apiKey string

Döndürülen ima.StreamRequest ima.StreamRequest.apiKey özelliğine atanacak isteğe bağlı parametre; varsayılan olarak boş dize kullanılır.

createPodVodStreamRequest(networkCode)

Üçüncü taraf video birleştiriciyle DAI Kapsül yayınlama kullanılırken VOD akışı kaydetmek için ima.StreamRequest 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 doğrulamalar, hata ayıklama konsoluna hata kaydeder.

StreamRequest: bir ima.StreamRequest nesnesini döndürür. Gerekli tüm ö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: Boş ima.StreamRequest nesnesini döndürür.

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

Canlı Video Birleştiricisi'nin gerekli özelliklerini başlatır StreamRequest. Bu API'nin kullanılması, StreamType'e özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametreler boş dizelerse hata günlük kaydı gerçekleşir ve API, hiçbir özellik yoksayılmadan 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)

Seç-izle video Stitcher için gerekli özellikleri başlatır StreamRequest. Bu API'nin kullanılması, StreamType'e özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametreler boş dizelerse hata günlük kaydı gerçekleşir ve API, hiçbir özellik yoksayılmadan 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

CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Bulut video birleştiriciden oluşturulan vodConfigId öğesini kullanarak bir Video Stitcher VOD StreamRequest için gerekli özellikleri başlatır. Bu API'nin kullanılması, StreamType ürününe özgü diğer özelliklerin yok sayılmasına neden olur. Gerekli parametreler boş dizelerse hata günlük kaydı gerçekleşir ve API, hiçbir özellik yoksayılmadan 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
vodConfigId string

networkCode string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Seç-izle videonun gerekli özelliklerini (ima.StreamRequest) başlatır. Bu API'nin kullanılması, ima.StreamType ürününe özgü diğer özelliklerin yok sayılmasına neden olur. Gerekli parametreler boş dizelerse hata günlük kaydı gerçekleşir ve API, hiçbir özellik yoksayılmadan 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 özelliğine atanacak isteğe bağlı parametre; varsayılan olarak boş dize kullanılır.

Başa dön

ima.StreamType Sınıfı

Alanlar

Oynatıcıdan oynatması istenen akışın türünü tanımlar. Videodan önce gösterilen reklamlar ve VOD, yayının başından itibaren oynatılmalıdır.

Özellikler

Ad Tür Açıklama
LIVE

Video yayında.

VOD

Video istek üzerinedir.

Başa dön

Sınıf ima.WrapperInfo

Alanlar

Yöntemler

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

Özellikler

Ad Tür Açıklama
adId

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

adSystem

Reklam sisteminin bildirilen adı veya bilinmiyorsa boş dize.

creativeAdId

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

creativeId

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

dealId

Bilinmiyorsa anlaşma kimliği veya boş dize.

createWrapperInfo()


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

Başa dön