MediationBannerListener

Kotlin |Java

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 method in particular is required for metrics to operate correctly.

Summary

Public methods
`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, @NonNull AdError adError )` Indicates that an ad request failed to load.
`abstract void`	`onAdFailedToLoad(MediationBannerAdapter adapter, int error)` This method is deprecated. Use `onAdFailedToLoad` instead.
`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

onAdClicked

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 would generally mean that the user has clicked on an ad, but onAdClicked must be called regardless.

Parameters
`MediationBannerAdapter adapter`	The mediation adapter which raised the event.

onAdClosed

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
`MediationBannerAdapter adapter`	The mediation adapter which raised the event.

See also
`onAdOpened`

onAdFailedToLoad

abstract void onAdFailedToLoad(
    MediationBannerAdapter adapter,
    @NonNull AdError adError
)

Indicates that an ad request failed to load.

Parameters
`MediationBannerAdapter adapter`	The mediation adapter which raised the event.
`@NonNull AdError adError`	`AdError` detailing the cause of the failure.

See also
`onAdLoaded`

onAdFailedToLoad

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
`MediationBannerAdapter adapter`	The mediation adapter which raised the event.
`int error`	An error code detailing the cause of the failure.

See also
`onAdLoaded`

onAdLeftApplication

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
`MediationBannerAdapter adapter`	The mediation adapter which raised the event.

onAdLoaded

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.

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

Parameters
`MediationBannerAdapter adapter`	The mediation adapter which raised the event.

See also
`onAdFailedToLoad`

onAdOpened

abstract void onAdOpened(MediationBannerAdapter adapter)

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

Once this screen is dismissed, onAdClosed must be called.

Parameters
`MediationBannerAdapter adapter`	The mediation adapter which raised the event.