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

Class google.ima.dai.api.Ad

Metody

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

getAdId()


Zwrotystring:

getAdPodInfo()


Zwrotygoogle.ima.dai.api.AdPodInfo:

getAdSystem()


Zwrotystring:

getAdvertiserName()


Zwrotystring:

getApiFramework()


Zwrotystring:

getCompanionAds()


ZwrotyArray.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Zwrotystring:

getCreativeId()


Zwrotystring:

getDealId()


Zwrotystring:

getDescription()


Zwrotystring:

getDuration()


Zwrotynumber:

getTitle()


Zwrotystring:

getVastMediaHeight()


Zwrotynumber:

getVastMediaWidth()


Zwrotynumber:

getWrapperAdIds()


ZwrotyArray.<string>:

getWrapperAdSystems()


ZwrotyArray.<string>:

getWrapperCreativeIds()


ZwrotyArray.<string>:

Class google.ima.dai.api.AdPodInfo

Metody

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

getAdPosition()


Zwrotynumber:

getMaxDuration()


Zwrotynumber:

getPodIndex()


Zwrotynumber:

getTimeOffset()


Zwrotynumber:

getTotalAds()


Zwrotynumber:

Class google.ima.dai.api.AdProgressData

Pola

Klasa do określania danych o postępach reklamy.

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()


Zwrotystring:

getContent()


Zwrotystring:

getContentType()


Zwrotystring:

getHeight()


Zwrotynumber:

getWidth()


Zwrotynumber:

Class google.ima.dai.api.CuePoint

Pola

Klasa do określania właściwości punktu sygnałowego, który reprezentuje przerwę na reklamy w strumieniach VOD z DAI.

Właściwości

Nazwa Typ Opis
end

Czas zakończenia tego punktu sygnałowego.
played

Czy ten punkt sygnałowy został odtworzony.
start

Czas rozpoczęcia tego punktu sygnałowego.

Class 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, do którego przypisano już właściwości żądania strumienia.

Właściwości

Nazwa Typ Opis
assetKey

Służy do określania, który strumień ma być odtwarzany. Klucz pliku żądania transmisji na żywo to identyfikator, który można znaleźć w interfejsie DFP.

Class google.ima.dai.api.StreamData

Pola

Klasa do określania danych strumienia.

Właściwości

Nazwa Typ Opis
adProgressData

Informacje o czasie trwania aktualnie odtwarzanej reklamy.
cuepoints

Punkty wstawienia reklam w strumieniu na żądanie. Mogą się one zmieniać w miarę postępu transmisji. Wartość będzie wypełniana tylko w detektorze zdarzeń dla zdarzenia 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 obiekt zwrotny 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ąpi aktualizacja postępu reklamy.
CLICK

Wysyłane, gdy element kliknięcia zostanie kliknięty lub dotknięty podczas odtwarzania reklamy.
COMPLETE

Uruchamiane po zakończeniu reklamy.
CUEPOINTS_CHANGED

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

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

Uruchamiane, gdy reklama osiągnie pierwszy kwartyl.
LOADED

Uruchamiane, gdy dostępny jest plik manifestu transmisji strumieniowej.
MIDPOINT

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

Uruchamiane, gdy reklama się rozpocznie.
STREAM_INITIALIZED

Uruchamiane po zainicjowaniu strumienia.
THIRD_QUARTILE

Uruchamiane, gdy reklama osiągnie trzeci kwartyl.

Class google.ima.dai.api.StreamManager

Metody

Obsługuje transmisje dynamicznego wstawiania reklam. Zarządza interakcjami z backendem DAI oraz obsługuje pingi śledzące, a także przekazuje wydawcy zdarzenia związane ze strumieniem i reklamami. Ten menedżer nie dziedziczy po klasie BaseAdsManager, ponieważ nie zarządza konkretną reklamą, ale całym strumieniem.

Konstruktor:
Parametr Typ Opis
videoElement HTMLVideoElement

Rzeczywisty element odtwarzacza wideo.

contentTimeForStreamTime(streamTime)

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

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

Parametr Typ Opis
streamTime number

czas transmisji z wstawionymi reklamami (w sekundach);

onTimedMetadata(metadata)

Przekazuje słownik przetworzonych metadanych. Słownik oczekuje klucza „TXXX” z ciągiem metadanych zdefiniowanych przez użytkownika jako wartością. Jeśli odtwarzacz udostępnia nieprzetworzone metadane, zamiast tego wywołaj funkcję ima.dai.api.StreamManager.processMetadata.

Parametr Typ Opis
metadata Object

Słownik metadanych.

previousCuePointForStreamTime(streamTime)

Zwraca poprzedni punkt sygnałowy dla danego czasu strumienia. Jeśli taki punkt sygnałowy nie istnieje, zwraca wartość null. Służy do implementowania funkcji takich jak powrót do poprzedniego stanu. Jest wywoływana, gdy wydawca wykryje, że użytkownik przewinął film, aby przywrócić przerwę na reklamę.

Returnsgoogle.ima.dai.api.CuePoint: poprzedni punkt sygnałowy dla danego czasu transmisji.

Parametr Typ Opis
streamTime number

czas strumienia, do którego nastąpiło przewinięcie;

processMetadata(type, data, timestamp)

Przetwarza metadane czasowe w przypadku transmisji na żywo. Użyj tej funkcji, jeśli odtwarzacz wideo udostępnia nieprzetworzone metadane wraz ze znacznikami czasu. 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 tagu. W przypadku ID3 musi to być cały tag.
timestamp number

Czas, w którym dane powinny być przetwarzane.

requestStream(streamRequest)

Wysyła żądanie wczytania strumienia z użyciem podanych parametrów strumienia.

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

zawiera parametry wczytywania metadanych strumienia.

setClickElement(clickElement)

Ustawia element kliknięcia reklamy. Ten element jest używany jako odbiornik kliknięć lub dotknięć podczas wyświetlania reklamy i może spowodować przejście ze strony bieżącej.

Parametr Typ Opis
clickElement Element

element używany jako kliknięcie reklamy powodujące przejście pod adres docelowy;

streamTimeForContentTime(contentTime)

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

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

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. Więcej informacji znajdziesz w artykule Dodawanie parametrów kierowania do strumienia. Do określania preferencji dotyczących wersji strumienia możesz używać parametrów dai-ot i dai-ov. Więcej informacji znajdziesz w sekcji Zastępowanie parametrów wersji strumienia.
apiKey

Klucz interfejsu API żądania strumienia. Jest ona konfigurowana w  interfejsie administracyjnym DFP i udostępniana wydawcy, aby odblokować jego treści. Weryfikuje aplikacje, które próbują uzyskać dostęp do treści.
streamActivityMonitorId

Identyfikator do debugowania strumienia za pomocą narzędzia do monitorowania aktywności w transmisji na żywo. Umożliwia to wydawcom łatwe znajdowanie dziennika strumienia w narzędziu do monitorowania aktywności w transmisji na żywo.

Class google.ima.dai.api.VODStreamRequest

Pola

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

Konstruktor:
Parametr Typ Opis
opt_VODStreamRequest Object

obiekt, do którego przypisano już 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 strumieni na żądanie.
videoId

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

Stała google.ima.VERSION

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