Load Native Ads

Native ads are advertising assets seamlessly integrated into the user interface using components that are native to the platform. They are displayed through the same views you use to construct your app's layouts, allowing for a cohesive user experience. Additionally, these ads can be customized to align with your app's visual design, ensuring they feel like a natural part of the content rather than intrusive advertisements.

Below is a diagram showing the ad lifecycle.

Create Ad Content callback

A com.cleveradssolutions.sdk.nativead.NativeAdContentCallback class for handling events related to native ad content.

val nativeAdCallback = object : NativeAdContentCallback() {
    override fun onNativeAdLoaded(nativeAd: NativeAdContent,ad: AdContentInfo) {
        keepNativeAdInMemory(nativeAd)
        registerNativeAdContent(nativeAd)
    }
    override fun onNativeAdFailedToLoad(error: AdError) {
        // (Optional) Handle Ad load errors
    }
    override fun onNativeAdFailedToShow(nativeAd: NativeAdContent,error: AdError) {
        // (Optional) Handle Ad render errors.
        // Called from CASNativeView.setNativeAd(nativeAd)
    }
    override fun onNativeAdClicked(nativeAd: NativeAdContent,ad: AdContentInfo) {
        // (Optional) Called when the native ad is clicked by the user.
    }
}

final NativeAdContentCallback nativeAdCallback =  new NativeAdContentCallback() {  
    @Override  
    public void onNativeAdLoaded(@NonNull NativeAdContent nativeAd, @NonNull AdContentInfo ad) {  
        keepNativeAdInMemory(nativeAd);  
        registerNativeAdContent(nativeAd);  
    }  
    @Override  
    public void onNativeAdFailedToLoad(@NonNull AdError error) {  
        // (Optional) Handle Ad load errors    
    }  
    @Override  
    public void onNativeAdFailedToShow(@NonNull NativeAdContent nativeAd, @NonNull AdError error) {  
        // (Optional) Handle Ad render errors.   
        // Called from CASNativeView.setNativeAd(nativeAd)   
    }  
    @Override  
    public void onNativeAdClicked(@NonNull NativeAdContent nativeAd, @NonNull AdContentInfo ad) {  
        // (Optional) Called when the native ad is clicked by the user.    
    }  
};

Load ad

Native ads are loaded with the com.cleveradssolutions.sdk.nativead.CASNativeLoader class.

fun loadNativeAd() {
    val adLoader = CASNativeLoader(this, MyApplication.CAS_ID, nativeAdCallback)
    adLoader.adChoicesPlacement = AdChoicesPlacement.TOP_LEFT // by default
    adLoader.isStartVideoMuted = true // by default
    adLoader.load()
}

fun keepNativeAdInMemory(nativeAd: NativeAdContent) {
    loadedNativeAds.add(nativeAd)
}

void loadNativeAd() {  
    CASNativeLoader adLoader = new CASNativeLoader(MyActivity.this, MyApplication.CAS_ID, nativeAdCallback);  
    adLoader.setAdChoicesPlacement(AdChoicesPlacement.TOP_LEFT); // by default  
    adLoader.setStartVideoMuted(true); // by default
    adLoader.load();  
}

void keepNativeAdInMemory(NativeAdContent nativeAd) {
    loadedNativeAds.add(nativeAd);
}

@Composable
fun NativeAdScreen() {
    val context = LocalContext.current
    var loadedNativeAds by remember { mutableStateOf<List<NativeAdContent>>(emptyList()) }
    var isDestroyed = false

    fun keepNativeAdInMemory(nativeAd: NativeAdContent) {
        loadedNativeAds = loadedNativeAds + nativeAd
    }

    // other functions here

    DisposableEffect(Unit) {
        val adLoader = CASNativeLoader(context, MyApplication.CAS_ID, nativeAdCallback)
        adLoader.adChoicesPlacement = AdChoicesPlacement.TOP_LEFT // by default
        adLoader.isStartVideoMuted = true // by default
        adLoader.load()

        onDispose { isDestroyed = true }
    }
}

After a call to load(), a single callback is made to the previously defined NativeAdContentCallback to deliver the native ad object or report an error.

Autoload Ad mode

The CASNativeLoader does not have an autoload ad mode like other ad formats, so you need to implement error handling and ad reloading manually.

Load multiple ads (optional)

The load() method takes an additional parameter: the number of ads the SDK should attempt to load for the request. It's not guaranteed that the SDK will return the exact number of ads requested.

val maxNumberOfAdsToLoad = 3
adLoader.load(maxNumberOfAdsToLoad)

int maxNumberOfAdsToLoad = 3;
adLoader.load(maxNumberOfAdsToLoad);

The onNativeAdLoaded will be called multiple times, once for each ad that is successfully loaded, up to the specified maximum number of ads. If the load operation fails, the onNativeAdFailedToLoad will be called once with the error details.

Apps requesting multiple ads should call CASNativeLoader.isLoading in their callback implementations to determine whether the loading process has finished.

override fun onNativeAdLoaded(nativeAd: NativeAdContent,ad: AdContentInfo) {
    keepNativeAdInMemory(nativeAd)
    registerNativeAdContent(nativeAd)

    if (adLoader.isLoading) {
        // The AdLoader is still loading ads.
        // Expect more onNativeAdLoaded or onNativeAdFailedToLoad callbacks.
    } else {
        // The AdLoader has finished loading ads.
    }
}

@Override  
public void onNativeAdLoaded(@NonNull NativeAdContent nativeAd, @NonNull AdContentInfo ad) {  
    keepNativeAdInMemory(nativeAd);
    registerNativeAdContent(nativeAd);
    
    if (adLoader.isLoading()) {
        // The AdLoader is still loading ads.
        // Expect more onNativeAdLoaded or onNativeAdFailedToLoad callbacks.
    } else {
        // The AdLoader has finished loading ads.
    }   
} 

Release ad resources

It’s crucial to call the destroy() method on all loaded native ads, even if they were not used or referenced. This action releases utilized resources and helps prevent memory leaks.

When you invoke the load() function, the CASNativeLoader will continue running until the ad finishes loading. This can lead to the NativeAdContentCallback being triggered after the Activity has been destroyed or at unexpected times. Therefore, you should implement checks to destroy the loaded ad if you do not plan to display it to the user.

override fun onNativeAdLoaded(nativeAd: NativeAdContent, ad: AdContentInfo) {
    // If this callback is invoked after the activity is destroyed,
    // call destroy and return to avoid potential memory leaks.
    // Note: `isDestroyed()` is a method available on Activity.
    if (isDestroyed) {
        nativeAd.destroy()
        return
    }
    keepNativeAdInMemory(nativeAd)
    registerNativeAdContent(nativeAd)
}

@Override
public void onNativeAdLoaded(@NonNull NativeAdContent nativeAd, @NonNull AdContentInfo ad) {
    // If this callback is invoked after the activity is destroyed,
    // call destroy and return to avoid potential memory leaks.
    // Note: `isDestroyed()` is a method available on Activity.
    if (isDestroyed()) {
        nativeAd.destroy();
        return;
    }
    keepNativeAdInMemory(nativeAd);
    registerNativeAdContent(nativeAd);
}

Make sure to destroy all NativeAdContent references in your activity’s onDestroy() function:

override fun onDestroy() {
    loadedNativeAds.forEach { it.destroy() }
    super.onDestroy()
}

@Override
public void onDestroy() {
    for (NativeAdContent ad : loadedNativeAds) {
        ad.destroy();
    }
    super.onDestroy();
}

DisposableEffect(Unit) {
    onDispose {
        isDestroyed = true
        adContents.forEach { it.destroy() }
    }
}