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

Class google.ima.dai.api.Ad

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 kullanıma sunar.

getAdId()


İadeler string:

getAdPodInfo()


İadeler google.ima.dai.api.AdPodInfo:

getAdSystem()


İadeler string:

getAdvertiserName()


İadeler string:

getApiFramework()


İadeler string:

getCompanionAds()


İadeler Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


İadeler string:

getCreativeId()


İadeler string:

getDealId()


İadeler string:

getDescription()


İadeler string:

getDuration()


İadeler number:

getTitle()


İadeler string:

getVastMediaHeight()


İadeler number:

getVastMediaWidth()


İadeler number:

getWrapperAdIds()


İadeler Array.<string>:

getWrapperAdSystems()


İadeler Array.<string>:

getWrapperCreativeIds()


İadeler Array.<string>:

Class google.ima.dai.api.AdPodInfo

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 kullanıma sunar.

getAdPosition()


İadeler number:

getMaxDuration()


İadeler number:

getPodIndex()


İadeler number:

getTimeOffset()


İadeler number:

getTotalAds()


İadeler number:

Class google.ima.dai.api.AdProgressData

Alanlar

Reklam ilerleme verilerini belirtmek için kullanılan bir sınıf.

Özellikler

Ad Tür Açıklama
adBreakDuration

adPosition

currentTime

duration

totalAds

Class google.ima.dai.api.CompanionAd

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 kullanıma sunar.

getAdSlotId()


İadeler string:

getContent()


İadeler string:

getContentType()


İadeler string:

getHeight()


İadeler number:

getWidth()


İadeler number:

Class google.ima.dai.api.CuePoint

Alanlar

DAI VOD akışlarındaki reklam arasını temsil eden bir işaret noktasının özelliklerini belirtmek için kullanılan sınıf.

Özellikler

Ad Tür Açıklama
end

Bu işaret noktası için bitiş zamanı.
played

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

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

Class google.ima.dai.api.LiveStreamRequest

Alanlar

Canlı yayın isteğinin özelliklerini belirtmek için kullanılan sınıf.

Constructor:
Parametre Tür Açıklama
opt_liveStreamRequest Object

akış isteği özellikleri atanmış bir nesne.

Özellikler

Ad Tür Açıklama
assetKey

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

Class google.ima.dai.api.StreamData

Alanlar

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

Özellikler

Ad Tür Açıklama
adProgressData

Şu anda oynatılan reklamla ilgili zamanlama bilgileri.
cuepoints

İsteğe bağlı akış için reklam işaret noktaları. Bunlar, yayın ilerledikçe değişebilir. Bu yalnızca CUEPOINTS_CHANGED AdEvent için etkinlik işleyicide doldurulur.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Yöntemler

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

getAd()


İadeler google.ima.dai.api.Ad: Reklam bilgilerini içeren iade nesnesi.

getStreamData()


İadeler google.ima.dai.api.StreamData: Akış bilgilerini içeren iade nesnesi.

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

Bir reklamın ilerleme durumunda 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

Bir hata oluştuğunda tetiklenir.
FIRST_QUARTILE

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

Akış manifesti kullanılabildiğinde tetiklenir.
MIDPOINT

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

Bir reklam başladığında tetiklenir.
STREAM_INITIALIZED

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

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

Class google.ima.dai.api.StreamManager

Yöntemler

Dinamik reklam ekleme akışlarını işler. DAI arka ucuyla etkileşimleri yönetir, izleme ping'lerinin yanı sıra yayın ve reklam etkinliklerinin yayıncıya iletilmesini sağlar. Bu yönetici, belirli bir reklamın yöneticisi değil, akışın tamamının yöneticisi olduğundan BaseAdsManager'dan devralınmaz.

Constructor:
Parametre Tür Açıklama
videoElement HTMLVideoElement

Asıl 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 zamanını döndürür.

Döndürülen değernumber: Reklamlar kaldırıldıktan sonra, verilen yayın zamanına karşılık gelen içerik zamanı.

Parametre Tür Açıklama
streamTime number

Eklenen reklamlarla birlikte yayın süresi (saniye cinsinden).

onTimedMetadata(metadata)

İşlenmiş meta verilerin sözlüğünü iletir. Sözlük, değer olarak kullanıcı tanımlı meta veri dizesiyle birlikte "TXXX" anahtarını bekler. Oynatıcınız ham meta veriler 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 yayın zamanı 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, geri sarma gibi özellikleri uygulamak için kullanılır ve yayıncı, kullanıcının reklam arasına dönmek için arama yaptığını algıladığında çağrılır.

Returns google.ima.dai.api.CuePoint: Belirtilen yayın süresinin önceki işaret noktasını döndürür.

Parametre Tür Açıklama
streamTime number

arama yapılan yayın süresi.

processMetadata(type, data, timestamp)

Canlı yayınlar için zamanlanmış 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 işlevini çağırın.

Parametre Tür Açıklama
type string

Meta verilerin türü. "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)

Belirtilen akış parametreleri kullanılarak bir akışın yüklenmesini ister.

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

akış meta verilerini yüklemek için 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 mevcut sayfadan uzaklaşmaya 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 yayın süresini döndürür. Canlı yayınlar için belirtilen içerik zamanını döndürür.

Döndürülen değer number: Reklamlar eklendikten sonra, verilen içerik zamanına karşılık gelen yayın süresi.

Parametre Tür Açıklama
contentTime number

Reklam içermeyen içerik süresi (saniye cinsinden).

Class google.ima.dai.api.StreamRequest

Alanlar

Akış isteğinin özelliklerini belirtmek için kullanılan bir sınıf.

Özellikler

Ad Tür Açıklama
adTagParameters

Akış isteğinizde sınırlı bir grup reklam etiketi parametresini geçersiz kılabilirsiniz. Akışınıza hedefleme parametreleri sağlama başlıklı makalede daha fazla bilgi verilmektedir. Akış varyantı tercihi için dai-ot ve dai-ov parametrelerini kullanabilirsiniz. Daha fazla bilgi için Akış Varyantı Parametrelerini Geçersiz Kılma başlıklı makaleyi inceleyin.
apiKey

Yayın isteği API anahtarı. DFP Yönetici kullanıcı arayüzü üzerinden yapılandırılır ve yayıncıya içeriğinin kilidini açması için sağlanır. İçeriğe erişmeye çalışan uygulamaları doğrular.
streamActivityMonitorId

Akışın akış etkinliği izleyicisiyle hata ayıklaması için kullanılacak kimlik. Bu parametre, yayıncıların akış etkinliği izleme aracında akış günlüğü bulmasını kolaylaştırmak için kullanılır.

Class google.ima.dai.api.VODStreamRequest

Alanlar

VOD akışı isteğinin özelliklerini belirtmek için kullanılan sınıf.

Constructor:
Parametre Tür Açıklama
opt_VODStreamRequest Object

Akış isteği özellikleri atanmış bir nesne.

Özellikler

Ad Tür Açıklama
contentSourceId

Yayıncı içeriğinin CMS'deki benzersiz tanımlayıcısı. İsteğe bağlı akışlar için gereklidir.
videoId

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

Constant google.ima.VERSION

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