跳到主内容

向您的移动 Flutter 应用或游戏添加广告

如何使用 google_mobile_ads 包在 Flutter 中展示广告。

许多开发者通过广告来实现移动应用和游戏的商业化。这使得他们的应用可以免费下载,从而提升应用的受欢迎程度。

An illustration of a smartphone showing an ad

若要为您的 Flutter 项目添加广告,请使用 Google 的移动广告平台 AdMob。本指南演示了如何使用 google_mobile_ads 包为您的应用或游戏添加横幅广告。

1. 获取 AdMob 应用 ID

#
  1. 前往 AdMob 并创建一个账户。此过程可能需要一些时间,因为您需要提供银行信息、签署合同等。

  2. 准备好 AdMob 账户后,在 AdMob 中创建两个应用:一个用于 Android,一个用于 iOS。

  3. 打开应用设置部分。

  4. 获取 Android 和 iOS 应用的 AdMob 应用 ID (App IDs)。它们看起来像 ca-app-pub-1234567890123456~1234567890。请注意两个数字之间的波浪号 (~)。

    Screenshot from AdMob showing the location of the App ID

2. 针对特定平台的设置

#

更新您的 Android 和 iOS 配置以包含您的应用 ID。

Android

#

将您的 AdMob 应用 ID 添加到 Android 应用中。

  1. 打开应用的 android/app/src/main/AndroidManifest.xml 文件。

  2. 添加一个新的 <meta-data> 标签。

  3. android:name 元素的值设置为 com.google.android.gms.ads.APPLICATION_ID

  4. android:value 元素的值设置为您在上一步中获得的 AdMob 应用 ID。如下所示将其包含在引号中

    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>
    

iOS

#

将您的 AdMob 应用 ID 添加到 iOS 应用中。

  1. 打开应用的 ios/Runner/Info.plist 文件。

  2. 使用 key 标签包含 GADApplicationIdentifier

  3. 使用 string 标签包含您的 AdMob 应用 ID。您已在 第 1 步中创建了此 AdMob 应用 ID。

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

3. 添加 google_mobile_ads 插件

#

要将 google_mobile_ads 插件添加为依赖项,请运行 flutter pub add

flutter pub add google_mobile_ads

4. 初始化移动广告 SDK

#

在加载广告之前,您需要初始化移动广告 SDK。

  1. 调用 MobileAds.instance.initialize() 来初始化移动广告 SDK。

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

在启动时运行初始化步骤(如上所示),以便 AdMob SDK 在需要之前有足够的时间进行初始化。

5. 加载横幅广告

#

要展示广告,您需要向 AdMob 发出请求。

要加载横幅广告,请构建一个 BannerAd 实例,并对其调用 load()

dart
/// 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();
}

要查看完整示例,请查看本指南的最后一步。

6. 展示横幅广告

#

一旦拥有了已加载的 BannerAd 实例,请使用 AdWidget 来展示它。

dart
AdWidget(ad: _bannerAd)

最好将此组件包装在 SafeArea(确保广告不会被设备的刘海屏遮挡)和 SizedBox(确保在加载前后它具有指定的固定尺寸)中。

dart
@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.
          ? const SizedBox()
          // The actual ad.
          : AdWidget(ad: _bannerAd!),
    ),
  );
}

当您不再需要访问广告时,必须将其销毁。调用 dispose() 的最佳实践是在 AdWidget 从组件树中移除后,或者在 BannerAdListener.onAdFailedToLoad() 回调中进行。

dart
_bannerAd?.dispose();

7. 配置广告

#

要展示测试广告之外的广告,您必须注册广告单元。

  1. 打开 AdMob

  2. 为每个 AdMob 应用创建一个广告单元 (Ad unit)

    Screenshot of the location of Ad Units in AdMob web UI

    系统会询问广告单元的格式。除了横幅广告外,AdMob 还提供许多其他格式——插页式广告、激励广告、开屏广告等。它们的 API 类似,并在 AdMob 文档官方示例中进行了说明。

  3. 选择横幅广告。

  4. 获取 Android 和 iOS 应用的广告单元 ID (Ad unit IDs)。您可以在广告单元部分找到它们。它们看起来像 ca-app-pub-1234567890123456/1234567890。格式与应用 ID相似,但在两个数字之间有一个斜杠 (/)。这可以区分广告单元 ID应用 ID

    Screenshot of an Ad Unit ID in AdMob web UI

  5. 根据目标应用平台,将这些广告单元 ID添加到 BannerAd 的构造函数中。

    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';
    

8. 最终润色

#

要在已发布的应用或游戏中展示广告(与调试或测试场景相对),您的应用必须满足额外的要求。

  1. 您的应用必须经过审核并获准后才能完全展示广告。请遵循 AdMob 的应用就绪指南。例如,您的应用必须至少在受支持的商店之一(如 Google Play 商店或 Apple App Store)上架。

  2. 您必须创建一个 app-ads.txt 文件并将其发布在您的开发者网站上。

An illustration of a smartphone showing an ad

要了解有关应用和游戏商业化的更多信息,请访问 AdMobAd Manager 的官方网站。

9. 完整示例

#

以下代码实现了一个简单的有状态组件,它加载并展示了一个横幅广告。

dart
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.
            ? const 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();
  }

}