Package org.prebid.mobile.api.rendering
Class BaseInterstitialAdUnit
- java.lang.Object
-
- org.prebid.mobile.api.rendering.BaseInterstitialAdUnit
-
- Direct Known Subclasses:
InterstitialAdUnit,RewardedAdUnit
public abstract class BaseInterstitialAdUnit extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description protected AdUnitConfigurationadUnitConfig
-
Constructor Summary
Constructors Modifier Constructor Description protectedBaseInterstitialAdUnit(android.content.Context context)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddContent(ContentObject content)voidaddContextData(java.lang.String key, java.lang.String value)Deprecated.use addExtDatavoidaddContextKeyword(java.lang.String keyword)Deprecated.use addExtKeywordvoidaddContextKeywords(java.util.Set<java.lang.String> keywords)Deprecated.use addExtKeywordsvoidaddExtData(java.lang.String key, java.lang.String value)voidaddExtKeyword(java.lang.String keyword)voidaddExtKeywords(java.util.Set<java.lang.String> keywords)voidaddUserData(DataObject dataObject)protected voidchangeInterstitialAdUnitState(org.prebid.mobile.api.rendering.BaseInterstitialAdUnit.InterstitialAdUnitState state)voidclearContextData()Deprecated.use clearExtDatavoidclearContextKeywords()Deprecated.use clearExtKeywordsvoidclearExtData()voidclearExtKeywords()voidclearUserData()voiddestroy()Cleans up resources when destroyed.ContentObjectgetAppContent()BidResponsegetBidResponse()protected android.content.ContextgetContext()java.util.Map<java.lang.String,java.util.Set<java.lang.String>>getContextDataDictionary()Deprecated.use getExtDataDictionaryjava.util.Set<java.lang.String>getContextKeywordsSet()Deprecated.use getExtKeywordsSetjava.util.Map<java.lang.String,java.util.Set<java.lang.String>>getExtDataDictionary()java.util.Set<java.lang.String>getExtKeywordsSet()java.lang.StringgetPbAdSlot()java.util.ArrayList<DataObject>getUserData()protected voidinit(AdUnitConfiguration adUnitConfiguration)protected booleanisBidInvalid()booleanisLoaded()voidloadAd()Executes ad loading if no request is running.protected voidloadPrebidAd()voidremoveContextData(java.lang.String key)Deprecated.use removeExtDatavoidremoveContextKeyword(java.lang.String keyword)Deprecated.use removeExtKeywordvoidremoveExtData(java.lang.String key)voidremoveExtKeyword(java.lang.String keyword)voidsetAppContent(ContentObject content)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.voidsetIsMuted(boolean isMuted)voidsetIsSoundButtonVisible(boolean isSoundButtonVisible)voidsetMaxVideoDuration(int seconds)voidsetPbAdSlot(java.lang.String adSlot)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.voidsetSkipDelay(int secondsDelay)Sets delay in seconds to show skip or close button.voidshow()Executes interstitial display if auction winner is defined.voidupdateContextData(java.lang.String key, java.util.Set<java.lang.String> value)Deprecated.use updateExtDatavoidupdateExtData(java.lang.String key, java.util.Set<java.lang.String> value)
-
-
-
Field Detail
-
adUnitConfig
protected AdUnitConfiguration adUnitConfig
-
-
Method Detail
-
loadAd
public void loadAd()
Executes ad loading if no request is running.
-
isLoaded
public boolean isLoaded()
- Returns:
- true if auction winner was defined, false otherwise
-
show
public void show()
Executes interstitial display if auction winner is defined.
-
addContextData
@Deprecated public void addContextData(java.lang.String key, java.lang.String value)Deprecated.use addExtData
-
updateContextData
@Deprecated public void updateContextData(java.lang.String key, java.util.Set<java.lang.String> value)Deprecated.use updateExtData
-
removeContextData
@Deprecated public void removeContextData(java.lang.String key)
Deprecated.use removeExtData
-
clearContextData
@Deprecated public void clearContextData()
Deprecated.use clearExtData
-
getContextDataDictionary
@Deprecated public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getContextDataDictionary()
Deprecated.use getExtDataDictionary
-
addContextKeyword
@Deprecated public void addContextKeyword(java.lang.String keyword)
Deprecated.use addExtKeyword
-
addContextKeywords
@Deprecated public void addContextKeywords(java.util.Set<java.lang.String> keywords)
Deprecated.use addExtKeywords
-
removeContextKeyword
@Deprecated public void removeContextKeyword(java.lang.String keyword)
Deprecated.use removeExtKeyword
-
getContextKeywordsSet
@Deprecated public java.util.Set<java.lang.String> getContextKeywordsSet()
Deprecated.use getExtKeywordsSet
-
clearContextKeywords
@Deprecated public void clearContextKeywords()
Deprecated.use clearExtKeywords
-
addExtData
public void addExtData(java.lang.String key, java.lang.String value)
-
updateExtData
public void updateExtData(java.lang.String key, java.util.Set<java.lang.String> value)
-
removeExtData
public void removeExtData(java.lang.String key)
-
clearExtData
public void clearExtData()
-
getExtDataDictionary
public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getExtDataDictionary()
-
addExtKeyword
public void addExtKeyword(java.lang.String keyword)
-
addExtKeywords
public void addExtKeywords(java.util.Set<java.lang.String> keywords)
-
removeExtKeyword
public void removeExtKeyword(java.lang.String keyword)
-
getExtKeywordsSet
public java.util.Set<java.lang.String> getExtKeywordsSet()
-
clearExtKeywords
public void clearExtKeywords()
-
setAppContent
public void setAppContent(ContentObject content)
-
getAppContent
public ContentObject getAppContent()
-
addUserData
public void addUserData(DataObject dataObject)
-
getUserData
public java.util.ArrayList<DataObject> getUserData()
-
clearUserData
public void clearUserData()
-
getPbAdSlot
public java.lang.String getPbAdSlot()
-
setPbAdSlot
public void setPbAdSlot(java.lang.String adSlot)
-
setSkipDelay
public void setSkipDelay(int secondsDelay)
Sets delay in seconds to show skip or close button.
-
setSkipButtonArea
public 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
public void setSkipButtonPosition(Position skipButtonPosition)
Sets skip button position on the screen. Suitable values TOP_LEFT and TOP_RIGHT. Default value TOP_RIGHT.
-
setIsMuted
public void setIsMuted(boolean isMuted)
-
setIsSoundButtonVisible
public void setIsSoundButtonVisible(boolean isSoundButtonVisible)
-
setMaxVideoDuration
public void setMaxVideoDuration(int seconds)
-
setCloseButtonArea
public 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
public void setCloseButtonPosition(Position closeButtonPosition)
Sets close button position on the screen. Suitable values TOP_LEFT and TOP_RIGHT. Default value TOP_RIGHT.
-
destroy
public void destroy()
Cleans up resources when destroyed.
-
init
protected void init(AdUnitConfiguration adUnitConfiguration)
-
loadPrebidAd
protected void loadPrebidAd()
-
getContext
protected android.content.Context getContext()
-
isBidInvalid
protected boolean isBidInvalid()
-
changeInterstitialAdUnitState
protected void changeInterstitialAdUnitState(org.prebid.mobile.api.rendering.BaseInterstitialAdUnit.InterstitialAdUnitState state)
-
getBidResponse
public BidResponse getBidResponse()
-
addContent
public void addContent(ContentObject content)
-
-