MediationBannerListener

public interface MediationBannerListener

Callback for an adapter to communicate back to the mediation library. Events must be communicated back for the mediation library to properly manage ad flow.

The onAdClicked(MediationBannerAdapter) method in particular is required for metrics to operate correctly.

Public Method Summary

abstract void
onAdClicked(MediationBannerAdapter adapter)
Indicates that the user has clicked on this ad.
abstract void
onAdClosed(MediationBannerAdapter adapter)
Indicates that the ad control rendered something in full screen and is now transferring control back to the application.
abstract void
onAdFailedToLoad(MediationBannerAdapter adapter, int error)
Indicates that an ad request has failed along with the underlying cause.
abstract void
onAdLeftApplication(MediationBannerAdapter adapter)
Indicates that the ad is causing the device to switch to a different application (such as a web browser).
abstract void
onAdLoaded(MediationBannerAdapter adapter)
Indicates that an ad has been requested and successfully received.
abstract void
onAdOpened(MediationBannerAdapter adapter)
Indicates that the ad control is rendering something that is full screen.

Public Methods

public abstract void onAdClicked (MediationBannerAdapter adapter)

Indicates that the user has clicked on this ad. This is used for publisher metrics, and must be called in addition to any other events; this event is never inferred by the mediation library. For example, onAdLeftApplication(MediationBannerAdapter) would generally mean that the user has clicked on an ad, but onAdClicked(MediationBannerAdapter) must be called regardless.

Parameters
adapter The mediation adapter which raised the event.

public abstract void onAdClosed (MediationBannerAdapter adapter)

Indicates that the ad control rendered something in full screen and is now transferring control back to the application. This may be the user returning from a different application.

Parameters
adapter The mediation adapter which raised the event.

public abstract void onAdFailedToLoad (MediationBannerAdapter adapter, int error)

Indicates that an ad request has failed along with the underlying cause. A failure may be an actual error or just a lack of fill.

Once an ad is requested, the adapter must report either success or failure. If no response is heard within a time limit, the mediation library may move on to another adapter, resulting in a potentially successful ad not being shown.

Parameters
adapter The mediation adapter which raised the event.
error An error code detailing the cause of the failure.

public abstract void onAdLeftApplication (MediationBannerAdapter adapter)

Indicates that the ad is causing the device to switch to a different application (such as a web browser). This must be called before the current application is put in the background.

Parameters
adapter The mediation adapter which raised the event.

public abstract void onAdLoaded (MediationBannerAdapter adapter)

Indicates that an ad has been requested and successfully received. Banner ads may be automatically displayed after this method has been called.

Once an ad is requested, the adapter must report either success or failure. If no response is heard within a time limit, the mediation library may move on to another adapter, resulting in a potentially successful ad not being shown.

From the point when this method is called until the adapter is destroyed, getBannerView() must return a View object; null is not permitted. The same View object must be returned on every request.

Parameters
adapter The mediation adapter which raised the event.

public abstract void onAdOpened (MediationBannerAdapter adapter)

Indicates that the ad control is rendering something that is full screen. This may be an Activity, or it may be a precursor to switching to a different application.

Once this screen is dismissed, onAdClosed(MediationBannerAdapter) must be called.

Parameters
adapter The mediation adapter which raised the event.

Send feedback about...

Need help? Visit our support page.