Get started

Release version: 3.0.2 | Release date: 17.01.2023
Beta release version: 3.1.3-beta.1 | Release date: 26.05.2023

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.

Appodeal SDK provides two ways of integration. From the options below, choose the one that fits your needs better:

  1. The Appodeal SDK Full Package - The Appodeal SDK provides you with tools to grow your mobile apps and games.
    In addition to the monetization services, you can benefit from UA (User Acquisition) and in-app analytics services. 

    Here is the list of services Appodeal SDK Full Package includes :
    • Get started with Appodeal to gain access to Monetization and Analytics.

    • Connect with Adjust or Appsflyer to unlock Attribution features.

    • Connect with Meta (formerly known as facebook-core) for User Acquisition.

    • Connect with Firebase for Analytics + remote config for product A/B tests and settings.

    If you plan to run UA campaigns, want to analyze your metrics in our Appodeal’s business intelligence tool without using MMP, or want to use remote config for tests and settings, your option is - the full package.

  2. The Appodeal SDK Mediation only - If you do not plan to run (UA) User Acquisition campaigns, nor want to use Appodeal advanced analytics, we have created a lite version of our SDK, only with mediation. 
    During the integration, you will not be required to install any additional services apart from mediation.
    This may speed up your integration process, and you can always upgrade to the Full Package whenever you’re ready.

Please follow this integration guide step by step and choose your integration option when needed.

The following document shows how to integrate Appodeal in your Android project with your desired networks via gradle build setup, and configure all your ad formats.

Minimum requirements:

Android API level 21 (Android OS 5.0) or higher.

You can use our demo app as a reference project.

Import SDK

 Configure Build.gradle

Disabling ad networks

As you have selected Appodeal SDK Full Package option, make sure you have not excluded services from the build.

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

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.

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

Please note:

To upgrade to the Appodeal 3.0 version, please refer to the upgrade guide page.

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 Admob guide.

Initialize SDK

We recommended to call initialization method in your MainActivity  - onCreate method only once in your whole app:

protected void onCreate(Bundle savedInstanceState) { 
	Appodeal.initialize(activity, appKey, adTypes, new ApdInitializationCallback() { 
		@Override public void onInitializationFinished(@Nullable List<ApdInitializationError> list) {
			//Appodeal initialization finished 

activity - activity of your application. []
appKey - Appodeal app key you received when you created an app. 
adTypes - type of advertising you want to initialize. Initialize only those ad types you want to use in your app to avoid getting ad requests to unused ones.

You may find an app key 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.

callback - Appodeal initialization callback ApdInitializationCallback. Initialization callback is used to determine Appodeal SDK initialization result. Called when Appodeal initialization has been finished.
If initialization succeeds, errors are null. Otherwise, it contains a list of errors.

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 and under the <manifest> tag.
<manifest xmlns:android="" xmlns:tools=""
<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 
  • 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.

 Add App-ads.txt File

The app-ads.txt file is a text file which provides a mechanism for publishers to declare their authorized digital sellers. Created by IAB, it is an extension of the original ads.txt standard that was used for the same purpose in web advertising. It helps ad networks and DSPs easily verify whether an ad network or exchange they are buying your traffic from is actually allowed to sell it.

Adding app-ads.txt augments trust between advertisers, demand partners and publishers. If publishers do not have their own website where they can place an add app-ads.txt file, premium brand demand may be unavailable to them.

If you don't have app-ads.txt file yet:

  1. Add developer website URL to your Google Play and App Store apps.

  2. Download Appodeal's app-ads.txt from this page

  3. Upload app-ads.txt file to the root path of your developer website (it should look like this:

If you already have app-ads.txt:

  1. Copy Appodeal's app-ads.txt from this page.

  2. Paste the content to your app-ads.txt.