React Native Module created to support Appodeal SDK for iOS and Android platforms
npm install react-native-appodealOfficial Appodeal React Native Plugin for your React Native application.
- Google CMP and TCF v2 Support
- To enhance the relevance of ads for your users and comply with regulations like GDPR and CCPA,
explicit user consent is required for collecting personal data.
- We recommend using the Stack Consent Manager, built on Google User Messaging Platform (UMP),
as a ready-made solution to obtain user consent.
- Follow this instruction to
configure Google UMP and set up a consent form.
- If you have questions about Stack Consent Manager and Google UMP, please contact our support team.
- AdMob Bidding Support
- Download our newest version of AdMob Sync tool from this page and perform a sync.
- Read more about AdMob Sync in our guide.
- Already included ready-made consent solution
- Starting from Appodeal SDK 3.0, during the first initialization, a ready-made consent window will be shown if the user is in regions
covered by GDPR and CCPA. See more about this behavior
- Support Monetization + UA + Analytics data services
- Get insights and find out if your active UA campaigns bring you revenue or make you lose money.
- Track your metrics with Firebase Keywords. Analyze how product A/B test (via Firebase remote config) affects both
your product and monetization. See more about services
- 🚀 Turbo Modules Implementation
- This library has been migrated to use React Native's Turbo modules architecture, providing better performance, type safety, and future compatibility.
- New and Old Architecture Support
- Full support for both React Native Old Architecture (0.68+) and New Architecture (0.74+)
- Seamless integration with Fabric renderer and TurboModules
- Backward compatibility maintained for existing projects
> [!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.
Key Changes in 3.10.1:
- Updated to Appodeal SDK 3.10.0
- Migrated to React Native Turbo Modules
- New Architecture support (Fabric + TurboModules)
- Updated TypeScript definitions
- New event system with better type safety
- đź’Ą Breaking changes in API methods and event names
- 🛠️ Updated Kotlin to version 2.1.0 — this may be a ⚠️ breaking change for projects still using Kotlin < 2.0.0
- Installation
- iOS
- Android
- AdMob configuration
- Services
- Adjust
- AppsFlyer
- Firebase
- Meta
- Tracking In-App Purchases
- Event tracking
- Usage
- Initialisation
- Callbacks
- Presentation
- Ad Components
- Privacy Policy and Consent
- Step 1: Update Privacy Policy
- Step 2: Appodeal Consent Solution
- App-ads.txt
- App Tracking Transparency
- Changelog
Add the dependency to your React Native project:
``bash`
npm install react-native-appodealor
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.
1. Go to ios/ folder and open Podfile./ios/Podfile
2. Add Appodeal adapters. Add pods into :
`ruby
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
`
You can change following implementation to use custom mediation setup.
See docs.
> Note: Appodeal requires to use use_frameworks!. You need to remove Flipper dependency from Podfile and AppDelegate.
3. Call pod install
4. Open
5. Configure .
#### SKAdNetworkIds
Ad networks used in Appodeal mediation support conversion tracking using Apple's SKAdNetwork,SKAdNetworkItems
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 key with an additionalInfo.plist
dictionary in your .
- Select Info.plist in the Project navigator in Xcode
- Right-click on Info.plist file → Open as → Source Code
- Add SKAdNetworkIds according to doc
#### App Transport Security
In order to serve ads, the SDK requires you to allow arbitrary loads. Set up the following keys
in Info.plist of your app:
- Go to your Info.plist file, then press Add+ anywhere in the first column of the key list.
- Add App Transport Security Settings key and set its type to Dictionary in the second
column.
- Press Add+ at the end of the name App Transport Security Settings key and choose **Allow
Arbitrary loads. Set its type to Boolean and its value to Yes**.
There is App Transport Security settings in Info.plist format
` xml`
#### Other feature usage descriptions
To improve ad performance the following entries should be added:
- NSUserTrackingUsageDescription - Starting from iOS 14, using IDFA requires permission from the user. The following
entry must be added in order to improve ad performance.
- NSLocationWhenInUseUsageDescription - Entry is required if your application allows Appodeal SDK to use location
data.
- NSCalendarsUsageDescription - Recommended by some ad networks.
There is Other feature usage descriptions settings in Info.plist format
` xml`
6. Build your project
> [!IMPORTANT]
> - Android API level 23 (Android OS 6.0) or higher.
> - Kotlin 2.1.0
1. Add Appodeal adapters.
Add dependencies into android/app/build.gradle
` groovy`
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'
}
...
}
Add repository into android/build.gradle
` groovy`
allprojects {
repositories {
...
jcenter()
maven { url "https://artifactory.appodeal.com/appodeal" }
...
}
}
> Note: You can change following implementation to use custom mediation setup.
> See Docs.
2. Build your project
#### AdMob configuration
> [!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.
- How to add AdMob Ad Network to your project:
Add your AdMob app id to meta-data tag in android/app/src/main/AndroidManifest.xml:
`xml`
android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
Add your AdMob app id to Info.plist.
Use the key GADApplicationIdentifier with the value being your AdMob app ID:
`xml`
- How to remove AdMob Ad Network from your project:
Change next dependencies into android/app/build.gradle
`groovy`
dependencies {
...
// ... other project dependencies
implementation('com.appodeal.ads:sdk:3.10.0.0') {
// ad networks
exclude group: "com.appodeal.ads.sdk.networks", module: "admob"
exclude group: "com.applovin.mediation", module: "google-adapter"
exclude group: "com.applovin.mediation", module: "google-ad-manager-adapter"
exclude group: "com.unity3d.ads-mediation", module: "admob-adapter"
// services
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'
}
...
}
Remove next pods from Podfile:
`ruby`
pod 'APDGoogleAdMobAdapter'
pod 'AppLovinMediationGoogleAdManagerAdapter'
pod 'AppLovinMediationGoogleAdapter'
pod 'IronSourceAdMobAdapter'
Please, read iOS and Android docs at wiki to get deeper understanding how
Appodeal SDK Services works.
Add dependencies into android/app/build.gradle
`groovy`
dependencies {
// ... other project dependencies
implementation 'com.appodeal.ads.sdk.services:adjust:3.10.0.0'
}
Add dependencies into _Podfile_
`ruby`
def appodeal
// ... other project pods
pod 'APDAdjustAdapter', '3.10.0.0'
end
Add dependencies into android/app/build.gradle
`groovy`
dependencies {
// ... other project dependencies
implementation 'com.appodeal.ads.sdk.services:appsflyer:3.10.0.0'
}
Add dependencies into _Podfile_
`ruby`
def appodeal
// ... other project pods
pod 'APDAppsFlyerAdapter', '3.10.0.0'
end
Add dependencies into android/app/build.gradle
`groovy`
dependencies {
// ... other project dependencies
implementation 'com.appodeal.ads.sdk.services:firebase:3.10.0.0'
}
Add dependencies into _Podfile_
`ruby`
def appodeal
// ... other project pods
pod 'APDFirebaseAdapter', '3.10.0.0'
end
Add dependencies into android/app/build.gradle
`groovy`
dependencies {
// ... other project dependencies
implementation 'com.appodeal.ads.sdk.services:facebook_analytics:3.10.0.0'
}
Add dependencies into _Podfile_
`ruby`
def appodeal
// ... other project pods
pod 'APDFacebookAdapter', '3.10.0.0'
end
#### Tracking In-App Purchases
> Note: In-App purchase tracking will work only with connection with Adjust/AppsFlyer.
It's possible to track in-app purchase information and send info to Appodeal servers for analytics. It allows to group
users by the fact of purchasing in-apps. This will help you to adjust the ads for such users or simply turn it off, if
needed. To make this setting work correctly, please submit the purchase info via the Appodeal SDK.
* For App Store:
`javascript
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);
});
`
* For Play Store:
`javascript
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);
});
`
#### Event tracking
Appodeal SDK allows you to send events to all analytic services such as Firebase, AppsFlyer, Adjust
and Meta using a single method:
`javascript`
Appodeal.trackEvent("example_event_name", {
"example_param_1": "example_param_value_1",
"example_param_2": 123
});
Please, read iOS and Android docs at wiki to get deeper understanding how
Appodeal SDK works.
1. Initialize Appodeal at application launch. To initialize Appodeal SDK use this following method:
`javascript
import Appodeal, { AppodealAdType } from 'react-native-appodeal';
Appodeal.initialize('YOUR_APPODEAL_APP_KEY',
AppodealAdType.INTERSTITIAL |
AppodealAdType.REWARDED_VIDEO |
AppodealAdType.BANNER |
AppodealAdType.MREC
);
`
> Note: Make sure to replace "YOUR_APPODEAL_APP_KEY" with the actual app key.
Use the type codes below to set the preferred ad format:
- AppodealAdType.INTERSTITIAL for interstitial.AppodealAdType.REWARDED_VIDEO
- for rewarded videos.AppodealAdType.BANNER
- for banners.AppodealAdType.MREC
- for 300*250 banners.
2. Configure SDK
* General configuration
> Call this method before initialization
` javascript
// 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);
`
* Segments and targeting.
` javascript
// Set extras
Appodeal.setExtrasValue("attribution_id", "some value");
// Set custom state
Appodeal.setCustomStateValue("user_level", 42);
`
* Banner specific
` javascript
// 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
`
Set callbacks listener to get track of ad lifecycle events.
1. Banner
`javascript
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');
});
`
2. Interstitial
`javascript
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');
});
`
3. Rewarded video
`javascript
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');
});
`
> Note: All presentation specific methods are available only after SDK initialization
1. Caching
If you disable autocache you should call cache method before trying to show any ad
` javascript`
Appodeal.cache(AppodealAdType.INTERSTITIAL);
2. Check that ad is loaded and can be shown
` javascript`
// Check that interstitial can be shown
const canShow = Appodeal.canShow(AppodealAdType.INTERSTITIAL);
// Check that interstitial is loaded
const isLoaded = Appodeal.isLoaded(AppodealAdType.INTERSTITIAL);
3. Show advertising
` javascript
// 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");
`
4. Hide
You can hide banner/MREC ad after it was shown. Call hide method with another ad types won't affect anything
` javascript`
Appodeal.hide(AppodealAdType.BANNER_TOP); //AppodealAdType.MREC
Display banner/MREC ad view at a custom position
> Note: Ad Components presentation support only fixed banners size - 320x50 and 300x250.
To display a Banner view add component:
`javascript
import { AppodealBanner } from 'react-native-appodeal';
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 }}
/>
`
To display a MREC view add component:
`javascript
import { AppodealMrec } from 'react-native-appodeal';
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 }}
/>
`
> Note: Keep in mind that it's best to contact qualified legal professionals, if you haven't done so already, to get
> more information and be well-prepared for compliance.
The General Data Protection Regulation, better known as GDPR, took effect on May 25, 2018. It's a set of rules designed
to give EU citizens more control over their personal data. Any businesses established in the EU or with users based in
Europe are required to comply with GDPR or risk facing heavy fines. The California Consumer Privacy Act (CCPA) went into
effect on January 1, 2020. **We have put together some resources below to help publishers understand better the steps
they need to take to be GDPR compliant.**
> Note: You can learn more about GDPR and CCPA and their.
> differences here.
1.1 Make sure your privacy policy includes information about advertising ID collection.
Don't forget to add information about IP address and advertising ID collection, as well
as the link to Appodeal's privacy policy to your app's privacy policy in
Google Play and App Store.
To speed up the process, you could
use privacy policy generators —just insert advertising ID, IP
address, and location (if you collect a user' location) in the "Personally Identifiable Information you collect" field (
in line with other information about your app)
and the link to Appodeal's privacy policy in "Link to the privacy policy of
third party service providers used by the app".
1.2 Add a privacy policy to your mobile app.
You must add your explicit privacy policies in two places: your app's Store Listing page and within your app.
You can find detailed instructions on adding your privacy policy to your app on legal service websites. For example,
Iubenda, the solution tailored to legal compliance, provides
a comprehensive guide on including a privacy policy in
your app.
Make sure that your privacy policy website has an SSL-certificate—this point might seem to be obvious, but it's still
essential.
Here's are two useful resources that you can utilize while working on your app compliance:
Privacy, Security and Deception regulations (by Google Play)
Recommendations on Developing a Meaningful Privacy Policy (by Attorney General California Department of Justice)
> Note: Please note that although we're always eager to back you up with valuable information, we're not authorized to
> provide any legal advice. It's important to address your questions to lawyers who work specifically in this area.
In order for Appodeal and our ad providers to deliver ads that are more relevant to your users, as a
mobile app publisher, you need to collect explicit user consent in the regions covered by GDPR and
CCPA.
To get consent for collecting personal data of your users, we suggest you use a ready-made
solution - Stack Consent Manager based on Google User Messaging Platform (UMP).
> [!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.
If you wish, you can manage and update consent manually using Stack Consent Manager calls.
- Request consent info update
`javascript`
Appodeal.requestConsentInfoUpdate('YOUR_APPODEAL_APP_KEY').then((status) => {
console.log('Consent info updated with status:', status);
});
- Show consent form if needed
`javascript`
Appodeal.showConsentFormIfNeeded().then((status) => {
console.log('Consent form closed with status:', status);
});
- Force show consent form
`javascript`
Appodeal.showConsentForm().then((status) => {
console.log('Consent form closed with status:', status);
});
- Revoke consent
`javascript`
Appodeal.revokeConsent();
- Get consent status
`javascript`
const status = Appodeal.consentStatus();
console.log('Current consent status:', status);
The app-ads.txt file is a text file which provides a mechanism for publishers to declare their authorized digital sellers.
You can find detailed information here.
Starting in iOS 14.5, IDFA will be unavailable until an app calls the App Tracking Transparency
framework to present the app-tracking authorization request to the end-user. If an app does not
present this request, the IDFA will automatically be zeroed out, which may lead to a significant
loss in ad revenue.
You can read more about App Tracking Transparency in our guide.
To display the App Tracking Transparency authorization request for accessing the IDFA, update your
Info.plist to add the NSUserTrackingUsageDescription key with a custom message describing the usage.
`xml``
See the contributing guide to learn how to contribute to the repository and the development workflow.