Important

Migrating from version 3.5.0 to 3.10.1 This is a major update with breaking changes. Please read our Migration Guide carefully before updating.

npm install react-native-appodeal
# or
yarn add react-native-appodeal

Important

• iOS 13.0 and above for Firebase, IronSource, LevelPlay, DTExchange, Unity, and Yandex. iOS 12.4 for MyTarget. In all other cases, iOS 12.0 is sufficient. You still can integrate Appodeal SDK into a project with a lower value of minimum iOS version. However, on devices that don't support the required iOS version our SDK will just be disabled.
• Appodeal SDK is compatible with both ARC and non-ARC projects.
• Xcode 16.1 or higher.

source 'https://cdn.cocoapods.org'
source 'https://github.com/appodeal/CocoaPods.git'
source 'https://github.com/bidon-io/CocoaPods_Specs.git'

platform :ios, '13.0'

use_frameworks!

def appodeal
   pod 'Appodeal', '3.10.0'
   pod 'APDAmazonAdapter', '3.10.0.0'
   pod 'APDAppLovinAdapter', '3.10.0.0'
   pod 'APDAppLovinMAXAdapter', '3.10.0.0'
   pod 'APDBidMachineAdapter', '3.10.0.0'
   pod 'APDBidonAdapter', '3.10.0.0'
   pod 'APDBigoAdsAdapter', '3.10.0.0'
   pod 'APDDTExchangeAdapter', '3.10.0.0'
   pod 'APDGoogleAdMobAdapter', '3.10.0.0'
   pod 'APDIABAdapter', '3.10.0.0'
   pod 'APDInMobiAdapter', '3.10.0.0'
   pod 'APDIronSourceAdapter', '3.10.0.0'
   pod 'APDLevelPlayAdapter', '3.10.0.0'
   pod 'APDMetaAudienceNetworkAdapter', '3.10.0.0'
   pod 'APDMintegralAdapter', '3.10.0.0'
   pod 'APDMyTargetAdapter', '3.10.0.0'
   pod 'APDPangleAdapter', '3.10.0.0'
   pod 'APDSentryAdapter', '3.10.0.0'
   pod 'APDSmaatoAdapter', '3.10.0.0'
   pod 'APDUnityAdapter', '3.10.0.0'
   pod 'APDVungleAdapter', '3.10.0.0'
   pod 'APDYandexAdapter', '3.10.0.0'
   pod 'AppLovinMediationAmazonAdMarketplaceAdapter', '5.3.0.0'
   pod 'AppLovinMediationBidMachineAdapter', '3.4.0.0.0'
   pod 'AppLovinMediationBidonAdapter', '0.11.0.0'
   pod 'AppLovinMediationBigoAdsAdapter', '4.9.0.0'
   pod 'AppLovinMediationByteDanceAdapter', '7.4.1.1.0'
   pod 'AppLovinMediationChartboostAdapter', '9.9.2.1'
   pod 'AppLovinMediationFacebookAdapter', '6.20.1.0'
   pod 'AppLovinMediationFyberAdapter', '8.3.8.0'
   pod 'AppLovinMediationGoogleAdManagerAdapter', '12.8.0.0'
   pod 'AppLovinMediationGoogleAdapter', '12.8.0.0'
   pod 'AppLovinMediationInMobiAdapter', '10.8.6.0'
   pod 'AppLovinMediationIronSourceAdapter', '8.10.0.0.0'
   pod 'AppLovinMediationMintegralAdapter', '7.7.9.0.0'
   pod 'AppLovinMediationMobileFuseAdapter', '1.9.2.1'
   pod 'AppLovinMediationMolocoAdapter', '3.12.0.0'
   pod 'AppLovinMediationMyTargetAdapter', '5.33.0.0'
   pod 'AppLovinMediationOguryPresageAdapter', '5.0.2.0'
   pod 'AppLovinMediationPubMaticAdapter', '4.8.0.0'
   pod 'AppLovinMediationSmaatoAdapter', '22.9.3.1'
   pod 'AppLovinMediationUnityAdsAdapter', '4.16.0.0'
   pod 'AppLovinMediationVerveAdapter', '3.6.0.0'
   pod 'AppLovinMediationVungleAdapter', '7.5.2.0'
   pod 'AppLovinMediationYandexAdapter', '7.14.1.0'
   pod 'BidMachineAmazonAdapter', '3.4.0.0'
   pod 'BidMachineIronSourceCustomAdapter', '3.4.0.0'
   pod 'BidMachineMetaAudienceAdapter', '3.4.0.0'
   pod 'BidMachineMintegralAdapter', '3.4.0.0'
   pod 'BidMachineMyTargetAdapter', '3.4.0.0'
   pod 'BidMachinePangleAdapter', '3.4.0.0'
   pod 'BidMachineVungleAdapter', '3.4.0.0'
   pod 'BidonAdapterAmazon', '0.11.0.0'
   pod 'BidonAdapterBidMachine', '0.11.0.0'
   pod 'BidonAdapterBigoAds', '0.11.0.0'
   pod 'BidonAdapterChartboost', '0.11.0.0'
   pod 'BidonAdapterDTExchange', '0.11.0.0'
   pod 'BidonAdapterInMobi', '0.11.0.0'
   pod 'BidonAdapterIronSource', '0.11.0.0'
   pod 'BidonAdapterMetaAudienceNetwork', '0.11.0.0'
   pod 'BidonAdapterMintegral', '0.11.0.0'
   pod 'BidonAdapterMobileFuse', '0.11.0.0'
   pod 'BidonAdapterMoloco', '0.11.0.0'
   pod 'BidonAdapterMyTarget', '0.11.0.0'
   pod 'BidonAdapterUnityAds', '0.11.0.0'
   pod 'BidonAdapterVungle', '0.11.0.0'
   pod 'BidonAdapterYandex', '0.11.0.0'
   pod 'ISBidonCustomAdapter', '0.11.0.0'
   pod 'IronSourceAPSAdapter', '4.3.21.0'
   pod 'IronSourceAdMobAdapter', '4.3.69.0'
   pod 'IronSourceAppLovinAdapter', '4.3.56.0'
   pod 'IronSourceBidMachineAdapter', '4.3.20.0'
   pod 'IronSourceBigoAdapter', '4.3.8.0'
   pod 'IronSourceFacebookAdapter', '4.3.51.0'
   pod 'IronSourceFyberAdapter', '4.3.44.0'
   pod 'IronSourceInMobiAdapter', '4.3.30.0'
   pod 'IronSourceMintegralAdapter', '4.3.37.0'
   pod 'IronSourceMobileFuseAdapter', '4.3.8.1'
   pod 'IronSourceMolocoAdapter', '4.3.22.0'
   pod 'IronSourceMyTargetAdapter', '4.3.6.0'
   pod 'IronSourceOguryAdapter', '4.3.3.1'
   pod 'IronSourcePangleAdapter', '4.3.51.0'
   pod 'IronSourceSmaatoAdapter', '4.3.17.1'
   pod 'IronSourceUnityAdsAdapter', '4.3.54.0'
   pod 'IronSourceVerveAdapter', '4.3.6.1'
   pod 'IronSourceVungleAdapter', '4.3.46.0'
   pod 'IronSourceYandexAdapter', '4.3.21.0'
end

target 'YourAppName' do
  use_frameworks!
  use_modular_headers!
  appodeal

  config = use_native_modules!
  use_react_native!(:path => config[:reactNativePath])
end

Important

• Android API level 23 (Android OS 6.0) or higher.
• Kotlin 2.1.0

dependencies {
    // ... other project dependencies
    implementation ('com.appodeal.ads:sdk:3.10.0.0') {
        exclude group: 'com.appodeal.ads.sdk.services', module: 'adjust'
        exclude group: 'com.appodeal.ads.sdk.services', module: 'appsflyer'
        exclude group: 'com.appodeal.ads.sdk.services', module: 'firebase'
        exclude group: 'com.appodeal.ads.sdk.services', module: 'facebook_analytics'
    }
    ...
}

allprojects {
    repositories {
        ...
        jcenter()
        maven { url "https://artifactory.appodeal.com/appodeal" }
        ...
    }
}

Warning

AdMob Bidding is now available since Appodeal SDK 3.2.0. Don't forget to download our newest version of AdMob Sync tool from this page and perform sync. You can read more about AdMob Sync in our guide.

dependencies {
    // ... other project dependencies
    implementation 'com.appodeal.ads.sdk.services:adjust:3.10.0.0'
}

def appodeal
  // ... other project pods
  pod 'APDAdjustAdapter', '3.10.0.0'
end

dependencies {
    // ... other project dependencies
  implementation 'com.appodeal.ads.sdk.services:appsflyer:3.10.0.0'
}

def appodeal
  // ... other project pods
  pod 'APDAppsFlyerAdapter', '3.10.0.0'
end

dependencies {
    // ... other project dependencies
    implementation 'com.appodeal.ads.sdk.services:firebase:3.10.0.0'
}

def appodeal
  // ... other project pods
  pod 'APDFirebaseAdapter', '3.10.0.0'
end

dependencies {
    // ... other project dependencies
    implementation 'com.appodeal.ads.sdk.services:facebook_analytics:3.10.0.0'
}

def appodeal
  // ... other project pods
  pod 'APDFacebookAdapter', '3.10.0.0'
end

import { AppodealIOSPurchaseType } from 'react-native-appodeal';

const purchase = {
  productId: 'com.example.product',
  productType: AppodealIOSPurchaseType.CONSUMABLE, // or NON_CONSUMABLE, AUTO_RENEWABLE_SUBSCRIPTION, NON_RENEWING_SUBSCRIPTION
  price: 9.99, // number type
  currency: 'USD',
  transactionId: 'transaction_12345',
  additionalParameters: {}
};

Appodeal.validateAndTrackInAppPurchase(purchase)
  .then((result) => {
    console.log('Purchase validation result:', result);
    console.log('Order ID:', result.orderId);
    console.log('Price:', result.price, result.currency);
  })
  .catch((error) => {
    console.log('Purchase validation failed:', error);
  });

import { AppodealAndroidPurchaseType } from 'react-native-appodeal';

const purchase = {
  publicKey: 'your_public_key',
  productType: AppodealAndroidPurchaseType.IN_APP, // or SUBSCRIPTION
  signature: 'purchase_signature',
  purchaseData: 'purchase_data_json',
  purchaseToken: 'purchase_token',
  timestamp: Date.now(), // Purchase timestamp in milliseconds
  developerPayload: 'developer_payload',
  price: '9.99', // string type for Android
  currency: 'USD',
  orderId: 'order_12345',
  sku: 'com.example.product',
  additionalParameters: {}
};

Appodeal.validateAndTrackInAppPurchase(purchase)
  .then((result) => {
    console.log('Purchase validation result:', result);
    console.log('Order ID:', result.orderId);
    console.log('SKU:', result.sku);
    console.log('Price:', result.price, result.currency);
    console.log('Timestamp:', new Date(result.timestamp).toLocaleString());
  })
  .catch((error) => {
    console.log('Purchase validation failed:', error);
  });

Appodeal.trackEvent("example_event_name", {
  "example_param_1": "example_param_value_1",
  "example_param_2": 123
});

import Appodeal, { AppodealAdType } from 'react-native-appodeal';

Appodeal.initialize('YOUR_APPODEAL_APP_KEY', 
  AppodealAdType.INTERSTITIAL | 
  AppodealAdType.REWARDED_VIDEO | 
  AppodealAdType.BANNER | 
  AppodealAdType.MREC
);

// Set ad auto caching enabled or disabled
// By default autocache is enabled for all ad types
Appodeal.setAutoCache(AppodealAdType.INTERSTITIAL, false); //default - true

// Set testing mode
Appodeal.setTesting(false); //default - false

// Set Appodeal SDK logging level
Appodeal.setLogLevel(AppodealLogLevel.VERBOSE); //default - AppodealLogLevel.NONE

// Enable or disable child direct treatment
Appodeal.setChildDirectedTreatment(false); //default - false

// Disable network for specific ad type
Appodeal.disableNetwork("admob");
Appodeal.disableNetwork("admob", AppodealAdType.INTERSTITIAL);

// Set extras
Appodeal.setExtrasValue("attribution_id", "some value");

// Set custom state
Appodeal.setCustomStateValue("user_level", 42);

// Enable or disable tablet banners.
Appodeal.setTabletBanners(false); //default - false

// Enable or disable smart banners. 
Appodeal.setSmartBanners(false); //default - false

// Enable or disable banner refresh animation
Appodeal.setBannerAnimation(true); //default - true

import { AppodealBannerEvents } from 'react-native-appodeal';

Appodeal.addEventListener(AppodealBannerEvents.LOADED, () => {
  console.log('Banner loaded');
});

Appodeal.addEventListener(AppodealBannerEvents.FAILED_TO_LOAD, () => {
  console.log('Banner failed to load');
});

Appodeal.addEventListener(AppodealBannerEvents.SHOWN, () => {
  console.log('Banner shown');
});

Appodeal.addEventListener(AppodealBannerEvents.CLICKED, () => {
  console.log('Banner clicked');
});

Appodeal.addEventListener(AppodealBannerEvents.EXPIRED, () => {
  console.log('Banner expired');
});

import { AppodealInterstitialEvents } from 'react-native-appodeal';

Appodeal.addEventListener(AppodealInterstitialEvents.LOADED, () => {
  console.log('Interstitial loaded');
});

Appodeal.addEventListener(AppodealInterstitialEvents.FAILED_TO_LOAD, () => {
  console.log('Interstitial failed to load');
});

Appodeal.addEventListener(AppodealInterstitialEvents.SHOWN, () => {
  console.log('Interstitial shown');
});

Appodeal.addEventListener(AppodealInterstitialEvents.CLICKED, () => {
  console.log('Interstitial clicked');
});

Appodeal.addEventListener(AppodealInterstitialEvents.CLOSED, () => {
  console.log('Interstitial closed');
});

Appodeal.addEventListener(AppodealInterstitialEvents.EXPIRED, () => {
  console.log('Interstitial expired');
});

import { AppodealRewardedEvents } from 'react-native-appodeal';

Appodeal.addEventListener(AppodealRewardedEvents.LOADED, () => {
  console.log('Rewarded video loaded');
});

Appodeal.addEventListener(AppodealRewardedEvents.FAILED_TO_LOAD, () => {
  console.log('Rewarded video failed to load');
});

Appodeal.addEventListener(AppodealRewardedEvents.SHOWN, () => {
  console.log('Rewarded video shown');
});

Appodeal.addEventListener(AppodealRewardedEvents.REWARD, (reward) => {
  console.log('User earned reward:', reward.amount, reward.name);
});

Appodeal.addEventListener(AppodealRewardedEvents.CLOSED, () => {
  console.log('Rewarded video closed');
});

Appodeal.addEventListener(AppodealRewardedEvents.EXPIRED, () => {
  console.log('Rewarded video expired');
});

Appodeal.addEventListener(AppodealRewardedEvents.CLICKED, () => {
  console.log('Rewarded video clicked');
});

Appodeal.cache(AppodealAdType.INTERSTITIAL);

// Check that interstitial can be shown
const canShow = Appodeal.canShow(AppodealAdType.INTERSTITIAL);
// Check that interstitial is loaded
const isLoaded = Appodeal.isLoaded(AppodealAdType.INTERSTITIAL);

// Show interstitial
Appodeal.show(AppodealAdType.INTERSTITIAL);

// Show banner
Appodeal.show(AppodealAdType.BANNER_BOTTOM); // Display banner at the bottom of the screen
Appodeal.show(AppodealAdType.BANNER_TOP); // Display banner at the top of the screen

// Show interstitial for specific placement
Appodeal.show(AppodealAdType.INTERSTITIAL, "placementName");

Appodeal.hide(AppodealAdType.BANNER_TOP); //AppodealAdType.MREC

import { AppodealBanner } from 'react-native-appodeal';

<AppodealBanner 
  adSize="banner" 
  placement="default"
  onAdLoaded={() => console.log('Banner loaded')}
  onAdFailedToLoad={() => console.log('Banner failed to load')}
  onAdClicked={() => console.log('Banner clicked')}
  onAdExpired={() => console.log('Banner expired')}
  style={{ width: 320, height: 50 }}
/>

import { AppodealMrec } from 'react-native-appodeal';

<AppodealMrec 
  placement="default"
  onAdLoaded={() => console.log('MREC loaded')}
  onAdFailedToLoad={() => console.log('MREC failed to load')}
  onAdClicked={() => console.log('MREC clicked')}
  onAdExpired={() => console.log('MREC expired')}
  style={{ width: 300, height: 250 }}
/>

Important

STARTING FROM APPODEAL SDK 3.0, STACK CONSENT MANAGER IS INCLUDED BY DEFAULT. Consent will be requested automatically on SDK initialization, and consent form will be shown if it is necessary without any additional calls.

Appodeal.requestConsentInfoUpdate('YOUR_APPODEAL_APP_KEY').then((status) => {
  console.log('Consent info updated with status:', status);
});

Appodeal.showConsentFormIfNeeded().then((status) => {
  console.log('Consent form closed with status:', status);
});

Appodeal.showConsentForm().then((status) => {
  console.log('Consent form closed with status:', status);
});

Appodeal.revokeConsent();

const status = Appodeal.consentStatus();
console.log('Current consent status:', status);

<key>NSUserTrackingUsageDescription</key>
<string>This identifier will be used to deliver personalized ads to you.</string>