MediationNativeAdapter

public interface MediationNativeAdapter extends MediationAdapter


Adapter for third party ad networks that support native ads.

The typical life-cycle for an adapter is to have requestNativeAd called once. At this point the adapter should request an ad from the ad network and report to the listener either onAdLoaded or onAdFailedToLoad. At the end of the life cycle, a best effort is made to call onDestroy, though this is not guaranteed. Note that requestNativeAd is called on the UI thread so all the standard precautions of writing code on that thread apply. In particular, the code should not call any blocking methods.

The adapter is expected to expose events via the MediationNativeListener passed in the requestNativeAd call. All parameters necessary to make an ad request should be passed in the serverParameters, NativeMediationAdRequest, and mediationExtras parameters.

Adapters should make an effort to disable automatic ad refreshing on the client side. Ads that are refreshed may be ignored, not displayed, or counted incorrectly.

Summary

Public methods

abstract void
requestNativeAd(
    Context context,
    MediationNativeListener listener,
    Bundle serverParameters,
    NativeMediationAdRequest mediationAdRequest,
    @Nullable Bundle mediationExtras
)

Called by the mediation library to request a native ad from the adapter.

Inherited methods

From com.google.android.gms.ads.mediation.MediationAdapter
abstract void

Tears down the adapter control.

abstract void

Called when the application calls onPause on the .

abstract void

Called when the application calls onResume on the .

Public methods

requestNativeAd

abstract void requestNativeAd(
    Context context,
    MediationNativeListener listener,
    Bundle serverParameters,
    NativeMediationAdRequest mediationAdRequest,
    @Nullable Bundle mediationExtras
)

Called by the mediation library to request a native ad from the adapter.

If the request is successful, the onAdLoaded method should be called.

If the request is unsuccessful, the onAdFailedToLoad method should be called on the listener with an appropriate error cause.

This method is called on the UI thread so all the standard precautions of writing code on that thread apply. In particular your code should not call any blocking methods.

Parameters
Context context

The Context of the AdView which will contain the native View.

MediationNativeListener listener

Listener for adapter with callbacks for various events

Bundle serverParameters

Additional parameters defined by the publisher on the mediation server side

NativeMediationAdRequest mediationAdRequest

Generic parameters for this publisher to use when making his ad request

@Nullable Bundle mediationExtras

Additional parameters set by the publisher on a per-request basis