Interstitial

Interstitial ads are full-screen advertisements. In Appodeal, they are divided into two types - static interstitial and video interstitial.

These types of ads are requested simultaneously during caching. If both of them filled an ad, the most expensive of the two will be shown.

Static interstitial - static full-screen banners.
Video interstitial - these are videos that the user can usually close 5 seconds after the start of viewing.

Initialization

1. Import the namespaces:

using AppodealStack.Monetization.Api;
using AppodealStack.Monetization.Common;

2. Add the following code within the Start() method of your main scene’s MonoBehavior:

Appodeal.Initialize("YOUR_APPODEAL_APP_KEY", AppodealAdType.Interstitial, this);

Initialization method requires 2 parameters:

appKey - appKey is generated when you add an application to Appodeal.
adType - Ad types can be combined using "|" operator. For example, AppodealAdType.Interstitial | AppodealAdType.RewardedVideo.

By default, auto caching is enabled: Appodeal SDK starts to load Interstitial right away after the initialization method is called. The next interstitial ad starts to load after the previous one was shown.

1. Import the namespaces:

using AppodealAds.Unity.Api;
using AppodealAds.Unity.Common;

2. Add the following code within the Start() method of your main scene’s MonoBehavior:

Appodeal.initialize("YOUR_APPODEAL_APP_KEY", Appodeal.INTERSTITIAL, this);

Initialization method requires 3 parameters:

appKey- appKey is generated when you add an application to Appodeal.
adType - Ad types can be combined using "|" operator. For example, AppodealAdType.Interstitial | AppodealAdType.RewardedVideo .

Manual Сaching

If you need more control of interstitial ads loading use manual caching. Manual caching for Interstitial can be useful to improve display rate or decrease SDK loads when several ad types are cached.

To disable automatic caching for Interstitials, use the code below before the SDK initialization:

Appodeal.SetAutoCache(AppodealAdType.Interstitial, false);

To cache interstitial use:

Appodeal.Cache(AppodealAdType.Interstitial);

Display

To display interstitial, you need to call the following code:

Appodeal.Show(AppodealShowStyle.Interstitial);

Check If Ad Is Loaded

You can check the status of loading before showing. This method returns a boolean value indicating whether the interstitial is loaded.

Appodeal.IsLoaded(AppodealAdType.Interstitial);

We recommend you always check whether an ad is available before trying to show it.

Example:

if(Appodeal.IsLoaded(AppodealAdType.Interstitial)) {
	Appodeal.Show(AppodealShowStyle.Interstitial);	
}

Placements

Appodeal SDK allows you to tag each impression with different placement. To use placements, you need to create placements in Appodeal Dashboard. Read more about placements.

To show an ad with placement, you have to call show method like this in your activity:

Appodeal.Show(AppodealShowStyle.Interstitial, “placementName”);

If the loaded ad can’t be shown for a specific placement, nothing will be shown. If auto caching is enabled, sdk will start to cache another ad, which can affect display rate. To save the loaded ad for future use (for instance, for another placement) check if the ad can be shown before calling show method:

if(Appodeal.CanShow(AppodealAdType.Interstitial, “placementName”)){
	Appodeal.Show(AppodealShowStyle.Interstitial, “placementName”);
}

Appodeal.show(Appodeal.INTERSTITIAL, “placementName”);

if(Appodeal.canShow(Appodeal.INTERSTITIAL, “placementName”)){
	Appodeal.show(Appodeal.INTERSTITIAL, “placementName”);
}

You can configure your impression logic for each placement.

If you have no placements, or call Appodeal.show with a placement that does not exist, the impression will be tagged with 'default' placement and its settings will be applied.

Important!

Placement settings affect ONLY ad presentation, not loading or caching.

Callbacks

The callbacks are used to track different events in the lifecycle of an ad, e.g. when an ad was clicked on or closed. To implement them, you need to follow below steps:

Subscribe to the desired interstitial event using one of the options from this guide. (you can subscribe to any event you want)
You can use callbacks as shown below after:

public void YourMethod()
{
	AppodealCallbacks.Interstitial.OnLoaded += OnInterstitialLoaded;
	AppodealCallbacks.Interstitial.OnFailedToLoad += OnInterstitialFailedToLoad;
	AppodealCallbacks.Interstitial.OnShown += OnInterstitialShown;
	AppodealCallbacks.Interstitial.OnShowFailed += OnInterstitialShowFailed;
	AppodealCallbacks.Interstitial.OnClosed += OnInterstitialClosed;
	AppodealCallbacks.Interstitial.OnClicked += OnInterstitialClicked;
	AppodealCallbacks.Interstitial.OnExpired += OnInterstitialExpired;
}

#region InterstitialAd Callbacks
// Called when interstitial was loaded (precache flag shows if the loaded ad is precache)
private void OnInterstitialLoaded(object sender, AdLoadedEventArgs e)
{
	Debug.Log("Interstitial loaded");  
}
// Called when interstitial failed to load
private void OnInterstitialFailedToLoad(object sender, EventArgs e)
{
	Debug.Log("Interstitial failed to load");   
}
// Called when interstitial was loaded, but cannot be shown (internal network errors, placement settings, or incorrect creative)
private void OnInterstitialShowFailed(object sender, EventArgs e)
{
	Debug.Log("Interstitial show failed");
}
// Called when interstitial is shown
private void OnInterstitialShown(object sender, EventArgs e)
{
	Debug.Log("Interstitial shown");   
}
// Called when interstitial is closed
private void OnInterstitialClosed(object sender, EventArgs e)
{
	Debug.Log("Interstitial closed");
}
// Called when interstitial is clicked
private void OnInterstitialClicked(object sender, EventArgs e)
{
	Debug.Log("Interstitial clicked");
}
// Called when interstitial is expired and can not be shown
private void OnInterstitialExpired(object sender, EventArgs e)
{
	Debug.Log("Interstitial expired");
}
#endregion

1. Extend your class with IInterstitialAdListener:

YourClassName : IInterstitialAdListener;

2. Then call the following method:

Appodeal.SetInterstitialCallbacks(this);

3. Now you can use the following callback methods within your public class :

#region Interstitial callback handlers

// Called when interstitial was loaded (precache flag shows if the loaded ad is precache)
public void OnInterstitialLoaded(bool isPrecache) 
{ 
	Debug.Log("Interstitial loaded"); 
} 

// Called when interstitial failed to load
public void OnInterstitialFailedToLoad() 
{ 
	Debug.Log("Interstitial failed to load"); 
} 

// Called when interstitial was loaded, but cannot be shown (internal network errors, placement settings, or incorrect creative)
public void OnInterstitialShowFailed() 
{ 
	Debug.Log("Interstitial show failed"); 
} 

// Called when interstitial is shown
public void OnInterstitialShown() 
{ 
	Debug.Log("Interstitial opened"); 
} 

// Called when interstitial is closed
public void OnInterstitialClosed() 
{ 
	Debug.Log("Interstitial closed"); 
} 

// Called when interstitial is clicked
public void OnInterstitialClicked() 
{
	Debug.Log("Interstitial clicked"); 
} 

// Called when interstitial is expired and can not be shown
public void OnInterstitialExpired() 
{
	Debug.Log("Interstitial expired"); 
} 

#endregion

1. Extend your class with IInterstitialAdListener:

YourClassName : IInterstitialAdListener;

2. Then call the following method:

Appodeal.setInterstitialCallbacks(this);

3. Now you can use the following callback methods within your public class :

#region Interstitial callback handlers

// Called when interstitial was loaded (precache flag shows if the loaded ad is precache)
public void onInterstitialLoaded(bool isPrecache) 
{ 
	Debug.Log("Interstitial loaded"); 
} 

// Called when interstitial failed to load
public void onInterstitialFailedToLoad() 
{ 
	Debug.Log("Interstitial failed"); 
} 

// Called when interstitial was loaded, but cannot be shown (internal network errors, placement settings, or incorrect creative)
public void onInterstitialShowFailed() 
{ 
	Debug.Log("Interstitial show failed"); 
} 

// Called when interstitial is shown
public void onInterstitialShown() 
{ 
	Debug.Log("Interstitial opened"); 
} 

// Called when interstitial is closed
public void onInterstitialClosed() 
{ 
	Debug.Log("Interstitial closed"); 
} 

// Called when interstitial is clicked
public void onInterstitialClicked() 
{
	Debug.Log("Interstitial clicked"); 
} 

// Called when interstitial is expired and can not be shown
public void onInterstitialExpired() 
{
	Debug.Log("Interstitial expired"); 
} 

#endregion

All callbacks are called on native main threads that do not match the main thread of the Unity. If you need to receive callbacks in the main Unity thread follow our Callback Usage Guide .

Get Predicted eCPM

This method returns expected eCPM for a currently cached advertisement. The amount is calculated based on historical data for the current ad unit.

Appodeal.GetPredictedEcpm(AppodealAdType.Interstitial);

Mute Video Ads (Android Only)

You can mute video ads if calls are muted on the device. For muting you need to call the following code before the initialization method.

Appodeal.MuteVideosIfCallsMuted(true);