> ## Documentation Index > Fetch the complete documentation index at: https://docs.adrop.io/llms.txt > Use this file to discover all available pages before exploring further. # Getting Started > A guide to integrating Adrop SDK into your Flutter app. ## Overview Adrop Flutter SDK allows you to easily integrate various ad formats into your Flutter app. ### Supported Ad Formats | Format | Description | | --------------- | ---------------------------------------------------- | | Banner Ad | Rectangular ads displayed in a portion of the screen | | Native Ad | Ads that naturally blend with your app content | | Interstitial Ad | Full-screen ads | | Rewarded Ad | Full-screen ads that provide rewards | | Popup Ad | Ads displayed in popup format | | Splash Ad | Ads displayed with your logo when the app starts | *** ## Requirements ### Flutter * Flutter SDK **3.3.0** or higher * Dart SDK **2.18.0** or higher ### Android * API level **23** (Android 6.0) or higher * `compileSdkVersion` **34** * Kotlin **2.1.0** or higher * Gradle **8.7** or higher * Using Jetpack (AndroidX) ### iOS * iOS **13.0** or higher * Swift **5.0** or higher *** ## Installation ### 1. Install Package Run the following command in your project directory. ```bash theme={null} flutter pub add adrop_ads_flutter ``` ### 2. Android Setup Add the backfill ad repository to `android/settings.gradle.kts`. ```kotlin android/settings.gradle.kts theme={null} dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { google() mavenCentral() maven { url = uri("https://artifact.bytedance.com/repository/pangle") } } } ``` Add the backfill dependency to `android/app/build.gradle`. ```gradle android/app/build.gradle theme={null} dependencies { implementation 'io.adrop:adrop-ads-backfill:1.11.2' } ``` Add the backfill App ID to `android/app/src/main/AndroidManifest.xml`. ```xml android/app/src/main/AndroidManifest.xml theme={null}

``` Please contact Adrop to get your App ID. ### 3. iOS Setup Modify `ios/Podfile`. ```ruby ios/Podfile theme={null} use_frameworks! target 'Runner' do # Other dependencies... # Backfill ad SDK pod 'adrop-ads-backfill' end ``` Install pods. ```bash theme={null} cd ios && pod install --repo-update && cd .. ``` ### 4. Info.plist Configuration Add the following settings to `ios/Runner/Info.plist` for backfill ads. * **GADApplicationIdentifier**: App ID for backfill ads * **SKAdNetworkItems**: Required for ad conversion tracking on iOS 14+ ```xml Info.plist theme={null} GADApplicationIdentifier ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy SKAdNetworkItems SKAdNetworkIdentifier cstr6suwn9.skadnetwork SKAdNetworkIdentifier 4fzdc2evr5.skadnetwork SKAdNetworkIdentifier 4pfyvq9l8r.skadnetwork SKAdNetworkIdentifier 2fnua5tdw4.skadnetwork SKAdNetworkIdentifier ydx93a7ass.skadnetwork SKAdNetworkIdentifier 5a6flpkh64.skadnetwork SKAdNetworkIdentifier p78axxw29g.skadnetwork SKAdNetworkIdentifier v72qych5uu.skadnetwork SKAdNetworkIdentifier ludvb6z3bs.skadnetwork SKAdNetworkIdentifier cp8zw746q7.skadnetwork SKAdNetworkIdentifier v9wttpbfk9.skadnetwork SKAdNetworkIdentifier lr83yxwka7.skadnetwork SKAdNetworkIdentifier 578prtvx9j.skadnetwork SKAdNetworkIdentifier 7ug5zh24hu.skadnetwork SKAdNetworkIdentifier wg4vff78zm.skadnetwork SKAdNetworkIdentifier mj797d8u6f.skadnetwork SKAdNetworkIdentifier 8s468mfl3y.skadnetwork SKAdNetworkIdentifier 4dzt52r2t5.skadnetwork SKAdNetworkIdentifier vhf287vqwu.skadnetwork SKAdNetworkIdentifier c6k4g5qg8m.skadnetwork SKAdNetworkIdentifier 5tjdwbrq8w.skadnetwork SKAdNetworkIdentifier 294l99pt4k.skadnetwork SKAdNetworkIdentifier mqn7fxpca7.skadnetwork SKAdNetworkIdentifier g6gcrrvk4p.skadnetwork SKAdNetworkIdentifier tl55sbb4fm.skadnetwork SKAdNetworkIdentifier s39g8k73mm.skadnetwork SKAdNetworkIdentifier a2p9lx4jpn.skadnetwork SKAdNetworkIdentifier k6y4y55b64.skadnetwork SKAdNetworkIdentifier 488r3q3dtq.skadnetwork SKAdNetworkIdentifier 9rd848q2bz.skadnetwork SKAdNetworkIdentifier glqzh8vgby.skadnetwork SKAdNetworkIdentifier 5lm9lj6jb7.skadnetwork SKAdNetworkIdentifier 97r2b46745.skadnetwork SKAdNetworkIdentifier zmvfpc5aq8.skadnetwork SKAdNetworkIdentifier 3sh42y64q3.skadnetwork SKAdNetworkIdentifier mlmmfzh3r3.skadnetwork SKAdNetworkIdentifier 3rd42ekr43.skadnetwork SKAdNetworkIdentifier 2u9pt9hc89.skadnetwork SKAdNetworkIdentifier m8dbw4sv7c.skadnetwork SKAdNetworkIdentifier 238da6jt44.skadnetwork SKAdNetworkIdentifier 4468km3ulz.skadnetwork SKAdNetworkIdentifier 4w7y6s5ca2.skadnetwork SKAdNetworkIdentifier a8cz6cu7e5.skadnetwork SKAdNetworkIdentifier 77y3x8wds4.skadnetwork SKAdNetworkIdentifier n9x2a789qt.skadnetwork SKAdNetworkIdentifier hs6bdukanm.skadnetwork SKAdNetworkIdentifier f7s53z58qe.skadnetwork SKAdNetworkIdentifier 9t245vhmpl.skadnetwork SKAdNetworkIdentifier mp6xlyr22a.skadnetwork SKAdNetworkIdentifier prcb7njmu6.skadnetwork SKAdNetworkIdentifier kbd757ywx3.skadnetwork SKAdNetworkIdentifier k674qkevps.skadnetwork SKAdNetworkIdentifier t38b2kh725.skadnetwork SKAdNetworkIdentifier feyaarzu9v.skadnetwork SKAdNetworkIdentifier 5f5u5tfb26.skadnetwork SKAdNetworkIdentifier 424m5254lk.skadnetwork SKAdNetworkIdentifier e5fvkxwrpn.skadnetwork SKAdNetworkIdentifier 3qy4746246.skadnetwork SKAdNetworkIdentifier klf5c3l5u5.skadnetwork SKAdNetworkIdentifier zq492l623r.skadnetwork SKAdNetworkIdentifier 22mmun2rn5.skadnetwork SKAdNetworkIdentifier av6w8kgt66.skadnetwork SKAdNetworkIdentifier v79kvwwj4g.skadnetwork SKAdNetworkIdentifier 44jx6755aq.skadnetwork SKAdNetworkIdentifier 32z4fx6l9h.skadnetwork SKAdNetworkIdentifier w9q455wk68.skadnetwork SKAdNetworkIdentifier xga6mpmplv.skadnetwork SKAdNetworkIdentifier f38h382jlk.skadnetwork SKAdNetworkIdentifier yclnxrl5pm.skadnetwork SKAdNetworkIdentifier x44k69ngh6.skadnetwork SKAdNetworkIdentifier ppxm28t8ap.skadnetwork SKAdNetworkIdentifier f73kdq92p3.skadnetwork SKAdNetworkIdentifier 5l3tpt7t6e.skadnetwork SKAdNetworkIdentifier wzmmz9fp6w.skadnetwork SKAdNetworkIdentifier pwa73g5rt2.skadnetwork SKAdNetworkIdentifier 9nlqeag3gk.skadnetwork SKAdNetworkIdentifier 6yxyv74ff7.skadnetwork SKAdNetworkIdentifier uw77j35x4d.skadnetwork SKAdNetworkIdentifier 54nzkqm89y.skadnetwork SKAdNetworkIdentifier 44n7hlldy6.skadnetwork SKAdNetworkIdentifier 6964rsfnh4.skadnetwork SKAdNetworkIdentifier 6g9af3uyq4.skadnetwork SKAdNetworkIdentifier 6v7lgmsu45.skadnetwork SKAdNetworkIdentifier 7fmhfwg9en.skadnetwork SKAdNetworkIdentifier a7xqa6mtl2.skadnetwork SKAdNetworkIdentifier 84993kbrcf.skadnetwork SKAdNetworkIdentifier bxvub5ada5.skadnetwork SKAdNetworkIdentifier 79pbpufp6p.skadnetwork SKAdNetworkIdentifier 9vvzujtq5s.skadnetwork SKAdNetworkIdentifier 7rz58n8ntl.skadnetwork SKAdNetworkIdentifier 3qcr597p9d.skadnetwork SKAdNetworkIdentifier 737z793b9f.skadnetwork SKAdNetworkIdentifier 89z7zv988g.skadnetwork SKAdNetworkIdentifier c3frkrj4fj.skadnetwork SKAdNetworkIdentifier 275upjj5gd.skadnetwork SKAdNetworkIdentifier 3l6bd9hu43.skadnetwork SKAdNetworkIdentifier 52fl2v3hgk.skadnetwork SKAdNetworkIdentifier 6p4ks3rnbw.skadnetwork SKAdNetworkIdentifier apzhy3va96.skadnetwork SKAdNetworkIdentifier 9b89h5y424.skadnetwork SKAdNetworkIdentifier 523jb4fst2.skadnetwork SKAdNetworkIdentifier b9bk5wbcq9.skadnetwork SKAdNetworkIdentifier cg4yq2srnc.skadnetwork SKAdNetworkIdentifier cj5566h2ga.skadnetwork SKAdNetworkIdentifier 24zw6aqk47.skadnetwork SKAdNetworkIdentifier 74b6s63p6l.skadnetwork SKAdNetworkIdentifier 8m87ys6875.skadnetwork SKAdNetworkIdentifier 24t9a8vw3c.skadnetwork SKAdNetworkIdentifier 6xzpu9s2p8.skadnetwork SKAdNetworkIdentifier cs644xg564.skadnetwork SKAdNetworkIdentifier dbu4b84rxf.skadnetwork SKAdNetworkIdentifier ejvt5qm6ak.skadnetwork SKAdNetworkIdentifier mtkv5xtk9e.skadnetwork SKAdNetworkIdentifier kbmxgpxpgc.skadnetwork SKAdNetworkIdentifier hb56zgv37p.skadnetwork SKAdNetworkIdentifier pwdxu55a5a.skadnetwork SKAdNetworkIdentifier r45fhb6rf7.skadnetwork SKAdNetworkIdentifier t6d3zquu66.skadnetwork SKAdNetworkIdentifier u679fj5vs4.skadnetwork SKAdNetworkIdentifier dzg6xy7pwj.skadnetwork SKAdNetworkIdentifier g28c52eehv.skadnetwork SKAdNetworkIdentifier mls7yz5dvl.skadnetwork SKAdNetworkIdentifier vcra2ehyfk.skadnetwork SKAdNetworkIdentifier rx5hdcabgc.skadnetwork SKAdNetworkIdentifier qwpu75vrh2.skadnetwork SKAdNetworkIdentifier rvh3l7un93.skadnetwork SKAdNetworkIdentifier x5l83yy675.skadnetwork SKAdNetworkIdentifier m5mvw97r93.skadnetwork SKAdNetworkIdentifier xy9t38ct57.skadnetwork SKAdNetworkIdentifier g2y4y55b64.skadnetwork SKAdNetworkIdentifier gta9lk7p23.skadnetwork SKAdNetworkIdentifier n6fk4nfna4.skadnetwork SKAdNetworkIdentifier qu637u8glc.skadnetwork SKAdNetworkIdentifier y5ghdn5j9k.skadnetwork SKAdNetworkIdentifier y45688jllp.skadnetwork SKAdNetworkIdentifier ggvn48r87g.skadnetwork SKAdNetworkIdentifier m297p6643m.skadnetwork SKAdNetworkIdentifier qqp299437r.skadnetwork SKAdNetworkIdentifier hdw39hrw9y.skadnetwork SKAdNetworkIdentifier krvm3zuq6h.skadnetwork SKAdNetworkIdentifier cwn433xbcr.skadnetwork SKAdNetworkIdentifier ns5j362hk7.skadnetwork SKAdNetworkIdentifier su67r6k2v3.skadnetwork SKAdNetworkIdentifier z959bm4gru.skadnetwork SKAdNetworkIdentifier x8uqf25wch.skadnetwork SKAdNetworkIdentifier n38lu8286q.skadnetwork SKAdNetworkIdentifier fz2k2k5tej.skadnetwork SKAdNetworkIdentifier ecpz2srf59.skadnetwork SKAdNetworkIdentifier bvpn9ufa9b.skadnetwork SKAdNetworkIdentifier 6rd35atwn8.skadnetwork SKAdNetworkIdentifier ln5gz23vtd.skadnetwork SKAdNetworkIdentifier tmhh9296z4.skadnetwork SKAdNetworkIdentifier sczv5946wb.skadnetwork SKAdNetworkIdentifier dkc879ngq3.skadnetwork SKAdNetworkIdentifier 87u5trcl3r.skadnetwork SKAdNetworkIdentifier fq6vru337s.skadnetwork SKAdNetworkIdentifier f2zub97jtl.skadnetwork SKAdNetworkIdentifier thzdn4h5nc.adattributionkit SKAdNetworkIdentifier raa6f494kr.adattributionkit SKAdNetworkIdentifier 6lz2ygh3q6.adattributionkit SKAdNetworkIdentifier m2jqnlggk3.adattributionkit SKAdNetworkIdentifier pg7ctvrt6f.adattributionkit SKAdNetworkIdentifier 77y3x8wds4.adattributionkit SKAdNetworkIdentifier 55644vm79v.skadnetwork SKAdNetworkIdentifier nzq8sh4pbs.skadnetwork SKAdNetworkIdentifier 55y65gfgn7.skadnetwork SKAdNetworkIdentifier 252b5q8x7y.skadnetwork SKAdNetworkIdentifier 47vhws6wlr.skadnetwork SKAdNetworkIdentifier 4mn522wn87.skadnetwork SKAdNetworkIdentifier 577p5t736z.skadnetwork SKAdNetworkIdentifier 7953jerfzd.skadnetwork SKAdNetworkIdentifier 7bxrt786m8.skadnetwork SKAdNetworkIdentifier 7fbxrn65az.skadnetwork SKAdNetworkIdentifier 8c4e2ghe7u.skadnetwork SKAdNetworkIdentifier 8r8llnkz5a.skadnetwork SKAdNetworkIdentifier 9yg77x724h.skadnetwork SKAdNetworkIdentifier ce8ybjwass.skadnetwork SKAdNetworkIdentifier dt3cjx1a9i.skadnetwork SKAdNetworkIdentifier eh6m2bh4zr.skadnetwork SKAdNetworkIdentifier gta8lk7p23.skadnetwork SKAdNetworkIdentifier gvmwg8q7h5.skadnetwork SKAdNetworkIdentifier hjevpa356n.skadnetwork SKAdNetworkIdentifier jk2fsx2rgz.skadnetwork SKAdNetworkIdentifier n66cz3y3bx.skadnetwork SKAdNetworkIdentifier pu4na253f3.skadnetwork SKAdNetworkIdentifier r8lj5b58b5.skadnetwork SKAdNetworkIdentifier s69wq72ugq.skadnetwork SKAdNetworkIdentifier v4nxqhlyqp.skadnetwork SKAdNetworkIdentifier vutu7akeur.skadnetwork SKAdNetworkIdentifier z24wtl6j62.skadnetwork SKAdNetworkIdentifier z4gj7hsk7h.skadnetwork SKAdNetworkIdentifier x8jxxk4ff5.skadnetwork SKAdNetworkIdentifier x8yj322td6.skadnetwork ``` If your Info.plist already contains a `SKAdNetworkItems` key, do not add a new one — merge only the array (``) entries. Duplicate keys cause iOS to use only the first array. Please contact Adrop for the full SKAdNetworkItems list and App ID. ### 5. Add Configuration File #### Android 1. Download the **adrop\_service.json** file from the Ad Control Console. 2. Copy the file to the `android/app/src/main/assets/` directory. ``` android/app/src/main/assets/adrop_service.json ``` #### iOS 1. Download the **adrop\_service.json** file from the Ad Control Console. 2. Add the file to the project root in Xcode. 3. Make sure to add the file to all targets. *** ## Initialization Initialize the SDK at app startup. Typically called in `main.dart`. ```dart main.dart theme={null} import 'package:adrop_ads_flutter/adrop_ads_flutter.dart'; void main() { runApp(const MyApp()); } class MyApp extends StatefulWidget { const MyApp({super.key}); @override State createState() => _MyAppState(); } class _MyAppState extends State { @override void initState() { super.initState(); _initializeAdrop(); } Future _initializeAdrop() async { // false: test mode, true: production mode await Adrop.initialize(false); } @override Widget build(BuildContext context) { return MaterialApp( home: HomeScreen(), ); } } ``` ### Initialization Options ```dart theme={null} await Adrop.initialize( production, // bool: production mode flag targetCountries: targetCountries, // List?: target country codes (optional) useInAppBrowser: useInAppBrowser // bool?: iOS in-app browser usage (optional) ); ``` **Parameters** | Parameter | Type | Required | Description | | ----------------- | -------------- | -------- | ------------------------------------------------ | | `production` | `bool` | Y | `true`: production mode, `false`: test mode | | `targetCountries` | `List` | N | Country codes to show ads (e.g., `['KR', 'US']`) | | `useInAppBrowser` | `bool` | N | iOS in-app browser usage (default: `false`) | **Examples** ```dart theme={null} // Basic initialization (test mode) await Adrop.initialize(false); // Production mode + specific country targeting await Adrop.initialize(true, targetCountries: ['KR', 'JP', 'US']); // Production mode + iOS in-app browser await Adrop.initialize(true, useInAppBrowser: true); ``` *** ## Theme Settings Set the ad UI theme. ```dart theme={null} import 'package:adrop_ads_flutter/adrop_ads_flutter.dart'; // Set theme await Adrop.setTheme(AdropTheme.auto); // Follow system settings await Adrop.setTheme(AdropTheme.light); // Light mode await Adrop.setTheme(AdropTheme.dark); // Dark mode ``` | Theme | Description | | ------------------ | ----------------------------------------------- | | `AdropTheme.auto` | Automatically switches based on system settings | | `AdropTheme.light` | Light mode | | `AdropTheme.dark` | Dark mode | *** ## Set User Identifier Set a user identifier (UID) for targeted advertising. ```dart theme={null} import 'package:adrop_ads_flutter/adrop_ads_flutter.dart'; // After user login await Adrop.setUID('user_123'); // On logout await Adrop.setUID(''); ``` UID is hashed with SHA-256 before transmission. Do not pass personally identifiable information such as email or phone number directly. *** ## Test Unit IDs Use the following test unit IDs during development and testing. | Format | Test Unit ID | | ---------------- | ---------------------------------- | | Banner (320x50) | `PUBLIC_TEST_UNIT_ID_320_50` | | Banner (320x100) | `PUBLIC_TEST_UNIT_ID_320_100` | | Native | `PUBLIC_TEST_UNIT_ID_NATIVE` | | Interstitial | `PUBLIC_TEST_UNIT_ID_INTERSTITIAL` | | Rewarded | `PUBLIC_TEST_UNIT_ID_REWARDED` | | Popup (Bottom) | `PUBLIC_TEST_UNIT_ID_POPUP_BOTTOM` | | Popup (Center) | `PUBLIC_TEST_UNIT_ID_POPUP_CENTER` | | Splash | `PUBLIC_TEST_UNIT_ID_SPLASH` | Be sure to replace with actual unit IDs before production deployment. *** ## Error Codes Error codes that can occur in the SDK. | Error Code | Description | | --------------------------- | ---------------------------- | | `network` | Network error | | `internal` | Internal error | | `initialize` | SDK initialization error | | `invalidUnit` | Invalid unit ID | | `notTargetCountry` | Not a target country | | `inactive` | Inactive ad | | `adNoFill` | No ads to display | | `adLoadDuplicate` | Duplicate load request | | `adLoading` | Loading in progress | | `adEmpty` | Empty ad | | `adShown` | Ad already shown | | `adHideForToday` | Hidden for today | | `accountUsageLimitExceeded` | Account usage limit exceeded | | `adLandscapeUnsupported` | Landscape mode not supported | | `backfillNoFill` | No backfill ads | ```dart theme={null} import 'package:adrop_ads_flutter/adrop_ads_flutter.dart'; // Error handling example if (errorCode == AdropErrorCode.adNoFill) { debugPrint('No ads available to display.'); } ``` *** ## Deprecated Class Migration The following classes are deprecated and will be removed in a future version. Please migrate to the new classes. ### AdropBanner → AdropBannerView The `AdropBanner` widget is deprecated. Migrate to `AdropBannerView`. ```dart theme={null} // ❌ Deprecated AdropBanner( unitId: 'YOUR_UNIT_ID', onAdropBannerCreated: (controller) { controller.load(); }, onAdReceived: (banner) { }, ); // ✅ Recommended (AdropBannerView) final bannerView = AdropBannerView( unitId: 'YOUR_UNIT_ID', listener: AdropBannerListener( onAdReceived: (unitId, metadata) { }, onAdFailedToReceive: (unitId, errorCode) { }, ), ); bannerView.load(); ``` ### AdropNavigatorObserver (Deprecated) `AdropNavigatorObserver` is deprecated and will be removed in a future version. This class no longer provides any functionality and can be safely removed from your code. ```dart theme={null} // ❌ Deprecated — can be removed MaterialApp( navigatorObservers: [AdropNavigatorObserver()], ); // ✅ Remove AdropNavigatorObserver MaterialApp( // Remove AdropNavigatorObserver from navigatorObservers ); ``` *** ## Troubleshooting ### iOS Build Errors If you encounter Swift version compatibility issues, add the following to the `post_install` block in `ios/Podfile`. ```ruby ios/Podfile theme={null} post_install do |installer| installer.pods_project.targets.each do |target| target.build_configurations.each do |config| config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES' end end end ``` ### Android Build Errors If the Kotlin version doesn't match, check the Kotlin version in `android/build.gradle`. ```gradle android/build.gradle theme={null} buildscript { ext.kotlin_version = '2.1.0' } ``` *** ## Next Steps Implement banner ads Implement native ads Implement interstitial ads Implement rewarded ads Display web ads in WebView GDPR/CCPA consent management