CustomEventNative

interface CustomEventNative : CustomEvent


A custom event to support native ads.

The typical life-cycle for a custom event is to have requestNativeAd called once. At this point the adapter should create a native ad and report to the 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 CustomEventNativeListener passed in the requestNativeAd call. All parameters necessary to make an ad request should be passed in the serverParameter, NativeMediationAdRequest, and customEventExtras parameters.

Summary

Public functions

Unit
requestNativeAd(
    context: Context!,
    listener: CustomEventNativeListener!,
    serverParameter: String?,
    mediationAdRequest: NativeMediationAdRequest!,
    customEventExtras: Bundle?
)

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

Inherited functions

From com.google.android.gms.ads.mediation.customevent.CustomEvent
Unit

Tears down the adapter control.

Unit

Called when the application calls pause.

Unit

Called when the application calls resume.

Public functions

requestNativeAd

fun requestNativeAd(
    context: Context!,
    listener: CustomEventNativeListener!,
    serverParameter: String?,
    mediationAdRequest: NativeMediationAdRequest!,
    customEventExtras: Bundle?
): Unit

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

If the request is successful, onAdLoaded should be called.

If the request is unsuccessful, onAdFailedToLoad 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 which will contain the custom event.

listener: CustomEventNativeListener!

Listener to custom event with callbacks for various events.

serverParameter: String?

The string configured in the publisher UI as the parameter for the custom event.

mediationAdRequest: NativeMediationAdRequest!

Generic targeting parameters to use when requesting a view.

customEventExtras: Bundle?

A Bundle of parameters set by the publisher on a per-request basis.