Class BaseInterstitialAdUnit
-
- All Implemented Interfaces:
public abstract class BaseInterstitialAdUnitInternal base interstitial ad unit for rendering API.
-
-
Field Summary
Fields Modifier and Type Field Description public BidResponsebidResponse
-
Method Summary
Modifier and Type Method Description BidResponsegetBidResponse()voidloadAd()Executes ad loading if no request is running. booleanisLoaded()voidshow()Executes interstitial display if auction winner is defined. StringgetImpOrtbConfig()voidsetImpOrtbConfig(String ortbConfig)Sets imp level OpenRTB config JSON string that will be merged with the original imp object in the bid request. StringgetGlobalOrtbConfig()voidsetGlobalOrtbConfig(String ortbConfig)Sets the global OpenRTB configuration string for the ad unit. StringgetPbAdSlot()voidsetPbAdSlot(String adSlot)voidsetSkipDelay(int secondsDelay)Sets delay in seconds to show skip or close button. voidsetSkipButtonArea(double buttonArea)Sets skip button percentage size in range from 0.05 to 1. voidsetSkipButtonPosition(Position skipButtonPosition)Sets skip button position on the screen. voidsetIsMuted(boolean isMuted)voidsetIsSoundButtonVisible(boolean isSoundButtonVisible)voidsetMaxVideoDuration(int seconds)voidsetCloseButtonArea(double closeButtonArea)Sets close button percentage size in range from 0.05 to 1. voidsetCloseButtonPosition(Position closeButtonPosition)Sets close button position on the screen. voiddestroy()Cleans up resources when destroyed. -
-
Method Detail
-
getBidResponse
BidResponse getBidResponse()
-
loadAd
void loadAd()
Executes ad loading if no request is running.
-
isLoaded
boolean isLoaded()
- Returns:
true if auction winner was defined, false otherwise
-
show
void show()
Executes interstitial display if auction winner is defined.
-
getImpOrtbConfig
String getImpOrtbConfig()
-
setImpOrtbConfig
void setImpOrtbConfig(String ortbConfig)
Sets imp level OpenRTB config JSON string that will be merged with the original imp object in the bid request. Expected format:
"{"new_field": "value"}".- Parameters:
ortbConfig- JSON config string.
-
getGlobalOrtbConfig
String getGlobalOrtbConfig()
-
setGlobalOrtbConfig
void setGlobalOrtbConfig(String ortbConfig)
Sets the global OpenRTB configuration string for the ad unit. It takes precedence over `Targeting.setGlobalOrtbConfig`. Expected format:
"{"new_field": "value"}".- Parameters:
ortbConfig- The global OpenRTB JSON configuration string to set.
-
getPbAdSlot
String getPbAdSlot()
-
setPbAdSlot
void setPbAdSlot(String adSlot)
-
setSkipDelay
void setSkipDelay(int secondsDelay)
Sets delay in seconds to show skip or close button.
-
setSkipButtonArea
void setSkipButtonArea(double buttonArea)
Sets skip button percentage size in range from 0.05 to 1. If value less than 0.05, size will be default.
-
setSkipButtonPosition
void setSkipButtonPosition(Position skipButtonPosition)
Sets skip button position on the screen. Suitable values TOP_LEFT and TOP_RIGHT. Default value TOP_RIGHT.
-
setIsMuted
void setIsMuted(boolean isMuted)
-
setIsSoundButtonVisible
void setIsSoundButtonVisible(boolean isSoundButtonVisible)
-
setMaxVideoDuration
void setMaxVideoDuration(int seconds)
-
setCloseButtonArea
void setCloseButtonArea(double closeButtonArea)
Sets close button percentage size in range from 0.05 to 1. If value less than 0.05, size will be default.
-
setCloseButtonPosition
void setCloseButtonPosition(Position closeButtonPosition)
Sets close button position on the screen. Suitable values TOP_LEFT and TOP_RIGHT. Default value TOP_RIGHT.
-
destroy
void destroy()
Cleans up resources when destroyed.
-
-
-
-