NativeAdLoader

interface NativeAdLoader


Summary

Public companion functions

suspend NativeAdLoadResult
load(adRequest: NativeAdRequest)

Loads a native ad, suspending until a native ad loads or fails to load.

Unit
load(adRequest: NativeAdRequest, adLoadCallback: NativeAdLoaderCallback)

Loads a native ad, providing the result via adLoadCallback.

suspend Flow<NativeAdLoadResult>
load(adRequest: NativeAdRequest, numberOfAds: Int)

Loads up to numberOfAds native ads.

Unit
load(
    adRequest: NativeAdRequest,
    numberOfAds: Int,
    adLoadCallback: NativeAdLoaderCallback
)

Loads multiple native ads, providing the result via adLoadCallback.

Unit
loadFromAdResponse(
    adResponse: String,
    adLoadCallback: NativeAdLoaderCallback
)

Loads a native ad, providing the result via adLoadCallback.

Public companion functions

load

suspend fun load(adRequest: NativeAdRequest): NativeAdLoadResult

Loads a native ad, suspending until a native ad loads or fails to load.

Parameters
adRequest: NativeAdRequest

A NativeAdRequest with targeting information.

load

fun load(adRequest: NativeAdRequest, adLoadCallback: NativeAdLoaderCallback): Unit

Loads a native ad, providing the result via adLoadCallback.

Parameters
adRequest: NativeAdRequest

An ad request with targeting information.

adLoadCallback: NativeAdLoaderCallback

A callback to be invoked when loading completes.

load

suspend fun load(adRequest: NativeAdRequest, numberOfAds: Int): Flow<NativeAdLoadResult>

Loads up to numberOfAds native ads.

Parameters
adRequest: NativeAdRequest

A NativeAdRequest with targeting information.

numberOfAds: Int

The maximum number of ads to load.

Returns
Flow<NativeAdLoadResult>

A flow that emits any of the following: NativeAdLoadResult.NativeAdSuccess if a NativeAd is returned, NativeAdLoadResult.CustomNativeAdSuccess if a CustomNativeAd is returned, NativeAdLoadResult.BannerAdSuccess if a BannerAd is returned, or NativeAdLoadResult.Failure if a native ad fails to load.

load

fun load(
    adRequest: NativeAdRequest,
    numberOfAds: Int,
    adLoadCallback: NativeAdLoaderCallback
): Unit

Loads multiple native ads, providing the result via adLoadCallback. Invokes adLoadCallback up to numberOfAds times, which may include any combination of the following: NativeAdLoaderCallback.onNativeAdLoaded, NativeAdLoaderCallback.onCustomNativeAdLoaded, NativeAdLoaderCallback.onBannerAdLoaded, NativeAdLoaderCallback.onAdFailedToLoad.

Invokes NativeAdLoaderCallback.onAdLoadingCompleted once all ads have completed loading.

Parameters
adRequest: NativeAdRequest

An ad request with targeting information.

numberOfAds: Int

The maximum number of ads to load.

adLoadCallback: NativeAdLoaderCallback

A callback to be invoked when loading completes.

loadFromAdResponse

fun loadFromAdResponse(
    adResponse: String,
    adLoadCallback: NativeAdLoaderCallback
): Unit

Loads a native ad, providing the result via adLoadCallback.

Parameters
adResponse: String

An ad response from a server-to-server ad request.

adLoadCallback: NativeAdLoaderCallback

A callback to be invoked when loading completes.