apsl_ads_flutter 1.2.6

Apsl Ads is a wrapper around famous ad packages which let you integrate ads easily

Apsl Ads Flutter

Easily integrate ads from various ad networks into your Flutter app with Apsl Ads Flutter.

🌟 Please consider giving the package a star on GitHub to support the project.

🚀 Features

• Google Mobile Ads: banner, appOpen, interstitial, rewarded ad, native ad.
• Facebook Audience Network: banner, interstitial, rewarded ad. Native ad is coming soon!
• Unity Ads: banner, interstitial, rewarded ad.
• AppLovin: banner, interstitial, rewarded ad.

📱 AdMob Mediation

• The plugin provides support for AdMob mediation. For more details, refer to the AdMob Mediation Guide.
• Ensure you add the native platform settings for AdMob mediation.

🛠 Platform Specific Setup

iOS

📝 Update your Info.plist

For Google Ads and Applovin, adding specific keys is mandatory. Update your ios/Runner/Info.plist as follows:

<key>AppLovinSdkKey</key>
<string>YOUR_SDK_KEY</string>
<key>GADApplicationIdentifier</key>
<string>YOUR_SDK_KEY</string>

Additionally, add SKAdNetworkItems for all networks provided by Apsl-ads-flutter. You can find and copy the SKAdNetworkItems from the provided info.plist to your project.

Android

📝 Update AndroidManifest.xml

<manifest>
    <application>
        <meta-data android:name="applovin.sdk.key" android:value="YOUR_SDK_KEY"/>
        <meta-data android:name="com.google.android.gms.ads.APPLICATION_ID" android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
    </application>
</manifest>

🧩 Initialize Ad IDs

This is how you can define and manage your ad IDs for different networks:

import 'dart:io';

import 'ads_id_manager.dart';

class TestAdsIdManager extends AdsIdManager {
  const TestAdsIdManager();

  @override
  List<AppAdIds> get appAdIds => [
        AppAdIds(
          adNetwork: 'admob',
          appId: Platform.isAndroid
              ? 'ca-app-pub-3940256099942544~3347511713'
              : 'ca-app-pub-3940256099942544~1458002511',
          appOpenId: Platform.isAndroid
              ? 'ca-app-pub-3940256099942544/3419835294'
              : 'ca-app-pub-3940256099942544/5662855259',
          bannerId: Platform.isAndroid
              ? 'ca-app-pub-3940256099942544/6300978111'
              : 'ca-app-pub-3940256099942544/2934735716',
          interstitialId: Platform.isAndroid
              ? 'ca-app-pub-3940256099942544/1033173712'
              : 'ca-app-pub-3940256099942544/4411468910',
          rewardedId: Platform.isAndroid
              ? 'ca-app-pub-3940256099942544/5224354917'
              : 'ca-app-pub-3940256099942544/1712485313',
          nativeId: Platform.isAndroid
              ? 'ca-app-pub-3940256099942544/2247696110'
              : 'ca-app-pub-3940256099942544/3986624511',
        ),
        AppAdIds(
          adNetwork: 'unity',
          appId: Platform.isAndroid ? '4374881' : '4374880',
          bannerId: Platform.isAndroid ? 'Banner_Android' : 'Banner_iOS',
          interstitialId:
              Platform.isAndroid ? 'Interstitial_Android' : 'Interstitial_iOS',
          rewardedId: Platform.isAndroid ? 'Rewarded_Android' : 'Rewarded_iOS',
        ),
        const AppAdIds(
          adNetwork: 'facebook',
          appId: '1579706379118402',
          interstitialId: 'VID_HD_16_9_15S_LINK#YOUR_PLACEMENT_ID',
          bannerId: 'IMG_16_9_APP_INSTALL#YOUR_PLACEMENT_ID',
          rewardedId: 'VID_HD_16_9_46S_APP_INSTALL#YOUR_PLACEMENT_ID',
        ),
        AppAdIds(
          adNetwork: 'applovin',
          appId: 'YOUR_SDK_KEY',
          bannerId: Platform.isAndroid
              ? 'ANDROID_BANNER_AD_UNIT_ID'
              : 'IOS_BANNER_AD_UNIT_ID',
          interstitialId: Platform.isAndroid
              ? 'ANDROID_INTER_AD_UNIT_ID'
              : 'IOS_INTER_AD_UNIT_ID',
          rewardedId: Platform.isAndroid
              ? 'ANDROID_REWARDED_AD_UNIT_ID'
              : 'IOS_REWARDED_AD_UNIT_ID',
        ),
      ];
}

🚀 SDK Initialization

Before displaying ads, ensure you initialize the Mobile Ads SDK with ApslAds.instance.initialize(). It's a one-time setup, ideally done just before your app starts.

import 'package:apsl_ads_flutter/apsl_ads_flutter.dart';
import 'package:flutter/material.dart';

const IAdIdManager adIdManager = TestAdIdManager();

ApslAds.instance.initialize(
    adIdManager,
    adMobAdRequest: const AdRequest(),
    // Set this to true if you want to restrict ads for applovin (age below 16 years)
    isAgeRestrictedUserForApplovin:true,
    // To enable Facebook Test mode ads
    fbTestMode: true,
    admobConfiguration: RequestConfiguration(testDeviceIds: []),
  );

🎥 Interstitial/Rewarded Ads

🔋 Load an ad

By default, an ad loads after being displayed or when you call initialize for the first time. As a precaution, use the following method to load both rewarded and interstitial ads:

ApslAds.instance.loadAd();

📺 Display Interstitial or Rewarded Ad

ApslAds.instance.showAd(AdUnitType.rewarded);

🎉 Display App Open Ad

ApslAds.instance.showAd(AdUnitType.appOpen)

Show Banner Ads

This is how you may show banner ad in widget-tree somewhere:

@override
Widget build(BuildContext context) {
  Column(
    crossAxisAlignment: CrossAxisAlignment.stretch,
    children: [
      SomeWidget(),
      const Spacer(),
      ApslBannerAd(
          adNetwork: AdNetwork.admob, adSize: AdSize.mediumRectangle),
    ],
  );
}

🌐 Show All Banner Ads Sequentially

The banners will attempt to load ads from the networks in the sequence you specify. If one network fails, it will automatically switch to the next one, ensuring minimal revenue loss.

You can specify the order using the orderOfAdNetworks parameter in the ApslAllBannerAd constructor:

@override
Widget build(BuildContext context) {
  return Scaffold(
    appBar: AppBar(
      title: Text('My App'),
    ),
    body: Column(
      children: [
        // Your other widgets...
        ApslAllBannerAd(
          orderOfAdNetworks: [
            AdNetwork.facebook,
            AdNetwork.admob,
            AdNetwork.unity,
            AdNetwork.applovin,
          ],
          adSize: AdSize.largeBanner,
          // Other parameters...
        ),
        // Your other widgets...
      ],
    ),
  );
}

🔔 Callbacks

To monitor various ad events, use the callback mechanism:

  StreamSubscription? _streamSubscription;

The following code snippet demonstrates the process of displaying an interstitial ad and checking if it has been shown: If true, we are canceling the subscribed callbacks, if any. Then, we are listening to the Stream and accessing the particular event we need

if (ApslAds.instance.showInterstitialAd()) {
  // Canceling the last callback subscribed
  _streamSubscription?.cancel();
  // Listening to the callback from showInterstitialAd()
  _streamSubscription =
  ApslAds.instance.onEvent.listen((event) {
    if (event.adUnitType == AdUnitType.interstitial &&
        event.type == AdEventType.adDismissed) {
      _streamSubscription?.cancel();
      goToNextScreen(countryList[index]);
    }
  });
}