MediationNativeListener

public interface MediationNativeListener

A listener containing callbacks for an adapter to communicate back to the mediation library. Events must be communicated back for the mediation library to properly manage ad flow.

Summary

Public methods
abstract void

Indicates that the user has clicked on this ad.
abstract void

Indicates that the ad control rendered something in full screen and is now transferring control back to the application.
abstract void
onAdFailedToLoad(
    @NonNull MediationNativeAdapter adapter,
    @NonNull AdError adError
)

Indicates that an ad request failed to load.
abstract void

This method is deprecated. Use onAdFailedToLoad(MediationNativeAdapter, AdError) instead.
abstract void

Indicates that an impression has been recorded for the ad.
abstract void

Indicates that the ad is causing the device to switch to a different application (such as a web browser).
abstract void
onAdLoaded(
    @NonNull MediationNativeAdapter adapter,
    @NonNull UnifiedNativeAdMapper unifiedNativeAdMapper
)

Indicates that an ad has been requested and successfully received.
abstract void

Indicates that the ad control is rendering something that is full screen.
abstract void

Indicates that an ad has completely finished playing video.

Public methods

onAdClicked

abstract void onAdClicked(@NonNull MediationNativeAdapter adapter)

Indicates that the user has clicked on this ad. This method should only be called if UnifiedNativeAdMapper.setOverrideClickHandling is set to true. This is used for publisher metrics, and must be called in addition to any other events.

Parameters
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.

onAdClosed

abstract void onAdClosed(@NonNull MediationNativeAdapter 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
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.

onAdFailedToLoad

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

Indicates that an ad request failed to load.

Parameters
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.
@NonNull AdError adError

AdError detailing the cause of the failure.

onAdFailedToLoad

abstract void onAdFailedToLoad(@NonNull MediationNativeAdapter 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
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.
int error

An error code detailing the cause of the failure.

onAdImpression

abstract void onAdImpression(@NonNull MediationNativeAdapter adapter)

Indicates that an impression has been recorded for the ad. This method should only be called if UnifiedNativeAdMapper.setOverrideImpressionRecording is set to true. This is used for publisher metrics, and must be called in addition to any other events.

Parameters
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.

onAdLeftApplication

abstract void onAdLeftApplication(@NonNull MediationNativeAdapter 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
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.

onAdLoaded

abstract void onAdLoaded(
    @NonNull MediationNativeAdapter adapter,
    @NonNull UnifiedNativeAdMapper unifiedNativeAdMapper
)

Indicates that an ad has been requested and successfully received.

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
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.
@NonNull UnifiedNativeAdMapper unifiedNativeAdMapper

The mapping class which provides a mapping from mediated ad network's ad object to unified native ad object.

onAdOpened

abstract void onAdOpened(@NonNull MediationNativeAdapter adapter)

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

Once this screen is dismissed, onAdClosed must be called.

Parameters
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.

onVideoEnd

abstract void onVideoEnd(@NonNull MediationNativeAdapter adapter)

Indicates that an ad has completely finished playing video.

Parameters
@NonNull MediationNativeAdapter adapter

The mediation adapter which raised the event.