Rewarded Ad

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

Here is an example of what a rewarded ad looks like:

Rewarded Format

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.

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

Parameters:

• screenAd: considered as a unitId, our team will send you the screenAd list.

• callback: The IKLoadAdListener interface is designed to manage responses related to the loading of ads. It provides callbacks for handling both the successful loading of ads and the scenarios where ad loading fails.

  • onAdLoaded(): Called when the ad is displayed. This method must be implemented to define the actions to be taken when an ad is shown.

  • onAdLoadFail(error: IKAdError): Invoked when there is a failure in loading the ad. It takes an IKAdError object as a parameter, which contains details about what caused the failure.

Example link

  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
            }
        })
    }
}
  

  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

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.

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

Parameters:

• activity: The Activity in which the rewarded ad will be shown. This can be null if no specific activity context is required.

• screenAd: considered as a unitId, our team will send you the screenAd list.

• adListener: The IKShowRewardAdListener interface is designed to handle the events related to the display of reward-based advertisements. It provides callbacks for various stages of ad display, including showing, dismissing, rewarding, failing, and timing out.

  • onAdsShowed(): Called when a reward ad is successfully displayed.

  • onAdsDismiss(): Triggered when a reward ad is dismissed by the user. Used for cleanup or handling the next steps.

  • onAdsRewarded(): Invoked when the user fulfills the criteria for a reward. This method confirms that the reward should be granted.

  • onAdsShowFail(error: IKAdError): Invoked when there is a failure in displaying the ad. Provides details about the failure.

  • onAdsShowTimeout(): Called if the display of the reward ad times out. Useful for handling scenarios when ad loading exceeds a set time limit.

Example 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() {

        }
    }
);
  

Show Ad with Loading Callback link

To display an rewarded ad with loading callback, call the showAd method on an IKRewardAd instance, providing the activity context, the ad unit ID, and an IKShowRewardAdListener 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.

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

Parameters:

• activity: The Activity in which the rewarded ad will be shown. This can be null if no specific activity context is required.

• screenAd: considered as a unitId, our team will send you the screenAd list.

• adListener: The IKShowRewardAdListener interface is designed to handle the events related to the display of reward-based advertisements. It provides callbacks for various stages of ad display, including showing, dismissing, rewarding, failing, and timing out.

  • onAdsShowed(): Called when a reward ad is successfully displayed.

  • onAdsDismiss(): Triggered when a reward ad is dismissed by the user. Used for cleanup or handling the next steps.

  • onAdsRewarded(): Invoked when the user fulfills the criteria for a reward. This method confirms that the reward should be granted.

  • onAdsShowFail(error: IKAdError): Invoked when there is a failure in displaying the ad. Provides details about the failure.

  • onAdsShowTimeout(): Called if the display of the reward ad times out. Useful for handling scenarios when ad loading exceeds a set time limit.

• loadingCallback: The IKLoadingsAdListener abstract class is designed for managing the ad display lifecycle events while taking into account the loading time. It encapsulates the behavior of ads in terms of showing and closing, and includes a timing element to track the duration for which an ad was loading.

  • Properties:

    • timeLoading: The duration in milliseconds that the ad was loading.

  • Methods:

    • onShow(): Called when the ad is displayed. This method must be implemented to define the actions to be taken when an ad is shown.

    • onClose(): Called when the ad display is closed. This method must be implemented to define the actions to be taken when an ad is closed.

Example link

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

        override fun onAdsShowFail(error: IKAdError) {
        }

        override fun onAdsRewarded() {
        }

        override fun onAdsShowed() {
        }

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

        override fun onShow() {

        }
    }
)
  

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

            }

            @Override
            public void onAdsDismiss() {

            }

            @Override
            public void onAdsRewarded() {

            }

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

            }

            @Override
            public void onAdsShowTimeout() {

            }
        },
        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.

  fun destroy()
  

Example link

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

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

Check Ad Ready link

  IKSdkController.isRewardAdReadyAsync()