admob-cmp-core/dev.avinya.ads/NativeAdPool

NativeAdPool

Manages a pool of preloaded native ads for a single placement. Ads are acquired via acquire and must be returned via release. The composable NativeAdView handles acquire/release automatically. Use the pool directly for manual native ad rendering.

Properties

availableAds

abstract val availableAds: StateFlow<Int>

Number of ads currently available for acquire, as a live signal.

events

abstract val events: SharedFlow<AdEvent>

Shared flow of native ad lifecycle events.

loadState

abstract val loadState: StateFlow<AdLoadState>

Current load state of the pool.

placement

abstract val placement: AdPlacement

The placement this pool is bound to.

Functions

acquire

abstract fun acquire(): NativeAdToken?

Acquires a NativeAdToken from the pool, or null if none available. Every acquire must be paired with a release.

availableCount

abstract fun availableCount(): Int

Returns the number of cached ads currently available for acquire.

clear

abstract fun clear()

Clears all cached ads and resets the pool.

mediaInfo

abstract fun mediaInfo(token: NativeAdToken): NativeMediaInfo?

Returns media info (aspect ratio, video duration) for the ad identified by token.

peekAndroidNativeAd

fun NativeAdPool.peekAndroidNativeAd(token: NativeAdToken): NativeAd?

peekIosNativeAd

fun NativeAdPool.peekIosNativeAd(token: NativeAdToken): GADNativeAd?

preload

abstract suspend fun preload(count: Int = placement.cachePolicy.maxSize, requestOptions: AdRequestOptions = placement.requestOptions, nativeOptions: NativeAdOptions = placement.nativeOptions): AdLoadState

Preloads count native ads.

release

abstract fun release(token: NativeAdToken)

Releases a previously acquired NativeAdToken. The underlying native ad is destroyed/discarded (native ads are single-use and not returned to the pool). Call when the rendering view is disposed.