IMA DAI SDK dla Roku

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

Class ima

Metody

disableLogging, getStreamManager, initSdk, requestStream

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

disableLogging()

Wyłącza rejestrowanie pakietu SDK. Rejestrowanie jest domyślnie włączone.

getStreamManager()

Zwraca menedżera strumienia, jeśli jest dostępny. Jeśli menedżer strumienia nie jest jeszcze dostępny, zwracana jest wartość Nieprawidłowy. Jeśli podczas tworzenia menedżera strumienia wystąpił błąd, zwracany jest obiekt błędu.

Zwraca object: obiekt menedżera transmisji lub błąd.

initSdk(settings)

Inicjowanie pakietu SDK.

Parametr	Typ	Opis
settings	object	Opcjonalny obiekt ustawień IMA.

requestStream(streamRequest)

Rozpoczyna asynchroniczne żądanie transmisji. Po wywołaniu tej metody kontrola wraca natychmiast do odtwarzacza.

Zwraca object: błąd lub wartość nieprawidłowa, jeśli nie wystąpił błąd

Parametr	Typ	Opis
streamRequest	object

Powrót do góry

Klasa: ima.AdBreakInfo

Pola

adPosition, duration, podIndex, timeOffset, totalAds

Metody

createAdBreakInfo

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ę. Wskaźnik 1 dotyczy reklam samodzielnych.
duration		Maksymalny czas trwania przerwy w sekundach lub -1, jeśli jest nieznany.
podIndex		W przypadku transmisji na żywo zwraca identyfikator przerwy jako indeks podsegmentu lub 0w przypadku prerollu. W transmisjach na żywo nie ma reklam końcowych. Domyślna wartość to -2. W przypadku wideo na żądanie (VOD) zwraca indeks bloku reklamowego. W przypadku bloku reklamowego preroll zwraca wartość 0. W przypadku reklam w trakcie filmu zwracane są wartości 1, 2, …, n. W przypadku podzbioru po reklamie zwraca n+1...n+x. Domyślnie jest to 0, jeśli reklama nie należy do bloku reklamowego lub blok reklamowy nie należy do playlisty.
timeOffset		Pozycja bloku reklamowego w treści (w sekundach). Reklamy przed filmem zwracają wartość 0, reklamy po filmie – -1, a reklamy w trakcie filmu – zaplanowany czas podgrupy reklam.
totalAds		Łączna liczba reklam zawartych w tej przerwie na reklamę. Wartość 1 dotyczy reklam samodzielnych.

createAdBreakInfo()

Zwroty ima.AdBreakInfo:

Powrót do góry

Klasa: ima.AdEvent

Pola

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED, START, THIRD_QUARTILE

Zdarzenia wywoływane przez Ad Managera.

Właściwości

Nazwa	Typ	Opis
AD_PERIOD_ENDED		Wywoływany za każdym razem, gdy transmisja przechodzi z reklamy lub planszy na treści. Jest ono wywoływane nawet wtedy, gdy reklama jest odtwarzana po raz drugi lub gdy użytkownik przewinie reklamę.
AD_PERIOD_STARTED		Wywoływany za każdym razem, gdy transmisja przechodzi z treści do reklamy lub planszy. Jest ono wywoływane nawet wtedy, gdy reklama jest odtwarzana po raz drugi lub gdy użytkownik przewinie reklamę.
COMPLETE		Uruchamiane po zakończeniu odtwarzania reklamy.
ERROR		Uruchamiane, gdy wystąpi błąd.
FIRST_QUARTILE		Uruchamiane, gdy element sterujący odtwarzania reklamy przekroczy pierwszy kwartyl.
ICON_FALLBACK_IMAGE_CLOSED		Wywoływane, gdy użytkownik zamknie okno obrazu zastępczego ikony.
ICON_FALLBACK_IMAGE_SHOWN		Wywoływane po wyświetleniu obrazu ikony zastępczego.
MIDPOINT		Uruchamiane, gdy suwak odtwarzania reklamy przekroczy punkt środkowy.
PROGRESS		Uruchamiane, gdy nastąpiła zmiana w postępie wyświetlania reklamy.
SKIPPABLE_STATE_CHANGED		Uruchamiane, gdy stan możliwości pominięcia reklamy się zmienia.
SKIPPED		Uruchamiane, gdy użytkownik pominie reklamę.
START		Uruchamiane, gdy reklama zacznie się odtwarzać.
THIRD_QUARTILE		Uruchamiane, gdy nagłówek reklamy przekroczy trzeci kwartyl.

Powrót do góry

Klasa ima.AdInfo

Pola

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, creativeAdId, creativeId, currentTime, dealId, duration, skipOffset, universalAdIDRegistry, universalAdIDValue, wrappers

Metody

createAdInfo

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

Właściwości

Nazwa	Typ	Opis
adBreakInfo		Informacje dotyczące całej przerwy, w której wyświetla się reklama.
adDescription		Opis reklamy.
adId		Identyfikator reklamy lub pusty ciąg znaków, jeśli jest nieznany.
adSystem		System reklamy dostarczający kreację.
adTitle		Tytuł reklamy.
advertiserName		Nazwa reklamodawcy określona przez stronę wyświetlającą.
companions		Reklamy towarzyszące określone w odpowiedzi VAST.
creativeAdId		Kod ISCI (Industry Standard Commercial Identifier) reklamy. Jest to identyfikator reklamy wybranej kreacji w odpowiedzi VAST.
creativeId		Identyfikator wybranej kreacji reklamy.
currentTime		Bieżący czas w reklamie (w sekundach) lub -1, jeśli jest nieznany.
dealId		Zwraca pierwszy identyfikator umowy obecny w łańcuchu opakowania dla bieżącej reklamy, zaczynając od góry.
duration		Czas trwania tej pojedynczej reklamy w sekundach lub -1, jeśli jest nieznany.
skipOffset		Czas potrzebny do tego, aby reklama stała się możliwa do pominięcia lub -1, jeśli jest to nieznane.
universalAdIDRegistry		Ciąg znaków służący do identyfikacji adresu URL witryny rejestru, w której katalogowany jest uniwersalny identyfikator reklamy wybranej kreacji.
universalAdIDValue		Uniwersalny identyfikator reklamy wybranej kreacji reklamy.
wrappers		Tablica obiektów ima.WrapperInfo z informacjami o wrapperze dla tej reklamy. Kolejność będzie od opakowania zewnętrznego do wewnętrznego.

createAdInfo()

Zwroty ima.AdInfo:

Powrót do góry

Class ima.Companion

Pola

apiFramework, creativeType, height, trackingEvents, url, width

Metody

createCompanion

Zawiera informacje o kreacjach towarzyszących reklamy.

Właściwości

Nazwa	Typ	Opis
apiFramework		Interfejs API wymagany do wyświetlenia tej reklamy lub „Nieprawidłowy”, jeśli interfejs API jest niedostępny.
creativeType		Reprezentuje typ kreacji, zwykle mimetype.
height		Wysokość elementu towarzyszącego w pikselach. 0, jeśli jest niedostępna.
trackingEvents		Mapa zdarzeń śledzonych, w której kluczem jest zdarzenie, a wartością jest lista adresów URL, do których wysyłane są pingi po wystąpieniu danego zdarzenia.
url		Adres URL zasobu statycznego tego filmu.
width		Szerokość elementu towarzyszącego w pikselach. 0, jeśli jest niedostępna.

createCompanion()

Zwroty ima.Companion:

Powrót do góry

Klasa ima.CuePoint

Pola

end, hasPlayed, start

Metody

createCuePoint

Zawiera informacje o punkcie wstawienia reklamy.

Właściwości

Nazwa	Typ	Opis
end		Czas zakończenia punktu wstawienia podany w sekundach. Odpowiada przerwie na reklamę.
hasPlayed		Wartość logiczna wskazująca, że punkt cuepoint został już odtworzony.
start		Czas rozpoczęcia punktu cue w sekundach. Odpowiada przerwie na reklamę.

createCuePoint()

Zwroty ima.CuePoint:

Powrót do góry

Klasa: ima.Error

Pola

id, info, type

Metody

createError

Obiekt przekazywany do modułu obsługi błędów, jeśli wystąpił błąd.

Właściwości

Nazwa	Typ	Opis
id		Identyfikator błędu. Lista kodów błędów znajduje się w konstancie ErrorEvent.
info		dodatkowe informacje o błędzie;
type		Zawsze ustawiaj na błąd, aby wskazać typ tego obiektu.

createError()

Zwroty ima.Error:

Powrót do góry

Class ima.ErrorEvent

Pola

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

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

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, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

Opcjonalnie: Jest wywoływany 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ływany 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ływany, gdy odtwarzacz powinien rozpocząć odtwarzanie pliku o danym adresie URL. Aby wczytać strumień, musisz zaimplementować tę metodę.

Parametr	Typ	Opis
streamInfo	ima.StreamInfo	Zawiera informacje potrzebne do odtworzenia treści.

Powrót do góry

Klasa: ima.StreamFormat

Pola

DASH, HLS

Określa format strumienia.

Właściwości

Nazwa	Typ	Opis
DASH
HLS

Powrót do góry

Klasa: ima.StreamInfo

Pola

format, manifest, streamId, streamType, subtitles

Metody

createStreamInfo

Informacje o strumieniu przekazywane przez pakiet SDK do odtwarzacza.

Właściwości

Nazwa	Typ	Opis
format		Format filmu: hls lub dash. Zdefiniowany w ima.StreamFormat.
manifest		Adres URL strumienia.
streamId		Unikalny identyfikator strumienia.
streamType		Typ filmu: na żywo lub na żądanie. Zdefiniowany w ima.StreamType.
subtitles		napisy (jeśli są dostępne); Nieprawidłowe.

createStreamInfo()

Zwroty ima.StreamInfo:

Powrót do góry

Klasa ima.StreamManager

Metody

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters, start

Obiekt do zarządzania odtwarzaniem strumienia.

addEventListener(event, callback)

Dodaje odbiornik dla określonego zdarzenia. Informacje o konstancie AdEvents dotyczącej obsługiwanych zdarzeń.

Parametr	Typ	Opis
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Zwroty ima.StreamManager:

Parametr	Typ	Opis
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Nieobsługiwane. Zamiast tego przekaż dane z reklamy towarzyszącej bezpośrednio do RAF. To już nie jest opcja.

getContentTime(streamTime)

Pobiera czas w milisekundach dla strumienia VOD, który reprezentuje czas trwania treści bez reklam. Więcej informacji znajdziesz w najczęstszych pytaniach. Aby uzyskać czas trwania treści w bieżącym strumieniu czasu w -1.

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

Parametr	Typ	Opis
streamTime	Integer	Czas w strumieniu.

getCuePoints()

Zwraca wszystkie punkty cue odpowiadające wszystkim przerwom na reklamę. Jest to możliwe tylko w przypadku treści wideo na żądanie, w przypadku których wszystkie przerwy na reklamę są znane z wyprzedzeniem. Wszystkie czasy to czas strumienia w sekundach. W przypadku strumieni interfejsu Cloud Stitching API właściwość hasPlayed każdego ima.CuePoint ma zawsze wartość false.

Zwraca Object: tablicę ze wszystkimi punktami cue.

getPreviousCuePoint(time)

Zwraca punkt wstawienia poprzedzający podany czas. Sygnał wskazuje przerwę na reklamę. Wszystkie czasy to czas strumienia w sekundach.

Zwraca ima.CuePoint: obiekt z danymi o początku, zakończeniu i odtworzeniu. ZwracaInvalid, jeśli nie ma dostępnego punktu cue.

Parametr	Typ	Opis
time	Float	Czas wyszukiwania, -1 wskazuje bieżący czas i zwraca Invalid dla wszystkich innych strumieni.

getStreamTime(contentTime)

Pobiera czas strumienia z czasu trwania treści VOD w milisekundach. Więcej informacji znajdziesz w najczęstszych pytaniach.

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

Parametr	Typ	Opis
contentTime	Integer	Czas trwania treści.

loadThirdPartyStream(streamManifest, streamSubtitle)

Ładuje metadane reklamy i wywołuje funkcję loadUrl z podawanymi danymi streamManifestUrl i streamSubtitle. Ta funkcja działa tylko wtedy, gdy typ żądania strumienia to ima.StreamType.POD_VOD.

Parametr	Typ	Opis
streamManifest	string	Adres URL manifestu strumienia z wstawionymi reklamami.
streamSubtitle	ifArray>|Invalid	Napisy są powiązane z strumieniem lub Invalid, jeśli nie ma żadnych napisów.

onMessage(msg)

Obsługuje wszystkie wiadomości pochodzące z obiektu Video. Musi być wywoływany w przypadku każdej wiadomości odebranej na porcie roMessagePort.

Parametr	Typ	Opis
msg	object	Komunikat z portu roVideo.

replaceAdTagParameters(adTagParameters)

Zastępuje wszystkie parametry tagu reklamy używane w żądaniach nadchodzących reklam w transmisji na żywo. Pamiętaj, że w przypadku strumieni VOD ta metoda nie działa.

Parametr	Typ	Opis
adTagParameters	string	Nowe parametry tagu reklamy.

start()

Rozpoczyna odtwarzanie strumienia.

Powrót do góry

Klasa: ima.StreamRequest

Pola

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, ppid, streamActivityMonitorId, videoId, videoObject, videoStitcherSessionOptions

Metody

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

Używane 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. Więcej informacji znajdziesz w artykule Dodawanie parametrów kierowania do strumienia. Do ustawienia preferencji dotyczącej wariantu strumienia możesz też użyć parametrów dai-ot i dai-ov. Więcej informacji znajdziesz w artykule Zastępowanie parametrów wersji strumienia.
adUiNode		Węzeł grafu sceny, w którym wyświetla się interfejs reklamy. Podczas wyświetlania reklam IMA umieszcza na tym elemencie przyciski takie jak Dlaczego ta reklama i Pomiń. Element musi nakładać się na cały element wideo.
apiKey		Opcjonalnie: Można ich używać do uwierzytelniania żądań strumieni. Klucze uwierzytelniania DAI należy skonfigurować w interfejsie DFP.
assetKey		Wymagany w przypadku transmisji na żywo. Służy do określenia, który strumień powinien być odtwarzany. Klucz zasobu transmisji na żywo to identyfikator, który można znaleźć w interfejsie DFP.
authToken		Token autoryzacji żądania strumienia. Używany zamiast klucza API w celu uzyskania bardziej rygorystycznej autoryzacji treści. Wydawca może kontrolować uprawnienia do poszczególnych strumieni treści na podstawie tego tokena.
contentSourceId		Wymagane w przypadku strumieniowania na żądanie. Parametr cmsid pochodzi ze źródła treści wideo DFP w interfejsie DFP.
customAssetKey		Klucz zasobu niestandardowego służy do określenia, który strumień powinien być odtwarzany. Niestandardowe klucze plików są wymagane do obsługi żądań strumienia podrzędnego.
format		Format strumienia. Domyślna wartość to ima.StreamFormat.HLS.
networkCode		Kod sieci wydawcy przesyłającego żądanie strumienia. Kody sieci są wymagane w przypadku żądań strumienia do wyświetlania bloków reklamowych przesłanych za pomocą metod createPodLiveStreamRequest lub createPodVodStreamRequest. Te kody są również wymagane w przypadku żądań strumienia łączenia w chmurze wykonanych za pomocą metod createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest lub createVideoStitcherVodStreamRequestWithVodConfig. Te kody są opcjonalne i zalecane w przypadku żądań strumieniowania z pełną obsługą usługi utworzonych za pomocą createLiveStreamRequest lub createVodStreamRequest. Dodanie kodu sieci powoduje zastosowanie ustawień wybranych w interfejsie Ad Managera, np. włączenia reklamy ograniczonej w ramach automatyzacji. W przypadku wyświetlania bloków reklamowych i łączenia w chmurze dodanie kodu sieciowego umożliwia odnalezienie i odtworzenie strumienia. Aby znaleźć kod sieci, zapoznaj się z tym artykułem.
player		Implementacja interfejsu odtwarzacza.
ppid		Rola wycofana. Użyj parametru adTagParameters. Opcjonalnie: Identyfikator podany przez wydawcę w grupie odbiorców DFP.
streamActivityMonitorId		Identyfikator służący 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.
videoId		Wymagane w przypadku strumieniowania na żądanie. Identyfikator źródła treści wideo.
videoObject		Obiekt wideo (np. obiekt roSGNode wideo) odpowiedzialny za odtwarzanie filmu w aplikacji klienta. Ten obiekt będzie sondowany pod kątem różnych danych, które będą wykorzystywane do prawidłowego określania czasu zdarzeń HLS ID3 na żywo.
videoStitcherSessionOptions		Opcje sesji służą do ustawiania parametrów charakterystycznych dla nalepki wideo w przypadku żądań strumienia VideoStitcher.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Inicjuje wymagane właściwości obiektu na żywo StreamRequest. Korzystanie z tego interfejsu API powoduje, że wszystkie inne właściwości dotyczące StreamType są ignorowane. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, nastąpi odnotowanie błędu, a interfejs API zwróci ogólny obiekt StreamRequest, w którym nie będą uwzględniane żadne właściwości.

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

Parametr	Typ	Opis
assetKey	string
apiKey	string	Parametr przypisany do zwracanej właściwości ima.StreamRequest ima.StreamRequest.apiKey. Jeśli klucz API nie istnieje, prześlij pusty ciąg.
networkCode	string	Kod sieci wydawcy przesyłającego żądanie strumienia. Podanie kodu sieci jest opcjonalne, ale zalecane.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inicjuje wymagane właściwości Pod Live ima.StreamRequest. Korzystanie z tego interfejsu API powoduje, że wszystkie inne właściwości dotyczące ima.StreamType są ignorowane. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, nastąpi rejestrowanie błędów, a interfejs API zwróci ogólny element StreamRequest, ignorując wszystkie właściwości.

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

Parametr	Typ	Opis
customAssetKey	string
networkCode	string
apiKey	string	Opcjonalny parametr przypisany do zwracanej właściwości ima.StreamRequest: ima.StreamRequest.apiKey; domyślnie jest to pusty ciąg znaków.

createPodVodStreamRequest(networkCode)

Inicjowanie wymaganych właściwości obiektu ima.StreamRequest w celu zarejestrowania strumienia VOD podczas korzystania z wyświetlania bloków reklamowych w ramach DAI z zewnętrznym zszywaniem filmów. Ta funkcja ustawia typ żądania na ima.StreamType.POD_VOD i sprawdza, czy brakujących danych nie ma we wszystkich wymaganych właściwościach. Nieudane weryfikacje zostaną zarejestrowane w konsoli debugowania.

Zwraca StreamRequest: obiekt ima.StreamRequest. Jeśli wszystkie wymagane właściwości są określone, typ żądania jest ustawiony 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 obiektu Video Stitcher Live StreamRequest. Korzystanie z tego interfejsu API powoduje, że wszystkie inne właściwości dotyczące StreamType są ignorowane. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, nastąpi odnotowanie błędu, a interfejs API zwróci ogólny parametr StreamRequest, ignorując wszystkie właściwości.

Zwraca ima.StreamRequest: obiekt 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)

Inicjowanie wymaganych właściwości VOD narzędzia Video StitcherStreamRequest. Korzystanie z tego interfejsu API powoduje, że wszystkie inne właściwości dotyczące StreamType są ignorowane. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, nastąpi odnotowanie błędu, a interfejs API zwróci ogólny obiekt StreamRequest, w którym nie będą uwzględniane żadne właściwości.

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

Parametr	Typ	Opis
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Inicjuje wymagane właściwości VOD narzędzia Video Stitcher StreamRequest za pomocą vodConfigId utworzonego z narzędzia do łączenia treści wideo w chmurze. Korzystanie z tego interfejsu API powoduje, że wszystkie inne właściwości dotyczące StreamType są ignorowane. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, nastąpi odnotowanie błędu, a interfejs API zwróci ogólny parametr StreamRequest, ignorując wszystkie właściwości.

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

Parametr	Typ	Opis
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Inicjuje wymagane właściwości VOD ima.StreamRequest. Korzystanie z tego interfejsu API powoduje zignorowanie wszystkich innych właściwości ima.StreamType. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, nastąpi rejestrowanie błędów, a interfejs API zwróci ogólny element StreamRequest, ignorując wszystkie właściwości.

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

Parametr	Typ	Opis
contentSourceId	string
videoId	string
apiKey	string	Parametr przypisany do zwracanej właściwości ima.StreamRequest ima.StreamRequest.apiKey. Jeśli klucz API nie istnieje, prześlij pusty ciąg.
networkCode	string	Kod sieci wydawcy przesyłającego żądanie strumienia. Podanie kodu sieci jest opcjonalne, ale zalecane.

Powrót do góry

Klasa: ima.StreamType

Pola

NA ŻYWO, VOD

Określa typ strumienia, który ma odtwarzać odtwarzacz. Filmy w ramach reklam w ramach treści VOD powinny być odtwarzane od początku.

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

adId, adSystem, creativeAdId, creativeId, dealId

Metody

createWrapperInfo

Zawiera informacje o opakowaniu.

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

Zwroty ima.WrapperInfo:

Powrót do góry