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 reklamy podczas dynamicznego wstawiania reklamy. Ta klasa udostępnia podzbiór właściwości ima.Ad.

getAdId()


Zwroty string:

getAdPodInfo()


Zwroty google.ima.dai.api.AdPodInfo:

getAdSystem()


Zwroty string:

getAdvertiserName()


Zwroty string:

getApiFramework()


Zwroty string:

getCompanionAds()


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

getCreativeAdId()


Zwroty string:

getCreativeId()


Zwroty string:

getDealId()


Zwroty string:

getDescription()


Zwroty string:

getDuration()


Zwroty number:

getTitle()


Zwroty string:

getVastMediaHeight()


Zwroty number:

getVastMediaWidth()


Zwroty number:

getWrapperAdIds()


Zwroty Array.<string>:

getWrapperAdSystems()


Zwroty Array.<string>:

getWrapperCreativeIds()


Zwroty Array.<string>:

Klasa google.ima.dai.api.AdPodInfo

Metody

Klasa reprezentująca obiekt informacji o podreklamie podczas dynamicznego wstawiania reklamy. Ta klasa udostępnia podzbiór właściwości ima.AdPodInfo.

getAdPosition()


Zwroty number:

getMaxDuration()


Zwroty number:

getPodIndex()


Zwroty number:

getTimeOffset()


Zwroty number:

getTotalAds()


Zwroty number:

Klasa google.ima.dai.api.AdProgressData

Pola

Klasa służąca do określania danych o postępach w przypadku 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 reklamy. Ta klasa udostępnia podzbiór właściwości ima.CompanionAd.

getAdSlotId()


Zwroty string:

getContent()


Zwroty string:

getContentType()


Zwroty string:

getHeight()


Zwroty number:

getWidth()


Zwroty number:

Klasa google.ima.dai.api.CuePoint

Pola

Klasa służąca do określania właściwości punktu cuepoint, który reprezentuje przerwę na reklamę w strumieniu VOD z DAI.

Właściwości

Nazwa Typ Opis
end

Czas zakończenia tego punktu cue.
played

czy ten punkt cue został odtworzony.
start

Czas rozpoczęcia tego punktu cue.

Klasa google.ima.dai.api.LiveStreamRequest

Pola

Klasa do określania właściwości żądania transmisji na żywo.

Konstruktor:
Parametr Typ Opis
opt_liveStreamRequest Object

obiekt, który ma już przypisane właściwości żądania strumienia;

Właściwości

Nazwa Typ Opis
assetKey

Służy to do określenia, który strumień powinien być odtwarzany. Klucz pliku żądania transmisji na żywo to identyfikator, który możesz znaleźć 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 trwania aktualnie odtwarzanej reklamy.
cuepoints

Punkty wywołania reklamy w strumieniu na żądanie. Te dane mogą się zmieniać w trakcie transmisji. Ta wartość zostanie wypełniona tylko w detektorze zdarzeń CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Metody

Ten typ zdarzenia jest wywoływany przez menedżera strumienia jako powiadomienie, gdy zmienia się stan strumienia.

getAd()


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

getStreamData()


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

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ąpiła zmiana w postępie wyświetlania reklamy.
CLICK

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

Uruchamiane po zakończeniu reklamy.
CUEPOINTS_CHANGED

Wysyłane w przypadku strumieni na żądanie, gdy zmieniają się punkty cue.
ERROR

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

Uruchamiane, gdy reklama osiąga pierwszy kwartyl.
LOADED

Uruchamiane, gdy manifest strumienia jest dostępny.
MIDPOINT

Uruchamiane, gdy reklama osiąga punkt środkowy.
STARTED

Uruchamiane, gdy reklama się rozpoczyna.
STREAM_INITIALIZED

Uruchamiane, gdy strumień jest inicjowany.
THIRD_QUARTILE

Uruchamiane, gdy reklama osiąga trzeci kwartyl.

Klasa google.ima.dai.api.StreamManager

Metody

Obsługuje strumienie dynamicznego wstawiania reklam. Zarządza interakcjami z systemem backendowym DAI i obsługuje pingi śledzenia oraz przekierowywanie zdarzeń strumienia i reklam do wydawcy. Ten menedżer nie dziedziczy po klasie BaseAdsManager, ponieważ nie jest menedżerem konkretnej reklamy, tylko całego strumienia.

Konstruktor:
Parametr Typ Opis
videoElement HTMLVideoElement

Rzeczywisty element odtwarzacza wideo.

contentTimeForStreamTime(streamTime)

Zwraca czas trwania treści bez reklam w danym strumieniu. Zwraca podany czas transmisji dla transmisji na żywo.

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

Parametr Typ Opis
streamTime number

czas strumienia z wstawionych reklam (w sekundach).

onTimedMetadata(metadata)

Przekazuje słownik przetworzonych metadanych. Słownik oczekuje klucza „TXXX” z definiowanym przez użytkownika ciągiem znaków metadanych jako wartością. Jeśli Twój odtwarzacz udostępnia metadane w postaci surowych danych, wywołaj zamiast tego funkcję ima.dai.api.StreamManager.processMetadata.

Parametr Typ Opis
metadata Object

słownik metadanych,

previousCuePointForStreamTime(streamTime)

Zwraca poprzedni punkt cuepoint dla danego czasu strumienia. Zwraca wartość null, jeśli taki punkt cuepoint nie istnieje. Jest on używany do implementacji funkcji takich jak snap back i jest wywoływany, gdy wydawca wykryje, że użytkownik przewinął film, aby wrócić do przerwy na reklamę.

Zwraca google.ima.dai.api.CuePoint: poprzedni punkt cue dla danego czasu transmisji.

Parametr Typ Opis
streamTime number

czas przesunięcia strumienia.

processMetadata(type, data, timestamp)

Przetwarza zsynchronizowane z czasem metadane w przypadku transmisji na żywo. Użyj, jeśli odtwarzacz wideo udostępnia nieprzetworzone metadane wraz z sygnaturą czasową. W przeciwnym razie wywołaj funkcję ima.dai.api.StreamManager.onTimedMetadata.

Parametr Typ Opis
type string

Typ metadanych. Musi to być „ID3”.
data Uint8Array

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

Czas, w którym dane powinny zostać przetworzone.

requestStream(streamRequest)

Żądanie załadowania strumienia za pomocą podanych parametrów strumienia.

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

zawiera parametry do wczytania metadanych strumienia.

setClickElement(clickElement)

Ustawia element kliknięcia reklamy. Ten element służy jako odbiornik kliknięcia lub dotknięcia podczas wyświetlania reklamy i może spowodować przejście na inną stronę.

Parametr Typ Opis
clickElement Element

element używany jako kliknięcie reklamy.

streamTimeForContentTime(contentTime)

Zwraca czas trwania strumienia z reklamami dla danego czasu trwania treści. Zwraca podany czas trwania treści w przypadku transmisji na żywo.

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

Parametr Typ Opis
contentTime number

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

Class google.ima.dai.api.StreamRequest

Pola

Klasa do określania właściwości żądania strumienia.

Właściwości

Nazwa Typ Opis
adTagParameters

W żądaniu strumienia możesz zastąpić ograniczony zestaw parametrów tagu reklamy. Dowiedz się więcej o dodawaniu parametrów kierowania do strumienia. Do ustawienia preferencji wersji strumienia możesz użyć parametrów dai-ot i dai-ov. Więcej informacji znajdziesz w artykule Zastępowanie parametrów wersji strumienia.
apiKey

Klucz interfejsu API żądania strumienia. Jest on konfigurowany w  interfejsie administracyjnym DFP i przekazywany wydawcy w celu odblokowania treści. Weryfikuje aplikacje, które próbują uzyskać dostęp do treści.
streamActivityMonitorId

Identyfikator, który ma być używany do debugowania strumienia za pomocą narzędzia do monitorowania aktywności strumienia. Dzięki temu wydawcy mogą wygodnie znajdować dziennik transmisji w narzędziu do monitorowania aktywności w transmisji.

Klasa google.ima.dai.api.VODStreamRequest

Pola

Klasa służąca do określania właściwości żądania strumienia VOD.

Konstruktor:
Parametr Typ Opis
opt_VODStreamRequest Object

obiekt, który ma 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 strumieniowego przesyłania na żądanie.
videoId

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

Stała google.ima.VERSION

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