NativeAdLoader.Companion

public static class NativeAdLoader.Companion


Summary

Public methods

static final @NonNull NativeAdLoadResult

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

static final void
load(
    @NonNull NativeAdRequest adRequest,
    @NonNull NativeAdLoaderCallback adLoadCallback
)

Loads a native ad, providing the result via adLoadCallback.

static final @NonNull Flow<@NonNull NativeAdLoadResult>
load(@NonNull NativeAdRequest adRequest, int numberOfAds)

Loads up to numberOfAds native ads.

static final void
load(
    @NonNull NativeAdRequest adRequest,
    int numberOfAds,
    @NonNull NativeAdLoaderCallback adLoadCallback
)

Loads multiple native ads, providing the result via adLoadCallback.

static final void
loadFromAdResponse(
    @NonNull String adResponse,
    @NonNull NativeAdLoaderCallback adLoadCallback
)

Loads a native ad, providing the result via adLoadCallback.

Public methods

load

public static final @NonNull NativeAdLoadResult load(@NonNull NativeAdRequest adRequest)

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

Parameters
@NonNull NativeAdRequest adRequest

A NativeAdRequest with targeting information.

load

public static final void load(
    @NonNull NativeAdRequest adRequest,
    @NonNull NativeAdLoaderCallback adLoadCallback
)

Loads a native ad, providing the result via adLoadCallback.

Parameters
@NonNull NativeAdRequest adRequest

An ad request with targeting information.

@NonNull NativeAdLoaderCallback adLoadCallback

A callback to be invoked when loading completes.

load

public static final @NonNull Flow<@NonNull NativeAdLoadResultload(@NonNull NativeAdRequest adRequest, int numberOfAds)

Loads up to numberOfAds native ads.

Parameters
@NonNull NativeAdRequest adRequest

A NativeAdRequest with targeting information.

int numberOfAds

The maximum number of ads to load.

Returns
@NonNull Flow<@NonNull 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

public static final void load(
    @NonNull NativeAdRequest adRequest,
    int numberOfAds,
    @NonNull NativeAdLoaderCallback adLoadCallback
)

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
@NonNull NativeAdRequest adRequest

An ad request with targeting information.

int numberOfAds

The maximum number of ads to load.

@NonNull NativeAdLoaderCallback adLoadCallback

A callback to be invoked when loading completes.

loadFromAdResponse

public static final void loadFromAdResponse(
    @NonNull String adResponse,
    @NonNull NativeAdLoaderCallback adLoadCallback
)

Loads a native ad, providing the result via adLoadCallback.

Parameters
@NonNull String adResponse

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

@NonNull NativeAdLoaderCallback adLoadCallback

A callback to be invoked when loading completes.