IMA DAI SDK dla Roku

    1. ima
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Obraz klasy

Metody

Funkcje globalne, które kontrolują pakiet IMA SDK.

disableLogging()

Wyłącza logowanie przez pakiet SDK. Logowanie będzie domyślnie włączone.

getStreamManager()

Wyświetla menedżera strumieni (jeśli jest dostępny). Jeśli menedżer strumienia nie jest jeszcze dostępny, zwracana jest wartość „Nieprawidłowa”. Jeśli podczas tworzenia menedżera strumieni wystąpi błąd, obiekt błędu jest zwracany.

Zwraca object: menedżer strumienia lub obiekt błędu.

initSdk(settings)

Inicjuje pakiet SDK.

Parametr Typ Opis
settings object

Opcjonalny obiekt ustawień IMA.

requestStream(streamRequest)

Uruchamia żądanie strumienia asynchronicznego. Kontrola wraca natychmiast do odtwarzacza po wywołaniu tej metody.

Zwraca object: błąd lub nieprawidłowy w przypadku braku błędu

Parametr Typ Opis
streamRequest object

Powrót do góry

Klasa ima.AdBreakInfo

Pola

Metody

Zawiera informacje o przerwie na reklamę. Przekazywane do wywołań zwrotnych zdarzeń przez pakiet SDK.

Właściwości

Nazwa Typ Opis
adPosition

Indeks reklamy w przerwie na reklamę. W przypadku samodzielnych reklam wynosi 1.

duration

Maksymalny czas trwania przerwy w sekundach lub -1, jeśli jest nieznany.

podIndex

W przypadku transmisji na żywo zawsze zwraca -1. W przypadku wideo na żądanie (VOD) zwraca indeks bloku reklamowego. W przypadku bloku reklamowego przed filmem zwraca 0. W przypadku reklam w trakcie filmu zwraca 1, 2, ..., n. W przypadku bloku reklamowego po filmie zwraca n+1...n+x. Jeśli ta reklama nie jest częścią bloku reklamowego lub nie jest on częścią playlisty, domyślna wartość to 0.

timeOffset

Pozycja bloku reklamowego w treści (w sekundach). Reklama przed filmem zwraca wartość 0, reklamy po filmie zwraca -1, a reklamy w trakcie filmu – zaplanowany czas bloku.

totalAds

Łączna liczba reklam w tej przerwie na reklamę. W przypadku samodzielnych reklam wynosi 1.

createAdBreakInfo()


Zwraca ima.AdBreakInfo:

Powrót do góry

Klasa ima.AdEvent

Pola

Zdarzenia wywoływane przez menedżera reklam.

Właściwości

Nazwa Typ Opis
AD_PERIOD_ENDED

Uruchamiany za każdym razem, gdy strumień przechodzi z reklam lub planszy na treści. Taki kod zostanie uruchomiony nawet wtedy, gdy reklama zostanie odtworzona po raz drugi lub gdy użytkownik przejdzie do reklamy.

AD_PERIOD_STARTED

Uruchamiany za każdym razem, gdy strumień przechodzi z treści na reklamę lub planszy. Taki kod zostanie uruchomiony nawet wtedy, gdy reklama zostanie odtworzona po raz drugi lub gdy użytkownik przejdzie do reklamy.

COMPLETE

Uruchamiane po zakończeniu odtwarzania reklamy.

ERROR

Uruchamiane, gdy wystąpi błąd.

FIRST_QUARTILE

Uruchamiane, gdy suwak odtwarzania reklamy przekracza pierwszy kwartyl.

MIDPOINT

Uruchamiane, gdy suwak odtwarzania reklamy przekracza środek.

PROGRESS

Uruchamiane, gdy nastąpi aktualizacja postępu reklamy.

SKIPPABLE_STATE_CHANGED

Uruchamiane, gdy zmieni się stan reklamy możliwej do pominięcia.

SKIPPED

Uruchamiane, gdy reklama zostanie pominięta.

START

Uruchamiane, gdy reklama zacznie się odtwarzać.

THIRD_QUARTILE

Uruchamiane, gdy suwak odtwarzania reklamy przekracza trzeci kwartyl.

Powrót do góry

Klasa ima.AdInfo

Pola

Metody

Zawiera informacje o reklamie. Przekazywane do wywołań zwrotnych zdarzeń przez pakiet SDK.

Właściwości

Nazwa Typ Opis
adBreakInfo

Informacje związane z całą przerwą, w której znajduje się ta reklama.

adDescription

Opis reklamy.

adId

Identyfikator reklamy lub pusty ciąg znaków, jeśli jest nieznany.

adSystem

System reklamowy dostarczający kreację.

adTitle

Tytuł reklamy.

advertiserName

Nazwa reklamodawcy zdefiniowana przez stronę wyświetlającą reklamy.

companions

Reklamy towarzyszące określone w odpowiedzi VAST.

currentTime

Aktualny czas w reklamie w sekundach lub -1, jeśli jest nieznany.

duration

Czas trwania tej pojedynczej reklamy w sekundach lub wartość -1, jeśli jest nieznany.

universalAdIDRegistry

Ciąg znaków określający adres URL witryny rejestru, w której znajduje się uniwersalny identyfikator reklamy wybranej kreacji.

universalAdIDValue

Uniwersalny identyfikator reklamy wybranej kreacji.

wrappers

Tablica ima.WrapperInfo z informacjami o kodzie tej reklamy. Będzie ona prowadziła od zewnętrznego opakowania do wewnętrznego.

createAdInfo()


Zwraca ima.AdInfo:

Powrót do góry

Klasa ima.Companion

Pola

Metody

Zawiera informacje o elementach towarzyszących reklamy.

Właściwości

Nazwa Typ Opis
apiFramework

Interfejs API potrzebny do wykonania tej reklamy lub nieprawidłowy, jeśli jest niedostępny.

creativeType

Reprezentuje typ kreacji, zwykle jest to typ MIME.

height

Wysokość reklamy towarzyszącej w pikselach. Wartość 0, jeśli jest niedostępna.

trackingEvents

Mapa zdarzeń śledzenia, w której kluczem jest zdarzenie, a wartością – lista adresów URL, do których należy wysłać ping do tego zdarzenia.

url

Adres URL statycznego zasobu kreacji towarzyszącej.

width

Szerokość reklamy towarzyszącej w pikselach. Wartość 0, jeśli jest niedostępna.

createCompanion()


Zwraca ima.Companion:

Powrót do góry

Klasa ima.CuePoint

Pola

Metody

Zawiera informacje o punkcie wstawienia.

Właściwości

Nazwa Typ Opis
end

Godzina zakończenia punktu wstawienia reklamy w sekundach. Odpowiada ona przerwie na reklamę.

hasPlayed

Wartość logiczna wskazująca, że punkt wstawienia reklamy został już odtworzony.

start

Godzina rozpoczęcia punktu wstawienia reklamy w sekundach. Odpowiada ona przerwie na reklamę.

createCuePoint()


Zwraca ima.CuePoint:

Powrót do góry

Klasa ima.Error

Pola

Metody

Obiekt jest przekazywany do modułu obsługi błędów w przypadku wystąpienia błędu.

Właściwości

Nazwa Typ Opis
id

Identyfikator błędu. Listę kodów błędów znajdziesz w sekcji stałej ErrorEvent.

info

Dodatkowe informacje o błędzie.

type

Zawsze ustawiaj wartość błędu, aby wskazywać typ tego obiektu.

createError()


Zwraca ima.Error:

Powrót do góry

Klasa ima.ErrorEvent

Pola

Wszystkie błędy, które pakiet SDK może zwrócić.

Właściwości

Nazwa Typ Opis
BAD_STREAM_REQUEST

Żądanie strumienia nie zostało prawidłowo wypełnione.

COULD_NOT_LOAD_STREAM

Nie udało się wczytać strumienia.

ERROR

Nieznany błąd.

INVALID_RESPONSE

Odpowiedź serwera była nieprawidłowa.

STREAM_API_KEY_NOT_VALID

Podany klucz interfejsu API nie został zaakceptowany przez serwer.

Powrót do góry

Klasa ima.Player

Metody

adBreakEnded(adBreakInfo)

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

Parametr Typ Opis
adBreakInfo ima.AdBreakInfo

Zawiera informacje o przerwie na reklamę.

adBreakStarted(adBreakInfo)

Opcjonalnie. Wywoływane po rozpoczęciu przerwy na reklamę.

Parametr Typ Opis
adBreakInfo ima.AdBreakInfo

Zawiera informacje o przerwie na reklamę.

allVideoComplete()

Opcjonalnie. Wywoływane po zakończeniu odtwarzania filmu.

createPlayer()

Tworzy pusty obiekt IMA Player. Aby odtwarzać reklamy, musisz zaimplementować funkcję loadUrl. Inne funkcje są opcjonalne.

Zwraca ima.Player:

loadUrl(streamInfo)

Wywoływane, gdy odtwarzacz powinien rozpocząć odtwarzanie adresu URL. Aby wczytywać strumień, musisz wdrożyć tę metodę.

Parametr Typ Opis
streamInfo ima.StreamInfo

Zawiera informacje potrzebne do odtworzenia treści.

Powrót do góry

Klasa ima.StreamFormat

Pola

Określa format strumienia.

Właściwości

Nazwa Typ Opis
DASH

HLS

Powrót do góry

Klasa ima.StreamInfo

Pola

Metody

Informacje o strumieniu przekazywane z pakietu SDK do odtwarzacza.

Właściwości

Nazwa Typ Opis
format

Format filmu: hls lub myślnik. Definicja określona w ima.StreamFormat.

manifest

Adres URL strumienia.

streamId

Unikalny identyfikator strumienia.

streamType

Typ filmu: na żywo lub na żądanie. Definicja definiowana w ima.StreamType.

subtitles

Napisy, jeśli są dostępne. Nieprawidłowa wartość, jeśli nie.

createStreamInfo()


Zwraca ima.StreamInfo:

Powrót do góry

Klasa ima.StreamManager

Metody

Obiekt do zarządzania odtwarzaniem strumienia.

addEventListener(event, callback)

Dodaje odbiornik określonego zdarzenia. W przypadku obsługiwanych zdarzeń zobacz stałą AdEvents.

Parametr Typ Opis
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


Zwraca ima.StreamManager:

Parametr Typ Opis
streamRequest ima.StreamRequest

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Nieobsługiwany. Zamiast tego przekazuj dane z reklamy towarzyszącej bezpośrednio do RAF. Teraz nie ma operacji.

getContentTime(streamTime)

Pobiera czas (w milisekundach) w przypadku strumienia VOD, który przedstawia czas w treści bez reklam. Więcej informacji: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Aby znaleźć czas na treści dla bieżącej transmisji w trakcie pierwszej transmisji.

Zwraca Integer: czas trwania treści odpowiadający podanemu czasowi transmisji.

Parametr Typ Opis
streamTime Integer

Czas transmisji.

getCuePoints()

Zwraca wszystkie punkty wstawienia reklamy odpowiadające wszystkim przerwom na reklamę. Dotyczy to tylko treści wideo na żądanie, w których wszystkie przerwy na reklamy są znane z wyprzedzeniem. Wszystkie czasy są podane w czasie odtwarzania w sekundach.

Zwraca Object: tablica ze wszystkimi punktami wstawienia reklamy.

getPreviousCuePoint(time)

Zwraca punkt wstawienia reklamy poprzedzający ten moment. Punkt wstawienia reklamy wskazuje przerwę na reklamę. Wszystkie czasy są podane w czasie odtwarzania w sekundach.

Zwraca ima.CuePoint: obiekt z wartościami start (start, end) i hasPlayed. Jeśli nie ma dostępnego punktu wstawienia, zwracana jest nieprawidłowa wartość.

Parametr Typ Opis
time Float

Czas wyszukiwania, -1 wskazuje czas bieżący.

getStreamTime(contentTime)

Pobiera (w milisekundach) czas odtwarzania strumienia na podstawie czasu treści na potrzeby VOD. Zobacz: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

Zwraca Integer: czas strumieniowego przesyłania treści odpowiadający czasowi trwania treści.

Parametr Typ Opis
contentTime Integer

datę i godzinę pojawienia się treści;

loadThirdPartyStream(streamManifest, streamSubtitle)

Wczytuje metadane reklamy i wywołuje funkcję loadUrl, korzystając z podanych danych streamManifestUrl i streamSubtitle. Ta funkcja działa tylko wtedy, gdy typem żądania strumienia jest ima.StreamType.POD_VOD.

Parametr Typ Opis
streamManifest string

URL pliku manifestu strumienia z połączonymi reklamami.

streamSubtitle ifArray>|Invalid

Napisy są powiązane ze strumieniem lub Invalid, jeśli nie ma żadnej.

onMessage(msg)

Obsługuje wszystkie komunikaty pochodzące z obiektu Video. Musi być wywoływany dla każdej wiadomości odebranej przez roMessagePort.

Parametr Typ Opis
msg object

Komunikat z portu roVideo.

replaceAdTagParameters(adTagParameters)

Zastępuje wszystkie parametry tagu reklamy, które będą używane w nadchodzących żądaniach reklamy w transmisji na żywo. Pamiętaj, że ta rozmowa nie jest dostępna w przypadku strumieni VOD.

Parametr Typ Opis
adTagParameters string

Nowe parametry tagu reklamy.

start()

Rozpoczyna odtwarzanie strumienia.

Powrót do góry

Klasa ima.StreamRequest

Pola

Metody

Służy do określania właściwości żądania strumienia.

Właściwości

Nazwa Typ Opis
adTagParameters

Opcjonalnie. W żądaniu strumienia możesz zastąpić ograniczony zestaw parametrów tagu reklamy. Dodaj do strumienia parametry kierowania, aby uzyskać więcej informacji. Do preferencji wariantu strumienia możesz też używać parametrów dai-ot i dai-ov. Więcej informacji znajdziesz w artykule Zastępowanie parametrów wersji strumienia.

adUiNode

Węzeł wykresu scenicznego w miejscu, w którym wyświetla się interfejs reklamy. W trakcie wyświetlania reklam IMA umieszcza w reklamach takie elementy jak przyciski Dlaczego ta reklama? i Pomiń. Element musi nakładać się na cały element wideo.

apiKey

Opcjonalnie. Tych kluczy można używać do uwierzytelniania żądań strumieni. Klucze uwierzytelniania DAI należy skonfigurować w interfejsie DFP.

assetKey

Wymagane w przypadku transmisji na żywo. Dane te określają, który strumień należy odtworzyć. Klucz zasobu żądania transmisji na żywo to identyfikator dostępny w interfejsie DFP.

authToken

Token autoryzacji żądania strumienia. używany zamiast klucza interfejsu API w celu bardziej rygorystycznej autoryzacji treści. Korzystając z tego tokena, wydawca może kontrolować autoryzacje poszczególnych strumieni treści.

contentSourceId

Wymagane w przypadku transmisji na żądanie. Element cmsid pochodzi ze źródła treści wideo DFP w interfejsie użytkownika.

customAssetKey

Niestandardowy klucz zasobu służy do określenia, który strumień należy odtworzyć. Niestandardowe klucze zasobów są wymagane w przypadku żądań strumienia z bloku reklamowego.

format

Format strumienia. Domyślna wartość to ima.StreamFormat.HLS.

networkCode

Kod sieci dla wydawcy wysyłającego żądanie strumienia. W przypadku żądań strumienia z podów obsługujących żądania sieci wymagane są kody sieci.

player

Implementacja interfejsu odtwarzacza.

ppid

Rola wycofana. Użyj parametru adTagParameters. Opcjonalnie. Identyfikator podawany przez wydawcę na potrzeby funkcji Odbiorcy DFP.

streamActivityMonitorId

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

videoId

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

videoObject

Obiekt wideo (taki jak wideo roSGNode) odpowiedzialny za odtwarzanie filmu w aplikacji klienckiej. Ten obiekt będzie przeprowadzany odpytywaniem o różne dane, które zostaną użyte do określenia odpowiedniego czasu zdarzeń HLS ID3 na żywo.

createLiveStreamRequest(assetKey, apiKey)

Inicjuje wymagane właściwości aktywnego elementu StreamRequest. Używanie tego interfejsu API powoduje, że wszystkie pozostałe właściwości specyficzne dla StreamType są ignorowane. Jeśli jakieś wymagane parametry są puste, następuje logowanie błędów, a interfejs API zwraca ogólny typ StreamRequest bez ignorować żadnych właściwości.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami Live.

Parametr Typ Opis
assetKey string

apiKey string

Opcjonalny parametr, który zostanie przypisany do zwróconej właściwości apiKey interfejsu StreamRequest. Domyślnie jest to pusty ciąg znaków.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inicjuje wymagane właściwości ima.StreamRequest poda aktywnego. Używanie tego interfejsu API powoduje zignorowanie wszystkich pozostałych właściwości specyficznych dla ima.StreamType. Jeśli jakieś wymagane parametry są puste, następuje logowanie błędów, a interfejs API zwraca ogólny typ StreamRequest bez ignorować żadnych właściwości.

Zwraca obiekt StreamRequest: ima.StreamRequest z wymaganymi właściwościami PodLive.

Parametr Typ Opis
customAssetKey string

networkCode string

apiKey string

Opcjonalny parametr, który zostanie przypisany do zwróconej właściwości ima.StreamRequest.apiKey parametru ima.StreamRequest. Domyślnie jest to pusty ciąg znaków.

createPodVodStreamRequest(networkCode)

Inicjuje wymagane właściwości ima.StreamRequest w celu zarejestrowania strumienia VOD, gdy używasz bloku z dynamicznym wstawianiem reklam w narzędziu do łączenia filmów innej firmy. Ta funkcja ustawia typ żądania na ima.StreamType.POD_VOD i weryfikuje wszystkie wymagane właściwości w przypadku brakujących danych. Nieudane weryfikacje spowodują wystąpienie błędu w konsoli debugowania.

Zwraca obiekt StreamRequest: obiekt ima.StreamRequest. Jeśli są określone wszystkie wymagane właściwości, typ żądania jest ustawiany na ima.StreamType.POD_VOD.

Parametr Typ Opis
networkCode string

kod sieci Google Ad Managera,

createStreamRequest()


Zwraca ima.StreamRequest: pusty obiekt ima.StreamRequest.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Inicjuje wymagane właściwości StreamRequest w narzędziu Video Stitcher Live. Użycie tego interfejsu API powoduje, że wszystkie pozostałe właściwości specyficzne dla StreamType są ignorowane. Jeśli jakieś wymagane parametry są puste, następuje logowanie błędów, a interfejs API zwraca ogólny typ StreamRequest bez ignorować żadnych właściwości.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami VideoStitcherLive.

Parametr Typ Opis
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Inicjuje wymagane właściwości narzędzia VOD narzędzia Video Stitcher StreamRequest. Użycie tego interfejsu API powoduje, że wszystkie pozostałe właściwości specyficzne dla StreamType są ignorowane. Jeśli jakieś wymagane parametry są puste, następuje logowanie błędów, a interfejs API zwraca ogólny typ StreamRequest bez ignorować żadnych właściwości.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami VideoStitcherVod.

Parametr Typ Opis
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Inicjuje wymagane właściwości elementu ima.StreamRequest VOD. Użycie tego interfejsu API powoduje, że wszystkie pozostałe właściwości specyficzne dla ima.StreamType są ignorowane. Jeśli jakieś wymagane parametry są puste, następuje logowanie błędów, a interfejs API zwraca ogólny typ StreamRequest bez ignorować żadnych właściwości.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami VOD.

Parametr Typ Opis
contentSourceId string

videoId string

apiKey string

Opcjonalny parametr, który zostanie przypisany do zwróconej właściwości ima.StreamRequest.apiKey parametru ima.StreamRequest. Domyślnie jest to pusty ciąg znaków.

Powrót do góry

Klasa ima.StreamType

Pola

Określa typ strumienia, o którego odtwarzanie ma zostać odtworzone gracz. Reklamy przed filmem i VOD powinny być odtwarzane od początku transmisji.

Właściwości

Nazwa Typ Opis
LIVE

Film został opublikowany.

VOD

Film jest dostępny na żądanie.

Powrót do góry

Klasa ima.WrapperInfo

Pola

Metody

Zawiera informacje o paczce.

Właściwości

Nazwa Typ Opis
adId

Identyfikator reklamy lub pusty ciąg znaków, jeśli jest nieznany.

adSystem

Zadeklarowana nazwa systemu reklamowego lub pusty ciąg znaków, jeśli jest nieznany.

creativeAdId

Identyfikator reklamy powiązany z kreacją lub pusty ciąg znaków, jeśli jest nieznany.

creativeId

Identyfikator kreacji lub pusty ciąg znaków, jeśli jest nieznany.

dealId

Identyfikator umowy lub pusty ciąg znaków, jeśli jest nieznany.

createWrapperInfo()


Zwraca ima.WrapperInfo:

Powrót do góry