The Splash Ad is loaded and displayed on the splash screen of the application. A Splash Ad is a full-screen advertisement that can be in either interstitial or open format. It appears as users launch the app, providing an engaging advertisement experience before the main content is fully loaded.

Splash ad automatically show a small branding area so users know they’re in your app. Here is an example of what a splash ad looks like:

Open Ad
Interstitial Ad
Open Format Interstitial Format

Load Ad

This function loads a splash screen advertisement within the specified Android activity. The ad is initialized asynchronously, and the provided IKLoadAdListener is used to handle callbacks related to the ad loading process.

  fun loadSplashScreenAd(activity: Activity?, listener: IKLoadAdListener?)

Parameters:

  • activity: The Activity in which the splash ad will be displayed. This can be null if no specific activity context is required at the time of calling.

  • listener: 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 
  class SplashActivity : AppCompatActivity() {

    private val ikSplashAd = IKSplashAd()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContentView(R.layout.activity_splash)

        ikSplashAd.attachLifecycle(lifecycle)
        ikSplashAd.loadSplashScreenAd(
            activity = this,
            listener = object : IKLoadAdListener {
                override fun onAdLoaded() {
                    // do something
                }

                override fun onAdLoadFail(error: IKAdError) {
                    // do something
                }
            }
        )
    }
}
  
  public class SplashActivity extends AppCompatActivity {

    private IKSplashAd ikSplashAd = new IKSplashAd();

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_splash);

        ikSplashAd.attachLifecycle(getLifecycle());
        ikSplashAd.loadSplashScreenAd(
                this,
                new IKLoadAdListener() {
                    @Override
                    public void onAdLoaded() {
                        // do something
                    }

                    @Override
                    public void onAdLoadFail(@NonNull IKAdError error) {
                        // do something
                    }
                }
        );
    }
}

Show Ad

For optimal ad loading in a specific state:

  • Call loadSplashScreenAd() first to start loading the ad
  • Once loading is complete, call showSplashScreenAd() to display it

Important notes

  • showSplashScreenAd() is a suspend function that uses Kotlin coroutines
  • The function remains suspended until the ad either shows successfully or fails
  • Use IKShowAdListener to handle display status callbacks
  suspend fun showSplashScreenAd(activity: Activity?, listener: IKShowAdListener?)

Parameters:

  • activity: The Activity where the splash ad will be displayed. This can be null if no specific activity context is needed at the time of showing the ad.

  • listener: IKShowAdListener interface has four callback methods for handling ad display events:

    • onAdsDismiss(): Called when the ad is dismissed by the user

    • onAdsShowFail(error: IKAdError): Called when there is an error showing the ad

    • onAdsShowed(): Called when the ad has been successfully displayed (optional implementation)

    • onAdsShowTimeout(): Called when the ad display times out (optional implementation)

Example 
  class SplashActivity : AppCompatActivity() {

    private val ikSplashAd = IKSplashAd()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContentView(R.layout.activity_splash)

        ikSplashAd.attachLifecycle(lifecycle)

        // loadSplashScreenAd
        ikSplashAd.loadSplashScreenAd(
            activity = this,
            listener = object : IKLoadAdListener {
                override fun onAdLoaded() {
                    // do something
                }

                override fun onAdLoadFail(error: IKAdError) {
                    // do something
                }
            }
        )

        // showSplashScreenAd
        lifecycleScope.launch {
            ikSplashAd.showSplashScreenAd(
                activity = this@SplashActivity,
                listener = object : IKShowAdListener {
                    override fun onAdsDismiss() {
                        // do something
                    }

                    override fun onAdsShowFail(error: IKAdError) {
                        // do something
                    }
                }
            )
        }
    }
}
  
  public class SplashActivity extends AppCompatActivity {

    private IKSplashAd ikSplashAd = new IKSplashAd();

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_splash);

        ikSplashAd.attachLifecycle(getLifecycle());
        ikSplashAd.loadSplashScreenAd(
                this,
                new IKLoadAdListener() {
                    @Override
                    public void onAdLoaded() {
                        // do something
                    }

                    @Override
                    public void onAdLoadFail(@NonNull IKAdError error) {
                        // do something
                    }
                }
        );

        ikSplashAd.showSplashScreenAdNor(
                this,
                new IKShowAdListener() {
                    @Override
                    public void onAdsShowed() {
                        // do something
                    }

                    @Override
                    public void onAdsDismiss() {
                        // do something
                    }

                    @Override
                    public void onAdsShowFail(@NonNull IKAdError ikAdError) {
                        // do something
                    }

                    @Override
                    public void onAdsShowTimeout() {
                        // do something
                    }
                }
        );
    }
}

Load and show Ad

This function asynchronously loads and displays a splash screen advertisement within the provided activity. It combines the processes of both loading and showing the ad, making it convenient for developers who want to handle the entire splash ad lifecycle in a single call. The provided IKShowAdListener is used to track the status of the ad display.

  suspend fun loadAndShowSplashScreenAd(activity: Activity?, listener: IKShowAdListener?): Job?

Parameters:

  • activity: The Activity where the splash ad will be displayed. This can be null if no specific activity context is needed at the time of showing the ad.

  • listener: IKShowAdListener interface has four callback methods for handling ad display events:

    • onAdsDismiss(): Called when the ad is dismissed by the user

    • onAdsShowFail(error: IKAdError): Called when there is an error showing the ad

    • onAdsShowed(): Called when the ad has been successfully displayed (optional implementation)

    • onAdsShowTimeout(): Called when the ad display times out (optional implementation)

Example 
  class SplashActivity : AppCompatActivity() {

    private val ikSplashAd = IKSplashAd()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContentView(R.layout.activity_splash)

        ikSplashAd.attachLifecycle(lifecycle)

        // loadSplashScreenAd
        ikSplashAd.loadSplashScreenAd(
            activity = this,
            listener = object : IKLoadAdListener {
                override fun onAdLoaded() {
                    // do something
                }

                override fun onAdLoadFail(error: IKAdError) {
                    // do something
                }
            }
        )

        // loadAndShowSplashScreenAd
        lifecycleScope.launch {
            ikSplashAd.loadAndShowSplashScreenAd(
                activity = this@SplashActivity,
                listener = object : IKShowAdListener {
                    override fun onAdsDismiss() {
                        // do something
                    }

                    override fun onAdsShowFail(error: IKAdError) {
                        // do something
                    }
                }
            )
        }
    }
}
  
  public class SplashActivity extends AppCompatActivity {

    private IKSplashAd ikSplashAd = new IKSplashAd();

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_splash);

        ikSplashAd.attachLifecycle(getLifecycle());
        
        // loadSplashScreenAd
        ikSplashAd.loadSplashScreenAd(
                this,
                new IKLoadAdListener() {
                    @Override
                    public void onAdLoaded() {
                        // do something
                    }

                    @Override
                    public void onAdLoadFail(@NonNull IKAdError error) {
                        // do something
                    }
                }
        );

        // loadAndShowSplashScreenAdNonAsync
        ikSplashAd.loadAndShowSplashScreenAdNonAsync(
                this,
                new IKShowAdListener() {
                    @Override
                    public void onAdsShowed() {
                        // do something
                    }

                    @Override
                    public void onAdsDismiss() {
                        // do something
                    }

                    @Override
                    public void onAdsShowFail(@NonNull IKAdError ikAdError) {
                        // do something
                    }

                    @Override
                    public void onAdsShowTimeout() {
                        // do something
                    }
                }
        );
    }
}

None Show Splash Ad 

  fun noneShowSplashAd(activity: Activity?, listener: IKNoneSplashAdListener)

Parameters:

  • activity: The Activity where the splash ad will be displayed. This can be null if no specific activity context is needed at the time of showing the ad.

  • listener: IKNoneSplashAdListener is an interface with a single callback method:

    • onMove(): Called when the app should proceed without showing a splash ad
Example 
  class SplashActivity : AppCompatActivity() {

    private val ikSplashAd = IKSplashAd()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContentView(R.layout.activity_splash_1)

        // noneShowSplashAd
        ikSplashAd.noneShowSplashAd(
            activity = this,
            listener = object : IKNoneSplashAdListener {
                override fun onMove() {
                    // do something
                }
            }
        )
    }
}
  
  public class SplashActivity extends AppCompatActivity {

    private IKSplashAd ikSplashAd = new IKSplashAd();

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_splash);

        ikSplashAd.noneShowSplashAd(this, new IKNoneSplashAdListener() {
            @Override
            public void onMove() {
                // do something
            }
        });
    }
}