com.amazon.device.ads

Class ModelessInterstitialAd

java.lang.Object

com.amazon.device.ads.ModelessInterstitialAd

All Implemented Interfaces:

Ad

public class ModelessInterstitialAd
extends java.lang.Object
implements Ad

A modeless interstitial ad. It will display in a given view within the application. The application is responsible for informing the ad when it is shown and hidden. When the ad is shown, it registers as an impression and click events will be allowed. Only one InterstitialAd or ModelessInterstitialAd may be shown at a time, but any number of instances can be created and loaded.

Making ad requests to the Amazon Mobile Ad Network requires the INTERNET permission. Additionally we recommend that you include permissions for FINE_LOCATION, COURSE_LOCATION, NETWORK_STATE, and WIFI_STATE. These additional permissions allow Amazon to provide contextual and geo-targeted ads to your users, which may result in higher CPMs. Declare these permissions in your AndroidManifest.xml.

Constructor Summary

Constructors

Constructor and Description
ModelessInterstitialAd(android.view.ViewGroup hostedViewGroup) Constructs a new ModelessInterstitialAd.

Method Summary

Modifier and Type	Method and Description
void	adHidden() Puts the ad into a background state.
boolean	adShown() Fires impression pixel and makes ad clickable if the following criteria is met: 1.
void	destroy() Destroys all the resources being used by the ModelessInterstitialAd.
int	getTimeout() Gets the current timeout value in milliseconds.
boolean	isLoading() Gets whether this Ad is currently being loaded.
boolean	isReady() Tells whether this ModelessInterstitialAd is ready to show.
boolean	loadAd() Creates a background thread to load a new ad.
boolean	loadAd(AdTargetingOptions adTargetingOptions) Creates a background thread to load a new ad based on AdTargetingOptions.
void	setListener(AdListener adListener) Sets the listener used to track ad life-cycle events.
void	setTimeout(int timeout) Sets the timeout value for loading the ad.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelessInterstitialAd

public ModelessInterstitialAd(android.view.ViewGroup hostedViewGroup)

Constructs a new ModelessInterstitialAd.

Parameters:

hostedViewGroup - the hosting container that will contain the ad

Method Detail

setListener

public void setListener(AdListener adListener)

Sets the listener used to track ad life-cycle events. Only one listener can be assigned per Ad instance. Calling setListener a second time would overwrite the existing listener with the new listener.

Specified by:

setListener in interface Ad

Parameters:

adListener - An instance of AdListener that will be notified during ad life-cycle changes.

loadAd

public boolean loadAd(AdTargetingOptions adTargetingOptions)

Creates a background thread to load a new ad based on AdTargetingOptions. When the ad loads successfully AdListener.onAdLoaded(Ad, AdProperties) is called. When the ad fails to load the AdListener.onAdFailedToLoad(Ad, AdError) is called. An ad that is currently loaded will only be cleared if the new Ad.loadAd(AdTargetingOptions) call completes successfully.

Only one ad can be loading at a time. The Ad.loadAd(AdTargetingOptions) call will return true if a background thread is created to load a new ad, and false if the load ad request is ignored because there is currently a background thread in progress.

Making ad requests to the Amazon Mobile Ad Network requires the INTERNET permission. Additionally we recommend that you include permissions for FINE_LOCATION, COURSE_LOCATION, NETWORK_STATE, and WIFI_STATE. These additional permissions allow Amazon to provide contextual and geo-targeted ads to your users, which may result in higher CPMs. Declare these permissions in your AndroidManifest.xml.

Specified by:

loadAd in interface Ad

Parameters:

adTargetingOptions - Additional ad options. Use this parameter to set targeting settings

Returns:

Returns true if a background thread is created to load a new ad, and returns false if the load ad request is ignored because there is currently a background thread in progress or because the current ad is expanded.

loadAd

public boolean loadAd()

Creates a background thread to load a new ad.

Specified by:

loadAd in interface Ad

Returns:

Returns true if a background thread is created to load a new ad, and returns false if the load ad request is ignored because there is currently a background thread in progress or because the current ad is expanded.

isLoading

public boolean isLoading()

Gets whether this Ad is currently being loaded. Only one ad can be loading at a time. Use this method to check if a new Ad.loadAd(AdTargetingOptions) call can be made.

Specified by:

isLoading in interface Ad

Returns:

Returns true if an ad is currently being loaded, and false if there is no ad being loaded.

getTimeout

public int getTimeout()

Gets the current timeout value in milliseconds.

Specified by:

getTimeout in interface Ad

Returns:

The current timeout value in milliseconds.

setTimeout

public void setTimeout(int timeout)

Sets the timeout value for loading the ad. Loading starts when Ad.loadAd(AdTargetingOptions) is called. The default value is 20000 milliseconds.

Specified by:

setTimeout in interface Ad

Parameters:

timeout - The timeout in milliseconds.

adShown

public boolean adShown()

Fires impression pixel and makes ad clickable if the following criteria is met: 1. One size of the ad must be at least 380 device independent pixels 2. The ad must have an aspect ratio of 9/16 or greater 3. The ad must be fully on screen 4. The ad must cover at least 75% of the screen area Call adHidden() when the ad is no longer in view

Returns:

true if the ad meets the showing criteria, false otherwise

adHidden

public void adHidden()

Puts the ad into a background state. Call this method whenever the ad is off screen. This informs the ad that it is no longer displaying on screen. When the ad is put into a background state, it may reduce the resources needed, since it is aware the user is not currently viewing the ad. If the ad is put back onto the screen, make sure to call com.amazon.device.ads.ModelessInterstitial.adShown() again.

destroy

public void destroy()

Destroys all the resources being used by the ModelessInterstitialAd. This should be called if an ad has been loaded when the Activity is stopped

isReady

public boolean isReady()

Tells whether this ModelessInterstitialAd is ready to show. This ad will be ready to show if it has been successfully loaded and it has not expired

Returns:

true if this ModelessInterstitialAd is ready to show