Release version: 3.0.1 | Release date: 08.11.2022

Follow this guide to get the best out of Appodeal.

The Appodeal SDK gives you access to 70+ Ad Demand Sources and makes them compete against each other in a real-time auction, maximizing your ad revenues. The Appodeal SDK also provides In-app Bidding, Automatic UA Optimization, User Segmentation & A/B Testing, Cross-Promotion and Direct Deals, Instant Payouts, and much more.

The following document shows how to integrate Appodeal in your Unity project with your desired networks, and configure all your ad formats.

Check our video guide on how to integrate Appodeal SDK in your app.

Import SDK

https://github.com/appodeal/appodeal-unity-plugin-upm.git#v3.0.1

Configure Project

Android Configuration

Gradle settings 

External Dependency Manager

Appodeal Unity Plugin includes External Dependency Manager package. You need to complete these following steps to resolve Appodeal's dependencies:

1. Before switching to Android platform, select  File → Build Settings → Android  in Unity menu bar.

2. Add flag Custom Gradle Template for Unity 2017.4 - Unity 2019.2 versions or for Unity 2019.3 and higher activate the following toggles under Build Settings → Player Settings → Publishing settings:

• • Custom Main Gradle Template
  • Custom Gradle Properties Template

3. Enable the setting "Patch mainTemplate.gradle" (Assets → External Dependency Manager → Android Resolver → Settings).

4. Enable the setting "Use Jetifier" (Assets → External Dependency Manager → Android Resolver → Settings).

5. Then run Assets → External Dependency Manager → Android Resolver and press Resolve or Force Resolve.

6. As a result, the modules, that are required for Appodeal SDK work, will be imported to project's mainTemplate.gradle file.

Configure AndroidManifest.xml

We distinguish 2 sets of permissions: required permissions, that are obligatory for the correct work of Appodeal SDK, and optional permissions, that can be used for better targeting. For more information about the purpose of each of the permissions, see this FAQ section.

• These are the required permissions

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

• These are the optional permissions

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.VIBRATE" />

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"
	tools:node="remove" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
	tools:node="remove" />

Multidex Support

• If you are using Unity 2019.2 and versions below you need to add Multidex support to your project. Follow this guide to add Multidex.

• If you are using Unity 2019.3 or higher go to Player Settings → Publishing Settings → Other Settings and change Minimum API Level to 21 or higher.

iOS Configuration

External Dependency Manager

Turn off "Link frameworks statically" option following the path Assets -> External Dependency Manager -> iOS Resolver -> Settings -> Link frameworks statically - OFF

Add SKAdNetworkIds

Ad networks used in Appodeal mediation support conversion tracking using Apple's SKAdNetwork , which means ad networks are able to attribute an app install even when IDFA is unavailable. To enable this functionality, you will need to update the SKAdNetworkItems key with an additional dictionary in your  Info.plist . 

Configure App Transport Security Settings

In order to serve ads, the SDK requires you to allow arbitrary loads. Set up NSAppTransportSecurity key to allow arbitrary loads following the steps:

<key>NSAppTransportSecurity</key>
<dict>
  <key>NSAllowsArbitraryLoads</key>
  <true/>
</dict>

Other feature usage descriptions

To improve ad performance the the following entries may be added:

1. NSUserTrackingUsageDescription - As of iOS 14 using IDFA requires permission from the user. The following entry must be added in order to improve ad performance.
2. NSLocationWhenInUseUsageDescription - Entry is required if your application allows Appodeal SDK to use location data.
3. NSCalendarsUsageDescription - Recommended by some ad networks.
   
   

<key>NSUserTrackingUsageDescription</key>
<string><App Name> needs your advertising identifier to provide personalised advertising experience tailored to you</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string><App Name> needs your location for analytics and advertising purposes</string>
<key>NSCalendarsUsageDescription</key>
<string><App Name> needs your calendar to provide personalised advertising experience tailored to you</string>

Known issues

1. AdColony presentation issue

AdColony always checks, if the key window’s rootViewController matches the passed rootViewController. Otherwise, Adcolony fails to present the ad. If your app has multiple independent windows, you can get a message with this or similar text:

It means, that the rootViewController that was used in showAd, doesn't belong to the first window in the array. 

Admob Configuration 

AdMob App ID is the unique ID assigned to your app.
To find the AdMob App ID in your AdMob account, go to Apps → your application → app settings and copy the AdMob App ID. 

Add AdMob App Ids from the Unity Menu bar Appodeal → Appodeal Settings tool for each platform. 

For more information about Admob sync check out our Admob connection guide.

Initialize SDK

Before loading and displaying ads, you need to initialize Appodeal SDK, as follows:

Import Namespaces

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

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

Add Lines In Code

Add the following сode to  Start() method of your main scene’s MonoBehavior  

private void Start() 
{ 
	int adTypes = AppodealAdType.Interstitial | AppodealAdType.Banner | AppodealAdType.RewardedVideo | AppodealAdType.Mrec; 
	string appKey = "YOUR_APPODEAL_APP_KEY";
	AppodealCallbacks.Sdk.OnInitialized += OnInitializationFinished;
	Appodeal.Initialize(appKey, adTypes); 
} 
... 
#region Initialization Callback
public void OnInitializationFinished(object sender, SdkInitializedEventArgs e)
{
	Debug.Log("Initialization Finished");   
}
#endregion

class Test : IAppodealInitializationListener 
... 
private void Start() 
{ 
	int adTypes = AppodealAdType.Interstitial | AppodealAdType.Banner | AppodealAdType.RewardedVideo | AppodealAdType.Mrec; 
	string appKey = "YOUR_APPODEAL_APP_KEY"; 
	Appodeal.Initialize(appKey, adTypes, this); 
} 
... 
public void OnInitializationFinished(List<string> errors) {}

class Test : IAppodealInitializationListener 
... 
private void Start() 
{ 
	int adTypes = Appodeal.INTERSTITIAL | Appodeal.BANNER | Appodeal.REWARDED_VIDEO | Appodeal.MREC;
	string appKey = "YOUR_APPODEAL_APP_KEY"; 
	Appodeal.initialize(appKey, adTypes, this); 
} 
... 
public void onInitializationFinished(List<string> errors) {}

Configure Ad Types

For completing implementation integrate showing of ad types to your application.