Google IMA DAI SDK'sı API'leri

1. 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

Sınıf google.ima.dai.api.Ad

Yöntemler

getAdId, getAdPodInfo, getAdSystem, getAdvertiserName, getApiFramework, getCompanionAds, getCreativeAdId, getCreativeId, getDealId, getDescription, getDuration, getTitle, getVastMediaHeight, getVastMediaWidth, getWrapperAdIds, getWrapperAdSystems, getWrapperCreativeIds

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

getAdId()

string döndürür:

getAdPodInfo()

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

getAdSystem()

string döndürür:

getAdvertiserName()

string döndürür:

getApiFramework()

string döndürür:

getCompanionAds()

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

getCreativeAdId()

string döndürür:

getCreativeId()

string döndürür:

getDealId()

string döndürür:

getDescription()

string döndürür:

getDuration()

number döndürür:

getTitle()

string döndürür:

getVastMediaHeight()

number döndürür:

getVastMediaWidth()

number döndürür:

getWrapperAdIds()

Array.<string> döndürür:

getWrapperAdSystems()

Array.<string> döndürür:

getWrapperCreativeIds()

Array.<string> döndürür:

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

Yöntemler

getAdPosition, getMaxDuration, getPodIndex, getTimeOffset, getTotalAds

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

getAdPosition()

number döndürür:

getMaxDuration()

number döndürür:

getPodIndex()

number döndürür:

getTimeOffset()

number döndürür:

getTotalAds()

number döndürür:

Sınıf google.ima.dai.api.AdProgressData

Alanlar

adBreakDuration, adPosition, currentTime, duration, totalAds

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

Özellikler

Ad	Tür	Açıklama
adBreakDuration
adPosition
currentTime
duration
totalAds

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

Yöntemler

getAdSlotId, getContent, getContentType, getHeight, getWidth

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

getAdSlotId()

string döndürür:

getContent()

string döndürür:

getContentType()

string döndürür:

getHeight()

number döndürür:

getWidth()

number döndürür:

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

Alanlar

end, played, start

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

Özellikler

Ad	Tür	Açıklama
end		Bu işaret noktasının bitiş zamanı.
played		Bu işaret noktasının çalınıp çalınmadığı.
start		Bu işaret noktasının başlangıç zamanı.

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

Alanlar

assetKey

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

Oluşturucu:

Parametre	Tür	Açıklama
opt_liveStreamRequest	Object	zaten akışı istek özellikleri atanmış bir nesneye

Ö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 öğe anahtarı, DFP kullanıcı arayüzünde bulunabilen bir tanımlayıcıdır.

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

Alanlar

adProgressData, cuepoints, errorMessage, streamId, subtitles, url

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ı yayın için reklam işaret noktaları. Bu bilgiler, yayın ilerledikçe değişebilir. Bu, yalnızca CUEPOINTS_CHANGED AdEvent etkinliği işleyicisinde doldurulur.
errorMessage
streamId
subtitles
url

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

Yöntemler

getAd, getStreamData

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

getAd()

google.ima.dai.api.Ad döndürür: Reklam bilgilerini içeren dönüş nesnesi.

getStreamData()

google.ima.dai.api.StreamData döndürür: Akış bilgilerini içeren nesne döndürülür.

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

Alanlar

AD_BREAK_ENDED, AD_BREAK_STARTED, AD_PROGRESS, CLICK, COMPLETE, CUEPOINTS_CHANGED, ERROR, FIRST_QUARTILE, LOADED, MIDPOINT, STARTED, STREAM_INITIALIZED, THIRD_QUARTILE

IMA SDK'sı 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	Bir reklam tamamlandığında tetiklenir.
CUEPOINTS_CHANGED	İşaretçi noktaları değiştiğinde isteğe bağlı yayınlar için gönderilir.
ERROR	Bir hata oluştuğunda tetiklenir.
FIRST_QUARTILE	Bir reklam ilk çeyreğindeki gösterim sayısına ulaştığında tetiklenir.
LOADED	Akış manifesti kullanılabilir olduğunda tetiklenir.
MIDPOINT	Bir reklamın orta noktasına ulaştığında tetiklenir.
STARTED	Bir reklam başladığında tetiklenir.
STREAM_INITIALIZED	Akış başlatılırken tetiklenir.
THIRD_QUARTILE	Bir reklam üçüncü çeyreğin sonuna ulaştığında tetiklenir.

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

Yöntemler

contentTimeForStreamTime, onTimedMetadata, previousCuePointForStreamTime, processMetadata, requestStream, setClickElement, streamTimeForContentTime

Dinamik reklam ekleme akışlarını yönetir. DAI arka ucu ile etkileşimleri yönetir, izleme ping'lerini ve yayın ile reklam etkinliklerini yayıncıya yönlendirmeyi yönetir. Bu yönetici, belirli bir reklamın yöneticisi değil, akış

Oluşturucu:

Parametre	Tür	Açıklama
videoElement	HTMLVideoElement	Asıl video oynatıcı öğesi.

contentTimeForStreamTime(streamTime)

Belirli bir yayın 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 döndürür: Reklamlar kaldırıldıktan sonra belirli bir yayın süresine karşılık gelen içerik süresi.

Parametre	Tür	Açıklama
streamTime	number	Eklenmiş reklamlarla yayın süresi (saniye cinsinden).

onTimedMetadata(metadata)

İşlenen meta verilerin sözlüğünü iletir. Sözlük, değer olarak kullanıcı tanımlı meta veri dizesini içeren "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)

Belirtilen yayın zamanı için önceki işaret noktasını döndürür. Böyle bir işaret noktası yoksa null döndürülür. Bu, geri sarma gibi özellikleri uygulamak için kullanılır ve yayıncı, kullanıcıyı reklam arasına döndürmek için kullanıcının ilerlediğini algıladığında çağrılır.

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

Parametre	Tür	Açıklama
streamTime	number	akışta istenilen zaman.

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 çağrısını yapın.

Parametre	Tür	Açıklama
type	string	Meta veri 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)

Sağlanan akış parametreleri kullanılarak bir yayını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 başka bir sayfaya yönlendirmeyle sonuçlanabilir.

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 süresini döndürür.

number döndürür: Reklamlar eklendikten sonra, belirtilen içerik süresine karşılık gelen yayın süresi.

Parametre	Tür	Açıklama
contentTime	number	Reklamsız içerik süresi (saniye cinsinden).

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

Alanlar

adTagParameters, apiKey, streamActivityMonitorId

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

Özellikler

Ad	Tür	Açıklama
adTagParameters		Akış isteğinizde sınırlı sayıda reklam etiketi parametresini geçersiz kılabilirsiniz. Daha fazla bilgi için Akışınıza hedefleme parametreleri sağlama başlıklı makaleyi inceleyin. 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ının içeriğinin kilidini açması için sağlanır. İçeriğe erişmeye çalışan uygulamaları doğrular.
streamActivityMonitorId		Akış etkinliği izleyiciyle akışta hata ayıklama yapmak için kullanılacak kimlik. Bu, yayıncıların akış etkinliği izleyici aracında akış günlüğünü kolayca bulmasına olanak tanımak için kullanılır.

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

Alanlar

contentSourceId, videoId

VOD yayın isteği özelliklerini belirten bir sınıf.

Oluşturucu:

Parametre	Tür	Açıklama
opt_VODStreamRequest	Object	zaten akışı istek özellikleri atanmış bir nesneye

Özellikler

Ad	Tür	Açıklama
contentSourceId		İçerik yönetim sisteminden alınan yayıncı içeriğinin benzersiz tanımlayıcısı. İsteğe bağlı yayınlar için gereklidir.
videoId		Video içeriği kaynağının tanımlayıcısıdır. İsteğe bağlı yayınlar için gereklidir.

google.ima.VERSION sabit değeri

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