Package org.prebid.mobile

Class AdUnit

java.lang.Object
org.prebid.mobile.AdUnit
Direct Known Subclasses:
BannerBaseAdUnit, NativeAdUnit, VideoBaseAdUnit
public abstract class AdUnit extends Object
Base ad unit for the original API.

  • Field Details

    • configuration

      protected AdUnitConfiguration configuration

    • bidLoader

      protected BidLoader bidLoader

    • adObject

      protected Object adObject

    • bidResponse

      protected BidResponse bidResponse

    • visibilityMonitor

      protected final VisibilityMonitor visibilityMonitor

    • adViewReference

      protected WeakReference<android.view.View> adViewReference

    • allowNullableAdObject

      protected boolean allowNullableAdObject

    • activateInterstitialPrebidImpressionTracker

      protected boolean activateInterstitialPrebidImpressionTracker

  • Constructor Details

    • AdUnit

      public AdUnit(String configId)

  • Method Details

    • setAutoRefreshPeriodMillis

      @Deprecated public void setAutoRefreshPeriodMillis(int periodMillis)
      Deprecated.
      Please use setAutoRefreshInterval() in seconds!

    • setAutoRefreshInterval

      public void setAutoRefreshInterval(int seconds)
      Auto refresh interval for banner ad.

    • resumeAutoRefresh

      public void resumeAutoRefresh()
      Resumes auto refresh interval after stopping.

    • stopAutoRefresh

      public void stopAutoRefresh()
      Stops auto refresh interval.

    • destroy

      public void destroy()
      Destroy ad unit and stop downloading.

    • fetchDemand

      @Deprecated public void fetchDemand(OnCompleteListener2 listener)
      Deprecated.
      Use fetchDemand(OnFetchDemandResult).

    • fetchDemand

      public void fetchDemand(Object adObject, OnCompleteListener listener)
      Loads ad and applies keywords to the ad object.
      Parameters:
      adObject - AdMob's (AdManagerAdRequest or AdManagerAdRequest.Builder) or AppLovin's (MaxNativeAdLoader) ad object
      listener - callback when operation is completed (success or fail)

    • fetchDemand

      public void fetchDemand(OnFetchDemandResult listener)
      Loads ad and saves it to cache.
      Parameters:
      listener - callback when operation is completed (success or fail)

    • activatePrebidImpressionTracker

      public void activatePrebidImpressionTracker(android.view.View adView)
      Applies the native visibility tracker for tracking `burl` url.
      Parameters:
      adView - the ad view object (f.e. AdManagerAdView)

    • addContextData

      @Deprecated public void addContextData(String key, String value)
      Deprecated.
      This method obtains the context data keyword invalid input: '&' value for adunit context targeting if the key already exists the value will be appended to the list. No duplicates will be added

    • updateContextData

      @Deprecated public void updateContextData(String key, Set<String> value)
      Deprecated.
      This method obtains the context data keyword invalid input: '&' values for adunit context targeting the values if the key already exist will be replaced with the new set of values

    • removeContextData

      @Deprecated public void removeContextData(String key)
      Deprecated.
      This method allows to remove specific context data keyword invalid input: '&' values set from adunit context targeting

    • clearContextData

      @Deprecated public void clearContextData()
      Deprecated.
      This method allows to remove all context data set from adunit context targeting

    • addExtData

      public void addExtData(String key, String value)
      This method obtains the context data keyword invalid input: '&' value for adunit context targeting if the key already exists the value will be appended to the list. No duplicates will be added

    • updateExtData

      public void updateExtData(String key, Set<String> value)
      This method obtains the context data keyword invalid input: '&' values for adunit context targeting the values if the key already exist will be replaced with the new set of values

    • removeExtData

      public void removeExtData(String key)
      This method allows to remove specific context data keyword invalid input: '&' values set from adunit context targeting

    • clearExtData

      public void clearExtData()
      This method allows to remove all context data set from adunit context targeting

    • addContextKeyword

      @Deprecated public void addContextKeyword(String keyword)
      Deprecated.
      Use addExtKeyword
      This method obtains the context keyword for adunit context targeting Inserts the given element in the set if it is not already present.

    • addContextKeywords

      @Deprecated public void addContextKeywords(Set<String> keywords)
      Deprecated.
      Use addExtKeywords
      This method obtains the context keyword set for adunit context targeting Adds the elements of the given set to the set.

    • removeContextKeyword

      @Deprecated public void removeContextKeyword(String keyword)
      Deprecated.
      Use removeExtKeyword
      This method allows to remove specific context keyword from adunit context targeting

    • clearContextKeywords

      @Deprecated public void clearContextKeywords()
      Deprecated.
      Use clearExtKeywords
      This method allows to remove all keywords from the set of adunit context targeting

    • addExtKeyword

      @Deprecated public void addExtKeyword(String keyword)
      Deprecated.
      imp.ext.context.keywords doesn't exist

    • addExtKeywords

      @Deprecated public void addExtKeywords(Set<String> keywords)
      Deprecated.
      imp.ext.context.keywords doesn't exist

    • removeExtKeyword

      public void removeExtKeyword(String keyword)
      This method allows to remove specific context keyword from adunit context targeting

    • clearExtKeywords

      public void clearExtKeywords()
      This method allows to remove all keywords from the set of adunit context targeting

    • setAppContent

      @Deprecated public void setAppContent(ContentObject content)
      Deprecated.
      In the upcoming major release, the method will be removed. Please, use TargetingParams.setGlobalOrtbConfig method instead. This method obtains the content for adunit, content, in which impression will appear

    • getAppContent

      @Deprecated public ContentObject getAppContent()
      Deprecated.
      In the upcoming major release, the method will be removed. Please, use TargetingParams.getGlobalOrtbConfig method instead.

    • addUserData

      @Deprecated public void addUserData(DataObject dataObject)
      Deprecated.
      In the upcoming major release, the method will be removed. Please, use TargetingParams.setGlobalOrtbConfig method instead.

    • getUserData

      @Deprecated public ArrayList<DataObject> getUserData()
      Deprecated.
      In the upcoming major release, the method will be removed.Please, use TargetingParams.getGlobalOrtbConfig method instead.

    • clearUserData

      @Deprecated public void clearUserData()
      Deprecated.
      In the upcoming major release, the method will be removed. Please, use TargetingParams.setGlobalOrtbConfig method instead.

    • getPbAdSlot

      public String getPbAdSlot()

    • setPbAdSlot

      public void setPbAdSlot(String pbAdSlot)

    • getGpid

      public String getGpid()

    • setGpid

      public void setGpid(String gpid)

    • setOrtbConfig

      @Deprecated(since="2.2.3", forRemoval=true) public void setOrtbConfig(String config)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use TargetingParams.setGlobalOrtbConfig(String) or setImpOrtbConfig(String).

    • getImpOrtbConfig

      public String getImpOrtbConfig()

    • setImpOrtbConfig

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

    • createBidListener

      protected BidRequesterListener createBidListener(OnCompleteListener originalListener)

    • convertToResultCode

      protected ResultCode convertToResultCode(AdException renderingException)

    • getConfiguration

      public AdUnitConfiguration getConfiguration()