Reward Ad

Rewarded ads allow you to reward users with in-app items for interacting with video ads, playable ads, and surveys.

Load Ad link

To load an reward ad, call the loadAd method on an IKRewardAd instance and provide the ad unit ID along with an IKLoadAdListener to receive the loaded ad or any potential errors. Note that, like other ad format load callbacks, IKLoadAdListener utilizes IKAdError to provide more detailed error information.

Reference

  com.ikame.android.sdk.format.rewarded.IKRewardAd#loadAd
  

Function Definition

  fun loadAd(
    screen: String,
    callback: IKLoadAdListener?
)
  

Parameters

• screenAd: considered as a unitId, our team will send you the screenAd list.
• callback: An instance of IKLoadAdListener that provides callbacks for handling ad load events.

Sample Usage link

  import com.ikame.android.sdk.data.dto.pub.IKAdError
import com.ikame.android.sdk.format.rewarded.IKRewardAd
import com.ikame.android.sdk.listener.pub.IKLoadAdListener

class MainActivity : AppCompatActivity() {
    private lateinit var rewardAd: IKRewardAd

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // Initialize IKRewardAd object
        rewardAd = IKRewardAd()

        // Attach lifecycle to manage Listener lifecycle with Owner
        rewardAd.attachLifecycle(this.lifecycle)

        // Load ad with a specific screen ID, considered as a unitId
        rewardAd.loadAd("reward_screen_id", object : IKLoadAdListener {
            override fun onAdLoaded() {
                // Ad loaded successfully
                // Example: Prepare to show the ad or update the UI
            }

            override fun onAdLoadFail(error: IKAdError) {
                // Handle ad load failure
                // Example: Log the error or notify the user
            }
        })
    }
}
  

  import com.ikame.android.sdk.format.rewarded.IKRewardAd;
import com.ikame.android.sdk.listener.pub.IKLoadAdListener;
import com.ikame.android.sdk.data.dto.pub.IKAdError;


public class MainActivity extends AppCompatActivity {
    private IKRewardAd rewardAd;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // Initialize IKRewardAd object
        rewardAd = new IKRewardAd();
        
        // Attach lifecycle to manage Listener lifecycle with Owner
        rewardAd.attachLifecycle(getLifecycle());

        // Load ad with a specific screen ID, considered as a unitId
        rewardAd.loadAd("reward_screen_id", new IKLoadAdListener() {
            @Override
            public void onAdLoadFail(IKAdError error) {
                // Handle the failure to load the ad
            }

            @Override
            public void onAdLoaded() {
                // Handle the failure to load the ad
            }
        });
    }
}
  

Show Ad link

1. Basic Show Function link

To display an reward ad, call the showAd method on an IKRewardAd instance, providing the activity context, the ad unit ID, and an IKShowAdListener to handle the ad display events. The IKShowAdListener interface provides callbacks for handling ad show failures and ad dismissals.

#Reference

  com.ikame.android.sdk.format.rewarded.IKRewardAd#showAd(Activity, String, IKShowRewardAdListener)
  

#Function Definition

  fun showAd(
    activity: Activity?,
    screen: String,
    adListener: IKShowRewardAdListener?
)
  

Parameters:

• activity: The Activity in which the interstitial ad will be shown. This can be null if no specific activity context is required.
• screen: considered as a unitId, our team will send you the screenAd list.
• adListener: IKShowRewardAdListener - Manages reward ad display events.

Sample Usage link

  rewardAd.showAd(this, "reward_screen_id", object : IKShowRewardAdListener {
            override fun onAdsShowTimeout() {
            }

            override fun onAdsShowFail(ikAdError: IKAdError) {
            }

            override fun onAdsRewarded() {
            }

            override fun onAdsShowed() {
            }

            override fun onAdsDismiss() {
            }
        })
  

  rewardAd.showAd(this, "reward_screen_id", new IKShowRewardAdListener() {
            @Override
            public void onAdsShowTimeout() {

            }

            @Override
            public void onAdsShowFail(@NonNull IKAdError ikAdError) {

            }

            @Override
            public void onAdsRewarded() {

            }

            @Override
            public void onAdsShowed() {

            }

            @Override
            public void onAdsDismiss() {
                
            }
        });
  

2. Show Ad with Loading Callback link

To display an interstitial ad with loading callback, call the showAd method on an IKInterstitialAd instance, providing the activity context, the ad unit ID, and an IKShowAdListener to handle the ad display events. The IKShowRewardAdListener interface provides callbacks for handling ad display events.The IKLoadingsAdListener interface provides callbacks for managing the ad’s loading state.

#Reference

  com.ikame.android.sdk.format.rewarded.IKRewardAd#showAd(Activity, String, IKShowRewardAdListener, IKLoadingsAdListener)
  

#Function Definition

  fun showAd(
    activity: Activity?,
    screen: String,
    adListener: IKShowRewardAdListener?,
    loadingCallback: IKLoadingsAdListener? = null
)
  

Parameters:

• activity: The Activity in which the interstitial ad will be shown. This can be null if no specific activity context is required.
• screen: considered as a unitId, our team will send you the screenAd list.
• adListener: IKShowRewardAdListener - Manages reward ad display events.
• loadingCallback: IKLoadingsAdListener - Managing the ad display lifecycle events while taking into account the loading time

Sample Usage link

    rewardAd.showAd(this, "reward_screen_id", object : IKShowRewardAdListener {
            override fun onAdsShowTimeout() {
            }

            override fun onAdsShowFail(ikAdError: IKAdError) {
            }

            override fun onAdsRewarded() {
            }

            override fun onAdsShowed() {
            }

            override fun onAdsDismiss() {
            }
        }, object : IKLoadingsAdListener(2000) {
            override fun onClose() {
            }

            override fun onShow() {
            }
        })
  

  rewardAd.showAd(this, "reward_screen_id", new IKShowRewardAdListener() {
            @Override
            public void onAdsShowTimeout() {

            }

            @Override
            public void onAdsShowFail(@NonNull IKAdError ikAdError) {

            }

            @Override
            public void onAdsRewarded() {

            }

            @Override
            public void onAdsShowed() {

            }

            @Override
            public void onAdsDismiss() {
                
            }
        }, new IKLoadingsAdListener(2000) {
            @Override
            public void onShow() {
                
            }

            @Override
            public void onClose() {

            }
        });
  

Destroy Ad link

In certain scenarios, Ad can be prone to memory leaks. Therefore, it is essential to destroy the ad when your Fragment or Activity is destroyed to manage resources properly.

#Reference

  com.ikame.android.sdk.format.rewarded.IKRewardAd#destroy
  

#Function Definition

  fun destroy()
  

Sample usage link

  override fun onDestroy() {
    super.onDestroy()
    interAd?.destroyAd()
}
  

    @Override
    protected void onDestroy() {
        super.onDestroy();
        interAd.destroy();
    }
  

Check Ad Ready link

#Reference

   IKSdkController.isRewardAdReadyAsync()
  

Ad Listener Interfaces link

• IKShowRewardAdListener: Manages reward ad display events.
• IKLoadAdListener: Handles ad loading events.
• IKLoadingsAdListener: Managing the ad display lifecycle events while taking into account the loading time