MoPubInterstitial /1.13.0.0

• Public Methods

public class MoPubInterstitial

The object representing a MoPub interstitial ad, and associated methods.

Public Methods

public void /destroy() /+1.13.0.0

• Description: Removes existing interstitial instance in session. Used when finished showing an ad to free up existing resources.

• Parameters: None.

public void /forceRefresh() /+1.13.0.0

• Description: Manually sends out a new ad request that is initiated by the publisher. Used to issue a new ad request and start a new refresh cycle.

• Parameters: None.

public MoPubInterstitial.InterstitialAdListener /getInterstitialAdListener() /+1.13.0.0

• Description: Returns InterstitialAdListener, the ad listener associated with the current interstitial ad object.

• Parameters: None.

public String /getKeywords() /+1.13.0.0

• Description: Returns any non-user-identifiable keywords that have been set on the current banner object. Null if no keywords have been set.

• Parameters: None.

public Map<String, Object> /getLocalExtras() /+1.13.0.0

• Description: Returns a map of key-value pairs that have been set on the current interstitial object to be used later. Null if no local extras are set.

• Parameters: None.

public Location /getLocation() /+1.13.0.0

• Description: Deprecated as of release 5.12.0. Will be removed in the future. Returns a location object set on the current interstitial object. Null if no location has been set.

• Parameters: None.

public String /getUserDataKeywords() /+5.0.0

• Description: Returns any user-identifiable keywords that have been set on the current banner object. Null if no keywords have been set.

• Parameters: None.

public boolean /isReady() /+1.13.0.0

• Description: Returns true if the interstitial has been successfully cached and is ready to be shown; false otherwise.

• Parameters: None.

public void /load() /+1.13.0.0

• Description: Issues an ad request. Should only be called after initializing the SDK with initializeSdk().

public void /setInterstitialAdListener(MoPubInterstitial.InterstitialAdListener listener) /+1.13.0.0

• Description: Registers a listener for the current ad object to be informed of the ad’s lifecycle events.

• Parameters:

  • listener: An object contains listeners corresponding to the interstitial’s lifecycle events.

public void /setKeywords(String keywords) /+1.13.0.0

• Description: Optionally used to specify non-user-identifiable keywords on the current banner object to pass in the ad request for ad targeting.

• Parameters:

  • keywords: A String containing data to be passed to the current banner ad object.

public void /setLocalExtras(Map<String, Object> extras) /+1.13.0.0

• Description: Specifies a map of key-value pairs on the current interstitial object to be passed in the ad request for ad targeting. Used to append additional data for mediation.

• Parameters:

  • extras: A Map containing key-value pairs to be passed.

public void /setUserDataKeywords(String userDataKeywords) /+5.0.0

• Description: In GDPR-applicable cases, specifies user-identifiable keywords on the current interstitial object to be passed in the ad request for targeting.

• Parameters:

  • userDataKeywords: A String containing user-identifiable data to be passed to the current interstitial ad object.

public boolean /show() /+1.13.0.0

• Description: Attempts to display an interstitial ad if it is ready. (To confirm that an ad is cached, isReady() can be called.) Returns true if the ad is ready; false otherwise.

• Parameters: None.