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 wstawiania reklamy dynamicznej. 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

Class google.ima.dai.api.CompanionAd

Metody

Klasa reprezentująca obiekt reklamy towarzyszącej podczas dynamicznego wstawiania reklam. 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 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 wyświetlania aktualnie odtwarzanej reklamy.
cuepoints

Punkty wstawienia reklam w przypadku strumienia na żądanie. Mogą się one zmieniać w miarę postępu transmisji. Wartość będzie podawana tylko w detektorze zdarzeń CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Metody

Zdarzenie tego typu jest wywoływane przez menedżera strumienia jako powiadomienie o zmianie stanu strumienia.

getAd()


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

getStreamData()


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

Wywoływane po zakończeniu przerwy na reklamę.
AD_BREAK_STARTED

Wywoływane, gdy rozpoczyna się przerwa na reklamę.
AD_PROGRESS

Wywoływane, gdy nastąpi zmiana w postępach reklamy.
CLICK

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

Wywoływane po zakończeniu reklamy.
CUEPOINTS_CHANGED

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

Wywoływane, gdy wystąpi błąd.
FIRST_QUARTILE

Wywoływane, gdy reklama osiągnie pierwszy kwartyl.
LOADED

Wywoływane, gdy dostępny jest plik manifestu strumienia.
MIDPOINT

Uruchamia się, gdy reklama osiągnie punkt środkowy.
STARTED

Uruchamia się, gdy reklama się rozpoczyna.
STREAM_INITIALIZED

Uruchamiane po zainicjowaniu strumienia.
THIRD_QUARTILE

Uruchamia się, gdy reklama osiągnie 3 kwartyl.

Class google.ima.dai.api.StreamManager

Metody

Obsługuje strumienie dynamicznego wstawiania reklam. Zarządza interakcjami z backendem DAI i obsługuje pingi śledzące, a także przekazuje wydawcy zdarzenia strumienia i reklamy. 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 treści bez reklam dla danego czasu strumienia. Zwraca podany czas transmisji w przypadku transmisji na żywo.

Zwraca number: 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. Zwraca wartość null, jeśli nie ma takiego punktu sygnałowego. Służy do wdrażania 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ę.

Zwraca google.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 z sygnaturami czasowymi. 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)

Żąda 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 kliknięcia reklamy. Ten element jest używany jako odbiornik kliknięcia lub dotknięcia podczas odtwarzania reklamy i może spowodować przejście ze strony bieżącej.

Parametr Typ Opis
clickElement Element

element używany jako kliknięcie reklamy;

streamTimeForContentTime(contentTime)

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

Zwraca number: czas strumienia odpowiadający danemu czasowi 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. 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 artykule 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 strumieniu.

Klasa 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 znaków zawierający pełną wersję pakietu SDK.