com.google.ads.mediation

Interface 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 onClick(MediationBannerAdapter) method in particular is required for metrics to operate correctly.

Method Summary

Methods

Modifier and Type	Method and Description
void	onClick(MediationBannerAdapter<?,?> adapter) Indicates that the user has clicked on this ad.
void	onDismissScreen(MediationBannerAdapter<?,?> adapter) Indicates that the ad control rendered something in full screen and is now transferring control back to the application.
void	onFailedToReceiveAd(MediationBannerAdapter<?,?> adapter, AdRequest.ErrorCode error) Indicates that an ad request has failed along with the underlying cause.
void	onLeaveApplication(MediationBannerAdapter<?,?> adapter) Indicates that the ad is causing the device to switch to a different application (such as a web browser).
void	onPresentScreen(MediationBannerAdapter<?,?> adapter) Indicates that the ad control is rendering something that is full screen.
void	onReceivedAd(MediationBannerAdapter<?,?> adapter) Indicates that an ad has been requested and successfully received.

Method Detail

onReceivedAd

void onReceivedAd(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, MediationBannerAdapter.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.

See Also:

onFailedToReceiveAd(MediationBannerAdapter, AdRequest.ErrorCode)

onFailedToReceiveAd

void onFailedToReceiveAd(MediationBannerAdapter<?,?> adapter,
                       AdRequest.ErrorCode 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.

See Also:

onReceivedAd(MediationBannerAdapter)

onPresentScreen

void onPresentScreen(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, onDismissScreen(MediationBannerAdapter) must be called.

Parameters:

adapter - The mediation adapter which raised the event.

onDismissScreen

void onDismissScreen(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.

See Also:

onPresentScreen(MediationBannerAdapter)

onLeaveApplication

void onLeaveApplication(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.

onClick

void onClick(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, onLeaveApplication(MediationBannerAdapter) would generally mean that the user has clicked on an ad, but onClick(MediationBannerAdapter) must be called regardless.

Parameters:

adapter - The mediation adapter which raised the event.