Add ads to your mobile Flutter app or game

Many developers use advertising to monetize their mobile apps and games. This allows their app to be downloaded free of charge, which improves the app's popularity.

To add ads to your Flutter project, use AdMob, Google's mobile advertising platform. This recipe demonstrates how to use the google_mobile_ads package to add a banner ad to your app or game.

1. Go to AdMob and set up an account. This could take some time because you need to provide banking information, sign contracts, and so on.

2. With the AdMob account ready, create two Apps in AdMob: one for Android and one for iOS.

3. Open the App settings section.

4. Get the AdMob App IDs for both the Android app and the iOS app. They resemble ca-app-pub-1234567890123456~1234567890. Note the tilde (~) between the two numbers.

   

Update your Android and iOS configurations to include your App IDs.

Add your AdMob app ID to your Android app.

1. Open the app's android/app/src/main/AndroidManifest.xml file.

2. Add a new <meta-data> tag.

3. Set the android:name element with a value of com.google.android.gms.ads.APPLICATION_ID.

4. Set the android:value element with the value to your own AdMob app ID that you got in the previous step. Include them in quotes as shown:

   xml

   <manifest>
       <application>
           ...
   
           <!-- Sample AdMob app ID: ca-app-pub-3940256099942544~3347511713 -->
           <meta-data
               android:name="com.google.android.gms.ads.APPLICATION_ID"
               android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
       </application>
   </manifest>

Add your AdMob app ID to your iOS app.

1. Open your app's ios/Runner/Info.plist file.

2. Enclose GADApplicationIdentifier with a key tag.

3. Enclose your AdMob app ID with a string tag. You created this AdMob App ID in step 1.

   xml

   <key>GADApplicationIdentifier</key>
   <string>ca-app-pub-################~##########</string>

To add the google_mobile_ads plugin as a dependency, run flutter pub add:

flutter pub add google_mobile_ads

You need to initialize the Mobile Ads SDK before loading ads.

1. Call MobileAds.instance.initialize() to initialize the Mobile Ads SDK.

   dart

   void main() async {
     WidgetsFlutterBinding.ensureInitialized();
     unawaited(MobileAds.instance.initialize());
   
     runApp(MyApp());
   }

Run the initialization step at startup, as shown above, so that the AdMob SDK has enough time to initialize before it is needed.

To show an ad, you need to request it from AdMob.

To load a banner ad, construct a BannerAd instance, and call load() on it.

/// Loads a banner ad.
void _loadAd() {
  final bannerAd = BannerAd(
    size: widget.adSize,
    adUnitId: widget.adUnitId,
    request: const AdRequest(),
    listener: BannerAdListener(
      // Called when an ad is successfully received.
      onAdLoaded: (ad) {
        if (!mounted) {
          ad.dispose();
          return;
        }
        setState(() {
          _bannerAd = ad as BannerAd;
        });
      },
      // Called when an ad request failed.
      onAdFailedToLoad: (ad, error) {
        debugPrint('BannerAd failed to load: $error');
        ad.dispose();
      },
    ),
  );

  // Start loading.
  bannerAd.load();
}

To view a complete example, check out the last step of this recipe.

Once you have a loaded instance of BannerAd, use AdWidget to show it.

AdWidget(ad: _bannerAd)

It's a good idea to wrap the widget in a SafeArea (so that no part of the ad is obstructed by device notches) and a SizedBox (so that it has its specified, constant size before and after loading).

@override
Widget build(BuildContext context) {
  return SafeArea(
    child: SizedBox(
      width: widget.adSize.width.toDouble(),
      height: widget.adSize.height.toDouble(),
      child: _bannerAd == null
          // Nothing to render yet.
          ? SizedBox()
          // The actual ad.
          : AdWidget(ad: _bannerAd!),
    ),
  );
}

You must dispose of an ad when you no longer need to access it. The best practice for when to call dispose() is either after the AdWidget is removed from the widget tree or in the BannerAdListener.onAdFailedToLoad() callback.

_bannerAd?.dispose();

To show anything beyond test ads, you have to register ad units.

1. Open AdMob.

2. Create an Ad unit for each of the AdMob apps.

   

   This asks for the Ad unit's format. AdMob provides many formats beyond banner ads --- interstitials, rewarded ads, app open ads, and so on. The API for those is similar, and documented in the AdMob documentation and through official samples.

3. Choose banner ads.

4. Get the Ad unit IDs for both the Android app and the iOS app. You can find these in the Ad units section. They look something like ca-app-pub-1234567890123456/1234567890. The format resembles the App ID but with a slash (/) between the two numbers. This distinguishes an Ad unit ID from an App ID.

   

5. Add these Ad unit IDs to the constructor of BannerAd, depending on the target app platform.

   dart

   final String adUnitId = Platform.isAndroid
       // Use this ad unit on Android...
       ? 'ca-app-pub-3940256099942544/6300978111'
       // ... or this one on iOS.
       : 'ca-app-pub-3940256099942544/2934735716';

To display the ads in a published app or game (as opposed to debug or testing scenarios), your app must meet additional requirements:

1. Your app must be reviewed and approved before it can fully serve ads. Follow AdMob's app readiness guidelines. For example, your app must be listed on at least one of the supported stores such as Google Play Store or Apple App Store.

2. You must create an app-ads.txt file and publish it on your developer website.

To learn more about app and game monetization, visit the official sites of AdMob and Ad Manager.

The following code implements a simple stateful widget that loads a banner ad and shows it.

import 'dart:io';

import 'package:flutter/widgets.dart';
import 'package:google_mobile_ads/google_mobile_ads.dart';

class MyBannerAdWidget extends StatefulWidget {
  /// The requested size of the banner. Defaults to [AdSize.banner].
  final AdSize adSize;

  /// The AdMob ad unit to show.
  ///
  /// TODO: replace this test ad unit with your own ad unit
  final String adUnitId = Platform.isAndroid
      // Use this ad unit on Android...
      ? 'ca-app-pub-3940256099942544/6300978111'
      // ... or this one on iOS.
      : 'ca-app-pub-3940256099942544/2934735716';

  MyBannerAdWidget({
    super.key,
    this.adSize = AdSize.banner,
  });

  @override
  State<MyBannerAdWidget> createState() => _MyBannerAdWidgetState();
}

class _MyBannerAdWidgetState extends State<MyBannerAdWidget> {
  /// The banner ad to show. This is `null` until the ad is actually loaded.
  BannerAd? _bannerAd;

  @override
  Widget build(BuildContext context) {
    return SafeArea(
      child: SizedBox(
        width: widget.adSize.width.toDouble(),
        height: widget.adSize.height.toDouble(),
        child: _bannerAd == null
            // Nothing to render yet.
            ? SizedBox()
            // The actual ad.
            : AdWidget(ad: _bannerAd!),
      ),
    );
  }

  @override
  void initState() {
    super.initState();
    _loadAd();
  }

  @override
  void dispose() {
    _bannerAd?.dispose();
    super.dispose();
  }

  /// Loads a banner ad.
  void _loadAd() {
    final bannerAd = BannerAd(
      size: widget.adSize,
      adUnitId: widget.adUnitId,
      request: const AdRequest(),
      listener: BannerAdListener(
        // Called when an ad is successfully received.
        onAdLoaded: (ad) {
          if (!mounted) {
            ad.dispose();
            return;
          }
          setState(() {
            _bannerAd = ad as BannerAd;
          });
        },
        // Called when an ad request failed.
        onAdFailedToLoad: (ad, error) {
          debugPrint('BannerAd failed to load: $error');
          ad.dispose();
        },
      ),
    );

    // Start loading.
    bannerAd.load();
  }
}

Unless stated otherwise, the documentation on this site reflects the latest stable version of Flutter. Page last updated on 2024-06-24. View source or report an issue.