Class NativeBannerAd

java.lang.Object
com.my.target.common.BaseAd
com.my.target.nativeads.NativeBannerAd
All Implemented Interfaces:
INativeAd

public final class NativeBannerAd extends BaseAd implements INativeAd
The native banner does not support MediaAdView and therefore cannot display media content (video, cards, large image).
  • Constructor Details

    • NativeBannerAd

      public NativeBannerAd(int slotId, @NonNull android.content.Context context)
      Public constructor
      Parameters:
      slotId - your slot id
      context - app context
    • NativeBannerAd

      public NativeBannerAd(int slotId, @Nullable MenuFactory menuFactory, @NonNull android.content.Context context)
      Public constructor
      Parameters:
      slotId - your slot id
      context - app context
      menuFactory - menuFactory for drawing adChoices options
  • Method Details

    • getListener

      @Nullable public NativeBannerAd.NativeBannerAdListener getListener()
      Get events listener of an advertisement
      Returns:
      an instance of listener
      See Also:
    • setListener

      public void setListener(@Nullable NativeBannerAd.NativeBannerAdListener listener)
      Set events listener of an advertisement Must be called before load()
      See Also:
    • getBanner

      @Nullable public NativeBanner getBanner()
      Banner model for current ad. Null if not loaded
      Returns:
      NativeBanner
    • handleSection

      public void handleSection(@NonNull NativeAdSection section)
    • isMediationEnabled

      public boolean isMediationEnabled()
      Get enable/disable mediation flag
      Returns:
      flag
    • setMediationEnabled

      public void setMediationEnabled(boolean mediationEnabled)
      Enables/disables mediation for current ad. Default is true. Disabling this option may cause lower fill-rate
      Parameters:
      mediationEnabled - if true - enable mediation, otherwise not
    • getCachePolicy

      public int getCachePolicy()
      Retrieve current cachePolicy set previously
      Specified by:
      getCachePolicy in interface INativeAd
      Returns:
      current cachePolicy
      See Also:
    • setCachePolicy

      public void setCachePolicy(int cachePolicy)
      By default, images and videos are preloaded. You can turn off the automatic loading of images and videos, but keep in mind that downloading them will take extra time, which will create an additional delay in displaying ads in your application.
      Specified by:
      setCachePolicy in interface INativeAd
      Parameters:
      cachePolicy - cache policy needed CachePolicy
    • getAdChoicesPlacement

      public int getAdChoicesPlacement()
      Retrieve current position for AdChoices icon
      Specified by:
      getAdChoicesPlacement in interface INativeAd
      Returns:
      current adChoicesPlacement
      See Also:
    • setAdChoicesPlacement

      public void setAdChoicesPlacement(int adChoicesPlacement)
      Sets the place for AdChoices icon, by default used top-right position
      Specified by:
      setAdChoicesPlacement in interface INativeAd
      Parameters:
      adChoicesPlacement - position
      See Also:
    • load

      public void load()
      Start loading ads. In case of successful loading, the onLoad method will be called on the object passed as a listener, in case of loading error or if there is no advertisement to be shown - the onNoAd

      Ad listener should be added before this call

      Specified by:
      load in interface INativeAd
    • loadFromBid

      public void loadFromBid(@NonNull String bidId)
      Start loading ad with the bidding ID
      Specified by:
      loadFromBid in interface INativeAd
      Parameters:
      bidId - bidding ID
    • registerView

      public void registerView(@NonNull android.view.View view, @Nullable List<android.view.View> clickableViews)
      Registration of the Advertising view. Must be called before showing the ad
      Specified by:
      registerView in interface INativeAd
      Parameters:
      view - Advertising view
      clickableViews - specific clickable views inside Advertising view. If set, the only views in this list will be clickable. Otherwise, whole view will be clickable
    • registerView

      public void registerView(@NonNull android.view.View view)
      Registration of the Advertising view. Must be called before showing the ad
      Specified by:
      registerView in interface INativeAd
      Parameters:
      view - Advertising view
    • unregisterView

      public void unregisterView()
      View de-registration. Stops timers, frees resources. Must be called after view is no longer needed
      Specified by:
      unregisterView in interface INativeAd
    • handleData

      public void handleData(@NonNull String data)
      Loads data for s2s partners
      Specified by:
      handleData in interface INativeAd
      Parameters:
      data - s2s data
    • getAdSource

      @Nullable public String getAdSource()
      Get the name of source network. It always will be "myTarget" if no mediation enabled. returns null if ad is not loaded
      Returns:
      ad source
    • getAdSourcePriority

      public float getAdSourcePriority()
      Ad Source Priority is the value representing current ad network place in the queue of received advertisements. Works only with mediation. 0f if not loaded yet.
      Returns:
      priority of ad source network
    • getAdChoicesOptionListener

      @Nullable public NativeBannerAd.NativeBannerAdChoicesOptionListener getAdChoicesOptionListener()
      Returns listener for ad choice menu.
      Returns:
      Object which implements NativeBannerAd.NativeBannerAdChoicesOptionListener interface.
    • setAdChoicesOptionListener

      public void setAdChoicesOptionListener(@Nullable NativeBannerAd.NativeBannerAdChoicesOptionListener adChoicesOptionListener)
      Sets listener for ad choice menu.
      Parameters:
      adChoicesOptionListener - Object which implements NativeBannerAd.NativeBannerAdChoicesOptionListener interface.
    • getMediaListener

      @Nullable public NativeBannerAd.NativeBannerAdMediaListener getMediaListener()
      Gets listener for media objects events, such as icon loading
      Returns:
      listener object
      See Also:
    • setMediaListener

      public void setMediaListener(@Nullable NativeBannerAd.NativeBannerAdMediaListener mediaListener)
      Sets listener for media objects events, such as icon loading
      Parameters:
      mediaListener - listener object
      See Also:
    • getAdChoicesListener

      @Nullable public NativeBannerAd.NativeBannerAdChoicesListener getAdChoicesListener()
      Returns:
      events listener of adChoices icon load Must be called before load()
      See Also:
    • setAdChoicesListener

      public void setAdChoicesListener(@Nullable NativeBannerAd.NativeBannerAdChoicesListener adChoicesListener)
      Set events listener of adChoices icon load Must be called before load()
      See Also:
    • handleAdChoicesClick

      public void handleAdChoicesClick(@NonNull android.content.Context context)
      Call to display adChoices options whose implementation has been passed using MenuFactory.