Get Started

Release version:  2.11.1 | Release date: 05.04.2022

Minimum requirements:

Android API level 16 (Android OS 4.1), but you can integrate the Appodeal SDK in apps with lower minSdkVersion.
On the devices that don't support Android 4.1+, our SDK will just be disabled

You can use our demo app  as a reference project.

Import SDK

Preparing your Gradle build for Android 11+

Starting from Android 11 changes how apps can query and interact with other apps that the user has installed on a device. For this reason, make sure you are using a Gradle version that matches one of those listed .

 Configure build.gradle

To get Gradle dependencies, click Generate build.gradle. You can build gradle dependencies for a specific ad type and with a specific set of ad network adapters. To do this, select the necessary parameters below:

Disabling ad networks

We recommend using the standard Gradle config, as disabling some of the recommended adapters can negatively affect revenue.

Depend on the version of Android Studio you are using, insert into a Gradle file the generated dependencies:

Once that's done, save the file and perform the Gradle sync

Set up the project

Network security configuration

Android 9.0 (API 28) blocks cleartext (non-HTTPS) traffic by default, which can prevent ads from serving correctly. Read more on this here .

To prevent the android system from blocking http traffic, follow these steps:

1. Add the Network Security Configuration file to your AndroidManifest.xml :

<?xml version="1.0" encoding="utf-8"?>
2. In your network_security_config.xml file, add base-config that sets cleartextTrafficPermitted to true :
<?xml version="1.0" encoding="utf-8"?>
    <base-config cleartextTrafficPermitted="true">
            <certificates src="system" />
    <domain-config cleartextTrafficPermitted="true">
        <domain includeSubdomains="true"></domain>

Configure Admob meta-data 

Only if you use AdMob adapter. 

Add your AdMob app id to meta-data tag:

        <!-- Add your AdMob App ID -->
You may find the AdMob app id in your personal account on the AdMob page:

For more information about Admob sync check out our FAQ.

Initialize SDK

We recommended to call initialization method in your MainActivity  - onCreate method:

protected void onCreate(Bundle savedInstanceState) {
    Appodeal.initialize(this, "YOUR_APP_KEY", adTypes, consent);

Make sure to replace YOUR_APP_KEY with the actual app key.  You can find it in the list of applications in your personal account.

Use the type codes below to set the preferred ad format:

  • Appodeal.INTERSTITIAL for interstitial;
  • Appodeal.REWARDED_VIDEO for rewarded videos;
  • Appodeal.NATIVE for native ads;
  • Appodeal.BANNER for banners;
  • Appodeal.MREC for 300*250 banners.

Please note:

Ad types can be combined using "|" operator. For example, Appodeal.INTERSTITIAL | Appodeal.REWARDED_VIDEO.

Configure ad types

Appodeal SDK is now imported and you're ready to implement an ad. Appodeal offers a number of different ad formats, so you can choose the one that best fits your app's user experience.

Full-screen ad that engages users with a captivating video.

User-initiated ads where users can earn in-app rewards in exchange for viewing a video ad.

Traditional ad format that neatly places a small ad at the top or bottom of the screen.

Medium-size ads that appear within in-app content the same as banner ads.

Ad format that seamlessly fits within the context of an app’s content.

Preparing to publish your application

 Add Privacy Policy

Make sure to add Privacy Policy to your app on Google Play that links to Appodeal's Privacy Policy to avoid violating Google Play Developer Distribution Agreement .

According to  Google policy , location permissions may only be requested to provide features beneficial to the user and relevant to the core functionality of the app. You cannot request access to location data for the sole purpose of advertising or analytics.

If you are not using location for the main functions of your app

  • Remove location permission in your app by adding the following code to AndroidManifest.xml
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"
	tools:node="remove" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
	tools:node="remove" />
  • Update the app on Google Play. During the publishing process, make sure there are no location warnings in Google Play Console.

If you are using location for the main functions of your app

  • Fill out the Location permissions declaration form in  Google Play Console .
    You can read more about the declaration form 
    here .
  • Update the app on Google Play. During the publishing process, make sure there are no location warnings in Google Play Console.

Some networks and 3rd party dependencies (related to network dependencies) can include their own permissions to the manifest. If you want to force remove such permissions you can refer to this guide.