Interfejsy API pakietu Google IMA DAI SDK

    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

Klasa google.ima.dai.api.Ad

Metody

Klasa reprezentująca obiekt reklamowy podczas dynamicznego wstawiania reklam. Ta klasa ujawnia podzbiór właściwości ima.Ad.

getAdId()


Zwraca string:

getAdPodInfo()


Zwraca google.ima.dai.api.AdPodInfo:

getAdSystem()


Zwraca string:

getAdvertiserName()


Zwraca string:

getApiFramework()


Zwraca string:

getCompanionAds()


Zwraca Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Zwraca string:

getCreativeId()


Zwraca string:

getDealId()


Zwraca string:

getDescription()


Zwraca string:

getDuration()


Zwraca number:

getTitle()


Zwraca string:

getVastMediaHeight()


Zwraca number:

getVastMediaWidth()


Zwraca number:

getWrapperAdIds()


Zwraca Array.<string>:

getWrapperAdSystems()


Zwraca Array.<string>:

getWrapperCreativeIds()


Zwraca Array.<string>:

Klasa google.ima.dai.api.AdPodInfo

Metody

Klasa reprezentująca obiekt informacji o bloku reklamowym podczas dynamicznego wstawiania reklam. Ta klasa ujawnia podzbiór właściwości ima.AdPodInfo.

getAdPosition()


Zwraca number:

getMaxDuration()


Zwraca number:

getPodIndex()


Zwraca number:

getTimeOffset()


Zwraca number:

getTotalAds()


Zwraca number:

Klasa google.ima.dai.api.AdprogressData

Pola

Klasa określająca dane o postępach do wyświetlania reklam.

Właściwości

Nazwa Typ Opis
adBreakDuration

adPosition

currentTime

duration

totalAds

Klasa google.ima.dai.api.CompanionAd

Metody

Klasa reprezentująca obiekt reklamy towarzyszącej podczas dynamicznego wstawiania reklam. Ta klasa ujawnia podzbiór właściwości ima.CompanionAd.

getAdSlotId()


Zwraca string:

getContent()


Zwraca string:

getContentType()


Zwraca string:

getHeight()


Zwraca number:

getWidth()


Zwraca number:

Klasa google.ima.dai.api.CuePoint

Pola

Klasa określająca właściwości punktu wstawienia, która reprezentuje przerwę na reklamę w strumieniach VOD z dynamicznym wstawianiem reklam.

Właściwości

Nazwa Typ Opis
end

Czas zakończenia tego punktu wstawienia.
played

Jeśli ten punkt wstawienia reklamy został odtworzony.
start

Czas rozpoczęcia tego punktu wstawienia.

Klasa google.ima.dai.api.LiveStreamRequest

Pola

Klasa określająca właściwości żądania transmisji na żywo.

Konstruktor:
Parametr Typ Opis
opt_liveStreamRequest Object

obiekt, do którego są już przypisane właściwości żądania strumienia.

Właściwości

Nazwa Typ Opis
assetKey

Dane te służą do określenia, którą transmisję należy odtworzyć. Klucz zasobu żądania transmisji na żywo to identyfikator, który znajdziesz w interfejsie DFP.

Klasa google.ima.dai.api.StreamData

Pola

Klasa do określania danych strumienia.

Właściwości

Nazwa Typ Opis
adProgressData

Informacje dotyczące czasu wyświetlania aktualnie odtwarzanej reklamy.
cuepoints

Punkty wstawienia reklamy w strumieniu na żądanie. Te wartości mogą się zmieniać w miarę postępów transmisji. To pole będzie wypełniane tylko w detektorze zdarzeń dla: AdEvent CUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

Klasa google.ima.dai.api.StreamEvent

Metody

Ten typ zdarzenia jest zgłaszany przez menedżera strumienia jako powiadomienie o zmianie stanu strumienia.

getAd()


Zwraca google.ima.dai.api.Ad: zwracany obiekt z informacjami o reklamie.

getStreamData()


Zwraca google.ima.dai.api.StreamData: zwraca obiekt z informacjami o strumieniu.

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

Pola

Lista typów zdarzeń obsługiwanych przez pakiet IMA SDK.

Wartości

Wartość Opis
AD_BREAK_ENDED

Uruchamiane po zakończeniu przerwy na reklamę.
AD_BREAK_STARTED

Uruchamiane, gdy rozpoczyna się przerwa na reklamę.
AD_PROGRESS

Uruchamiane, gdy następuje aktualizacja postępu reklamy.
CLICK

Wysyłane, gdy użytkownik kliknie element kliknięcia podczas odtwarzania reklamy.
COMPLETE

Uruchamiane po zakończeniu reklamy.
CUEPOINTS_CHANGED

Wysyłane w przypadku strumieni na żądanie po zmianie punktów wstawienia.
ERROR

Uruchamiane, gdy wystąpi błąd.
FIRST_QUARTILE

Uruchamiane, gdy reklama osiągnie pierwszy kwartyl.
LOADED

Uruchamiane, gdy plik manifestu strumienia jest dostępny.
MIDPOINT

Uruchamiane, gdy reklama osiągnie połowę.
STARTED

Uruchamiane, gdy reklama się rozpoczyna.
STREAM_INITIALIZED

Uruchamiane po zainicjowaniu strumienia.
THIRD_QUARTILE

Uruchamiane, gdy reklama osiągnie trzeci kwartyl.

Klasa google.ima.dai.api.StreamManager

Metody

Obsługuje strumienie dynamicznego wstawiania reklam. Zarządza interakcjami z backendem DAI oraz obsługuje pingi śledzenia, a także przekazywanie strumienia i zdarzeń reklamy wydawcy. Ten menedżer nie dziedziczy z obiektu BaseAdsManager, ponieważ nie jest menedżerem dla konkretnej reklamy, a jedynie dla całego strumienia

Konstruktor:
Parametr Typ Opis
videoElement HTMLVideoElement

Rzeczywisty element odtwarzacza wideo.

contentTimeForStreamTime(streamTime)

Zwraca czas odtwarzania treści bez reklam w danym czasie odtwarzania. Zwraca podany czas transmisji na żywo.

Zwraca number: czas treści odpowiadający danemu czasowi transmisji po usunięciu reklam.

Parametr Typ Opis
streamTime number

czas transmisji z wstawionymi reklamami (w sekundach).

onTimedMetadata(metadata)

Karty w słowniku przetworzonych metadanych. Słownik wymaga klucza „TXXX” z ciągiem metadanych zdefiniowanym przez użytkownika jako wartością. Jeśli odtwarzacz dostarcza nieprzetworzone metadane, wywołaj zamiast tego metodę ima.dai.api.StreamManager.processMetadata.

Parametr Typ Opis
metadata Object

Słownik metadanych.

previousCuePointForStreamTime(streamTime)

Zwraca poprzedni punkt wstawienia dla danego czasu strumienia. Jeśli nie ma takiego punktu wstawienia, zwraca wartość null. Używa się go do implementowania takich funkcji jak odwracanie i wywoływane, gdy wydawca wykryje, że użytkownik użył wyszukiwania, by przywrócić mu przerwę na reklamę.

Zwraca google.ima.dai.api.CuePoint: poprzedni punkt wstawienia reklamy dla danego czasu strumienia.

Parametr Typ Opis
streamTime number

oczekiwany czas transmisji.

processMetadata(type, data, timestamp)

Przetwarza ograniczone czasowo metadane transmisji na żywo. Użyj tej opcji, jeśli Twój odtwarzacz wideo zawiera nieprzeanalizowane metadane wraz z sygnaturami czasowymi. W przeciwnym razie wywołaj ima.dai.api.StreamManager.onTimedMetadata.

Parametr Typ Opis
type string

Wpisz, aby wyszukać metadane. Musi mieć wartość „ID3”.
data Uint8Array

Nieprzetworzone dane tagów. W przypadku ID3 musi być całym tagiem.
timestamp number

Czas przetwarzania danych.

requestStream(streamRequest)

Żąda do wczytania strumienia przy użyciu podanych parametrów strumienia.

Parametr Typ Opis
streamRequest google.ima.dai.api.StreamRequest

zawiera parametry wczytywania metadanych strumienia.

setClickElement(clickElement)

Ustawia element klikalności reklam. Ten element pełni funkcję odbiornika kliknięć lub dotknięć podczas odtwarzania reklamy i może spowodować opuszczenie bieżącej strony.

Parametr Typ Opis
clickElement Element

czyli elementu użytego do kliknięcia reklamy.

streamTimeForContentTime(contentTime)

Zwraca czas odtwarzania z reklamami w wybranym okresie treści. Zwraca podany czas odtwarzania treści na żywo.

Zwraca number: czas strumienia odpowiadający danemu czasowi treści po wstawieniu reklam.

Parametr Typ Opis
contentTime number

czas odtwarzania treści bez reklam (w sekundach).

Klasa google.ima.dai.api.StreamRequest

Pola

Klasa określająca właściwości żądania strumienia.

Właściwości

Nazwa Typ Opis
adTagParameters

Możesz zastąpić ograniczony zestaw parametrów tagu reklamy w żądaniu transmisji. Dodaj do strumienia parametry kierowania, aby dowiedzieć się więcej. Do określania preferencji wariantu strumienia możesz używać parametrów dai-ot i dai-ov. Więcej informacji znajdziesz w artykule Zastępowanie parametrów wariantu strumienia.
apiKey

Klucz interfejsu API żądania strumienia. Można go skonfigurować w interfejsie administratora DFP i udostępnić wydawcy, aby odblokować jego treści. Weryfikuje on aplikacje, które próbują uzyskać dostęp do treści.
streamActivityMonitorId

Identyfikator używany do debugowania strumienia za pomocą narzędzia do monitorowania strumienia aktywności. Dzięki temu wydawcy mogą w wygodny sposób znaleźć log strumienia w narzędziu do monitorowania strumienia aktywności.

Klasa google.ima.dai.api.VODStreamRequest

Pola

Klasa określająca właściwości żądania strumienia VOD.

Konstruktor:
Parametr Typ Opis
opt_VODStreamRequest Object

obiekt, do którego są już przypisane właściwości żądania strumienia.

Właściwości

Nazwa Typ Opis
contentSourceId

Unikalny identyfikator treści wydawcy z systemu CMS. Wymagane w przypadku transmisji na żądanie.
videoId

Identyfikator źródła treści wideo. Wymagane w przypadku transmisji na żądanie.

Stała wartość google.ima.VERSION

Ciąg tekstowy zawierający pełną wersję pakietu SDK.