Google IMA DAI SDK'sı API'leri

    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 sınıfı

Yöntemler

Dinamik reklam ekleme sırasında bir reklam nesnesini temsil eden sınıf. Bu sınıf, ima.Ad özelliklerinin bir alt kümesini gösterir.

getAdId()


string değerini döndürür:

getAdPodInfo()


google.ima.dai.api.AdPodInfo değerini döndürür:

getAdSystem()


string değerini döndürür:

getAdvertiserName()


string değerini döndürür:

getApiFramework()


string değerini döndürür:

getCompanionAds()


Array.<google.ima.dai.api.CompanionAd> değerini döndürür:

getCreativeAdId()


string değerini döndürür:

getCreativeId()


string değerini döndürür:

getDealId()


string değerini döndürür:

getDescription()


string değerini döndürür:

getDuration()


number değerini döndürür:

getTitle()


string değerini döndürür:

getVastMediaHeight()


number değerini döndürür:

getVastMediaWidth()


number değerini döndürür:

getWrapperAdIds()


Array.<string> değerini döndürür:

getWrapperAdSystems()


Array.<string> değerini döndürür:

getWrapperCreativeIds()


Array.<string> değerini döndürür:

google.ima.dai.api.AdPodInfo sınıfı

Yöntemler

Dinamik reklam ekleme sırasında bir reklam kapsülü bilgi nesnesini temsil eden sınıf. Bu sınıf, ima.AdPodInfo özelliklerinin bir alt kümesini gösterir.

getAdPosition()


number değerini döndürür:

getMaxDuration()


number değerini döndürür:

getPodIndex()


number değerini döndürür:

getTimeOffset()


number değerini döndürür:

getTotalAds()


number değerini döndürür:

google.ima.dai.api.AdprogressData sınıfı

Alanlar

Reklam ilerleme durumu verilerini belirten bir sınıf.

Özellikler

Ad Tür Açıklama
adBreakDuration

adPosition

currentTime

duration

totalAds

google.ima.dai.api.CompanionAd sınıfı

Yöntemler

Dinamik reklam ekleme sırasında tamamlayıcı reklam nesnesini temsil eden bir sınıf. Bu sınıf, ima.CompanionAd özelliklerinin bir alt kümesini gösterir.

getAdSlotId()


string değerini döndürür:

getContent()


string değerini döndürür:

getContentType()


string değerini döndürür:

getHeight()


number değerini döndürür:

getWidth()


number değerini döndürür:

google.ima.dai.api.CuePoint sınıfı

Alanlar

DAI VOD akışlarında bir reklam arasını temsil eden işaret noktasının özelliklerini belirten bir sınıf.

Özellikler

Ad Tür Açıklama
end

Bu işaret noktasının bitiş zamanı.
played

Bu işaret noktası oynatıldıysa.
start

Bu işaret noktasının başlangıç zamanı.

google.ima.dai.api.LiveStreamRequest sınıfı

Alanlar

Canlı yayın isteğinin özelliklerini belirten bir sınıf.

Oluşturucu:
Parametre Tür Açıklama
opt_liveStreamRequest Object

akış isteği özellikleri atanmış olmalıdır.

Özellikler

Ad Tür Açıklama
assetKey

Bu, hangi yayının oynatılması gerektiğini belirlemek için kullanılır. Canlı yayın isteği öğesi anahtarı, Google kullanıcı arayüzünde bulunabilen bir tanımlayıcıdır.

google.ima.dai.api.StreamData sınıfı

Alanlar

Akış verilerini belirtmek için kullanılan bir sınıf.

Özellikler

Ad Tür Açıklama
adProgressData

Şu anda oynatılan reklam için zamanlamayla ilgili bilgiler.
cuepoints

İsteğe bağlı akış için reklam işaret noktaları. Akış ilerledikçe bu ayarlar da değişebilir. Bu alan yalnızca CUEPOINTS_CHANGED AdEvent için etkinlik işleyicide doldurulur.
errorMessage

streamId

subtitles

url

google.ima.dai.api.StreamEvent sınıfı

Yöntemler

Bu etkinlik türü, akış durumu değiştiğinde akış yöneticisi tarafından bildirim olarak belirtilir.

getAd()


google.ima.dai.api.Ad değerini döndürür: reklam bilgilerini içeren nesneyi döndürür.

getStreamData()


google.ima.dai.api.StreamData değerini döndürür: akış bilgilerini içeren nesneyi döndürür.

Enum google.ima.dai.api.StreamEvent.Type

Alanlar

IMA SDK tarafından desteklenen etkinlik türlerinin listesi.

Değerler

Değer Açıklama
AD_BREAK_ENDED

Reklam arası sona erdiğinde tetiklenir.
AD_BREAK_STARTED

Reklam arası başladığında tetiklenir.
AD_PROGRESS

Reklamın ilerleme durumuyla ilgili bir güncelleme olduğunda tetiklenir.
CLICK

Bir reklam oynatılırken tıklama öğesi tıklandığında veya öğeye dokunulduğunda gönderilir.
COMPLETE

Reklam tamamlandığında tetiklenir.
CUEPOINTS_CHANGED

İşaret noktaları değiştiğinde isteğe bağlı yayınlar için gönderilir.
ERROR

Hata oluştuğunda tetiklenir.
FIRST_QUARTILE

Bir reklam ilk çeyreğe ulaştığında tetiklenir.
LOADED

Akış manifesti kullanılabilir olduğunda tetiklenir.
MIDPOINT

Reklam orta noktasına ulaştığında tetiklenir.
STARTED

Reklam başladığında tetiklenir.
STREAM_INITIALIZED

Akış başlatıldığında tetiklenir.
THIRD_QUARTILE

Bir reklam üçüncü çeyreğe ulaştığında tetiklenir.

google.ima.dai.api.StreamManager sınıfı

Yöntemler

Dinamik reklam ekleme akışlarını işliyor. DAI arka ucuyla etkileşimleri yönetir, izleme ping'lerini işler ve akış ile reklam etkinliklerini yayıncıya yönlendirir. Bu yönetici, belirli bir reklamın değil, tüm akışın yöneticisi olduğundan BaseAdsManager'dan devralmaz

Oluşturucu:
Parametre Tür Açıklama
videoElement HTMLVideoElement

Gerçek video oynatıcı öğesi.

contentTimeForStreamTime(streamTime)

Belirli bir akış süresi için reklamsız içerik süresini döndürür. Canlı yayınlar için belirtilen yayın süresini döndürür.

number değerini döndürür: reklamlar kaldırıldıktan sonra belirli yayın süresine karşılık gelen içerik süresi.

Parametre Tür Açıklama
streamTime number

eklenen reklamlar içeren akış süresi (saniye cinsinden).

onTimedMetadata(metadata)

İşlenmiş meta verilerin sözlüğüne ekler. Sözlük, "TXXX" anahtarını ve değer olarak kullanıcı tanımlı meta veri dizesini bekler. Oynatıcınız ham meta veri sağlıyorsa bunun yerine ima.dai.api.StreamManager.processMetadata işlevini çağırın.

Parametre Tür Açıklama
metadata Object

Meta veri sözlüğü.

previousCuePointForStreamTime(streamTime)

Belirli bir akış süresi için önceki işaret noktasını döndürür. Böyle bir işaret noktası yoksa boş sonucunu döndürür. Bu işlev, geri çekme gibi özelliklerin uygulanması için kullanılır ve yayıncı, kullanıcının kullanıcıyı bir reklam arasına döndürmek amacıyla arama yaptığını tespit ettiğinde çağrılır.

google.ima.dai.api.CuePoint değerini döndürür: Belirli bir yayın süresi için önceki işaret noktasını döndürür.

Parametre Tür Açıklama
streamTime number

amaçlanan akış süresini gösterir.

processMetadata(type, data, timestamp)

Canlı yayınlar için zamanlı meta verileri işler. Video oynatıcınız zaman damgalarıyla birlikte ayrıştırılmamış meta veriler sağlıyorsa kullanın. Aksi takdirde ima.dai.api.StreamManager.onTimedMetadata çağrısı yapın.

Parametre Tür Açıklama
type string

Meta verinin adını yazın. "ID3" olmalıdır.
data Uint8Array

Ham etiket verileri. ID3 için etiketin tamamı olmalıdır.
timestamp number

Verilerin işlenmesi gereken zaman.

requestStream(streamRequest)

Sağlanan akış parametrelerini kullanarak bir akışın yüklenmesini ister.

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

akış meta verilerini yükleyecek parametreler içerir.

setClickElement(clickElement)

Reklam tıklama öğesini ayarlar. Bu öğe, bir reklam oynatılırken tıklama veya dokunma alıcısı olarak kullanılır ve geçerli sayfadan başka bir sayfaya gitmeye neden olabilir.

Parametre Tür Açıklama
clickElement Element

reklam tıklaması olarak kullanılan öğe.

streamTimeForContentTime(contentTime)

Belirli bir içerik süresi için reklamlarla birlikte akış süresini döndürür. Canlı yayınlar için belirtilen içerik süresini döndürür.

number değerini döndürür: reklamlar eklendikten sonra, belirtilen içerik süresine karşılık gelen yayın süresidir.

Parametre Tür Açıklama
contentTime number

hiç reklam olmadan içerik süresi (saniye cinsinden).

google.ima.dai.api.StreamRequest sınıfı

Alanlar

Akış isteğinin özelliklerini belirten bir sınıf.

Özellikler

Ad Tür Açıklama
adTagParameters

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 kullanabilirsiniz. Daha fazla bilgi için Akış Varyantı Parametrelerini Geçersiz Kılma bölümüne bakın.
apiKey

Akış isteği API anahtarı. DFP Yönetici Kullanıcı Arayüzü ile yapılandırılır ve yayıncıya içeriklerinin kilidini açması için sağlanır. İçeriğe erişmeye çalışan uygulamaları doğrular.
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ımak için kolay bir yol sağlamak amacıyla kullanılır.

google.ima.dai.api.VODStreamRequest sınıfı

Alanlar

VOD akış isteğinin özelliklerini belirten bir sınıf.

Oluşturucu:
Parametre Tür Açıklama
opt_VODStreamRequest Object

akış isteği özellikleri atanmış olmalıdır.

Özellikler

Ad Tür Açıklama
contentSourceId

Yayıncı içeriği için bir İYS'den alınan benzersiz tanımlayıcı. İsteğe bağlı akışlar için gereklidir.
videoId

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

Sabit google.ima.VERSION

SDK'nın tam sürümünü içeren bir dize.