Ta strona została przetłumaczona przez Cloud Translation API.

Klasa: reklama

Metody

getAdId

getAdId() zwraca ciąg znaków

Identyfikator reklamy służy do synchronizacji reklam głównych i towarzyszących.

Zwroty: string Identyfikator reklamy lub pusty ciąg znaków, jeśli ta informacja jest niedostępna.

getAdPodInformacje

getAdPodInfo() zwraca AdPodInfo

Zwraca informacje o bloku reklamowym.

Zwroty: non-null AdPodInfo Informacje o bloku reklamowym.

getAdSystem

getAdSystem() zwraca ciąg znaków

Informacje o źródłowym serwerze reklam uwzględnione w odpowiedzi na żądanie reklamy.

Zwroty: string Źródłowy serwer reklam reklamy lub pusty ciąg tekstowy, jeśli ta informacja jest niedostępna.

getAdvertiserName,

getAdvertiserName() zwraca ciąg znaków

Nazwa reklamodawcy zdefiniowana przez stronę, która wyświetla reklamy.

Zwroty: string Nazwa reklamodawcy lub pusty ciąg znaków, jeśli te informacje są niedostępne.

getApiFramework

getApiFramework() zwraca ciąg znaków

Określa interfejs API potrzebny do wykonania reklamy. Odpowiada to apiFramework określonemu w VAST.

Zwroty: nullable stringJeśli ta informacja jest niedostępna, platforma API musi wykonać reklamę lub ma wartość null.

pobieranie reklam towarzyszących

getCompanionAds(adSlotWidth, adSlotHeight, ustawienia) zwraca tablicę niepasującej reklamy towarzyszącej

Pobiera reklamy towarzyszące tej reklamy na podstawie rozmiaru boksu towarzyszącego. Opcjonalnie możesz wybrać ustawienia zaawansowanego wyboru. Pamiętaj, że ta metoda zwraca niepustą tablicę tylko w przypadku wystąpień reklam pozyskanych w wyniku zdarzenia STARTED lub później. W szczególności reklamy ze zdarzenia LOADED zwróci pustą tablicę.

Parametr
szerokośćboksareklam	liczba Szerokość boksu reklamowego towarzyszącego.
Wysokość boksu reklamowego	liczba Wysokość boksu reklamy towarzyszącej.
ustawienia	Opcjonalna Ustawienia wyboru reklamy towarzyszącej Ustawienia wyboru reklam towarzyszących. Wartość nie może być pusta.

Parametr

szerokośćboksareklam

liczba

Szerokość boksu reklamowego towarzyszącego.

Wysokość boksu reklamowego

liczba

Wysokość boksu reklamy towarzyszącej.

ustawienia

Opcjonalna

Ustawienia wyboru reklamy towarzyszącej

Ustawienia wyboru reklam towarzyszących.

Wartość nie może być pusta.

Zwroty: non-null Array of non-null CompanionAd Tablica reklam towarzyszących pasujących do ustawień i rozmiaru boksu.

getContentType

getContentType() zwraca ciąg znaków

Zwraca typ treści aktualnie wybranej kreacji lub pusty ciąg, jeśli nie wybrano żadnej kreacji lub typ treści jest niedostępny. W przypadku reklam linearnych typ treści będzie dostępny dopiero po wystąpieniu zdarzenia START po wybraniu pliku multimedialnego.

Zwroty: string Typ treści; pusty ciąg znaków, jeśli nie jest dostępny.

getCreativeAdId

getCreativeAdId() zwraca ciąg znaków

Zwraca kod ISCI (Industry Standard Commercial Identifier) reklamy lub pusty ciąg, jeśli kod jest niedostępny. To jest identyfikator reklamy w odpowiedzi VAST.

Zwroty: string

getCreativeId

getCreativeId() zwraca ciąg znaków

Pobiera identyfikator wybranej kreacji na potrzeby reklamy.

Zwroty: string Identyfikator wybranej kreacji na potrzeby reklamy lub pusty ciąg jeśli te informacje są niedostępne.

getDealId

getDealId() zwraca ciąg znaków

Zwraca pierwszy identyfikator umowy znajdujący się w łańcuchu kodu towarzyszącego bieżącej reklamie, począwszy od góry. Zwraca pusty ciąg, jeśli jest niedostępny.

Zwroty: string

pobieranie opisu

getDescription() zwraca ciąg znaków

Zwraca opis tej reklamy z odpowiedzi VAST.

Zwroty: string Jeśli nie podasz wartości, opis jest pusty.

getDuration

getDuration() liczba zwrotów

Zwraca czas trwania wybranej kreacji lub wartość -1 w przypadku kreacji nielinearnych.

Zwroty: number Wybrany czas trwania kreacji w sekundach – 1, jeśli nie jest linearny.

getHeight

getHeight() – liczba zwraca

Zwraca wysokość wybranej kreacji nielinearnej.

Zwroty: number Wysokość wybranej kreacji nielinearnej lub 0 w przypadku kreacji linearnej.

getMediaUrl,

getMediaUrl() – zwraca ciąg znaków

Zwraca adres URL pliku multimedialnego wybranego w reklamie na podstawie obecnie używanych ustawień wyboru multimediów. Jeśli ta informacja jest niedostępna, zwraca wartość null. Dostępne w przypadku wydarzenia STARTED.

Zwroty: nullable string

getMinSuggestedDuration

getMinSuggestedDuration() zwracana liczba

Zwraca minimalny sugerowany czas wyświetlania (w sekundach) kreacji nielinearnej. Zwraca wartość -2, jeśli minimalny sugerowany czas trwania jest nieznany. W przypadku kreacji linearnej zwraca cały czas trwania reklamy.

Zwroty: number Minimalny sugerowany czas trwania kreacji (w sekundach).

getSkipTimeOffset

getSkipTimeOffset() – liczba zwrotów

Liczba sekund odtwarzania reklamy, które można pominąć. W przypadku reklam niemożliwych do pominięcia lub jeśli ta opcja jest niedostępna, zwraca wartość -1.

Zwroty: number Przesunięcie w sekundach lub -1.

getUrlUrl

getSurveyUrl() zwraca ciąg znaków

Zwraca adres URL powiązany z ankietą dotyczącą danej reklamy. Jeśli jest niedostępny, zwraca wartość null.

Zwroty: nullable string

getTitle

getTitle() zwraca ciąg znaków

Zwraca tytuł tej reklamy z odpowiedzi VAST.

Zwroty: string – pusty tytuł bez wartości.

getTraffickingParameters,

getTraffickingParameters() zwraca obiekt z właściwościami ciągu znaków,

Pobiera parametry niestandardowe powiązane z reklamą w czasie trafikowania.

Zwroty: non-null Object with string propertiesMapowanie kluczy trafikingowych do ich wartości lub pusty obiekt, jeśli te informacje są niedostępne.

getTraffickingParametersString,

getTraffickingParametersString() zwraca ciąg znaków

Pobiera parametry niestandardowe powiązane z reklamą w czasie trafikowania. Zwraca nieprzetworzoną wersję analizowanych parametrów z getTraffickingParameters.

Zwroty: string Parametry trafikowania lub pusty ciąg tekstowy, jeśli te informacje są niedostępne.

getUiElements,

getUiElements() zwraca tablicę z ciągiem znaków

Zwraca elementy interfejsu wyświetlane podczas odtwarzania tej reklamy. Możliwe elementy zwróconej tablicy znajdują się w UiElements.

Zwroty: non-null Array of string Wyświetlane elementy interfejsu

getUniversalAdIdRegistry

getUniversalAdIdRegistry() zwraca ciąg znaków

Rejestr powiązany z katalogiem UniversalAdId wybranej kreacji dla reklamy.

Wycofano: Zamiast tego użyj ad.getUniversalAdIds()
Zwroty: string Zwraca wartość rejestru lub wartość „unknown” (nieznana).

getUniversalAdIdValue

getUniversalAdIdValue() zwraca ciąg znaków

Uniwersalny identyfikator wybranej kreacji dla reklamy.

Wycofano: Zamiast tego użyj ad.getUniversalAdIds()
Zwroty: string Zwraca wartość identyfikatora lub wartość „unknown” (nieznana), jeśli jest niedostępna.

getUniversalAdIds

getUniversalAdIds() Zwraca tablica niepustych danych UniversalAdIdInfo

Lista identyfikatorów UniversalAdId wybranej kreacji dla reklamy.

Zwroty: non-null Array of non-null UniversalAdIdInfo Zwraca listę identyfikatorów uniwersalnej reklamy, które mają zastosowanie do tej reklamy.

getVastMediaBitrate,

getVastMediaBitrate() – liczba zwraca

Gdy pakiet SDK wybierze zarówno kreację, jak i multimedia, zwracana jest szybkość transmisji bitów pliku multimedialnego podanego w odpowiedzi VAST.

Zwroty: number Szybkość transmisji bitów wybranego pliku multimedialnego lub wartość 0.

getVastMediaWysokość

getVastMediaHeight() – liczba zwracana

Zwraca wysokość multimediów VAST wybranej kreacji.

Zwroty: number Wysokość multimediów VAST wybranej kreacji lub wartość 0, jeśli nie wybrano żadnej.

getVastMediaWidth,

getVastMediaWidth() zwraca liczbę

Zwraca szerokość multimediów wybranej kreacji VAST.

Zwroty: number Szerokość mediów VAST wybranej kreacji lub wartość 0, jeśli nie wybrano żadnej.

getWidth

getWidth() zwraca liczbę

Zwraca szerokość wybranej kreacji.

Zwroty: number Szerokość wybranej kreacji nielinearnej lub 0 w przypadku kreacji linearnej.

getWrapperAdIds

getWrapperAdIds() zwraca tablicę ciągu

Identyfikatory reklam używane na potrzeby kodu towarzyszącego. Zwracane identyfikatory zaczynają się od reklamy w tekście (najbardziej wewnątrz) i przechodziją do reklamy znajdującej się najbardziej na zewnątrz. Jeśli nie ma reklam towarzyszących, zwracana jest pusta tablica.

Zwroty: non-null Array of string Identyfikatory reklam, od reklamy w tekście lub pusta tablica, jeśli nie ma reklam towarzyszących.

getWrapperAdSystems,

getWrapperAdSystems() zwraca tablicę ciągu

Systemy reklamowe używane na potrzeby reklam towarzyszących. Zwrócone systemy reklamowe zaczynają się od reklamy wbudowanej i przekierowują do reklamy znajdującej się najbardziej na zewnątrz. Jeśli nie ma reklam towarzyszących, zwracana jest pusta tablica.

Zwroty: non-null Array of string Systemy reklamowe, z których zaczyna się reklama wbudowana, lub pusta tablica, jeśli nie ma reklam towarzyszących.

getWrapperCreativeIds

getWrapperCreativeIds() zwraca tablicę ciągu

Wybrane identyfikatory kreacji używane w reklamach towarzyszących. Zwracane identyfikatory kreacji zaczynają się w reklamie wbudowanej i przechodzą do reklamy najbardziej otaczającej. Jeśli nie ma reklam towarzyszących, zwracana jest pusta tablica.

Zwroty: non-null Array of stringIdentyfikatory kreacji wyświetlanych w reklamie. Zacznij od reklamy wbudowanej lub pustej tablicy, jeśli nie ma reklam towarzyszących.

isLinear

isLinear() zwraca wartość logiczną

Wskazuje, czy bieżący tryb działania reklamy jest liniowy, czy nielinearny. Wartość „prawda” oznacza, że reklama jest w trybie odtwarzania linearnego, a jeśli „fałsz”, wskazuje tryb nielinearny. Odtwarzacz sprawdza właściwość linearną i aktualizuje stan zgodnie ze szczegółami miejsca docelowego reklamy. Gdy reklama jest w trybie linearnym, odtwarzacz wstrzymuje odtwarzanie treści. Jeśli reklama liniowa ma początkowo wartość Prawda, a reklama jest wyświetlana przed filmem (zdefiniowany na zewnątrz), odtwarzacz może opóźnić wczytanie treści wideo do końca.

Zwroty: boolean Prawda, jeśli reklama jest liniowa, lub fałsz.