このページは Cloud Translation API によって翻訳されました。

Dart のネイティブテンプレート

ネイティブテンプレートは、ネイティブ広告をコードとして完成させるビューで、実装と変更を簡単に行えるよう設計されています。ネイティブテンプレートを使うと、Android と iOS 向けのビルド済みレイアウトが提供され、Dart API を使用してネイティブアセットのスタイルをカスタマイズできます。

このガイドでは、Dart API を使用して、基盤となるプラットフォームビューのスタイルを設定し、広告をレンダリングする方法を説明します。

前提条件

Flutter 2.4.0 以降。

スタートガイドの手順を完了していること。
ネイティブ広告のオプションについて理解を深めます。

テストは必ずテスト広告で行う

アプリの作成とテストでは必ずテスト広告を使用し、配信中の実際の広告は使用しないでください。ネイティブ広告向けのテスト専用広告ユニット ID を使用すると、テスト広告を簡単に読み込むことができます。

/6499/example/native

テスト広告ユニットは、リクエストごとにテスト広告を返すように設定されているため、コーディング、テスト、デバッグの際にアプリで使用できます。アプリを公開する前に、必ず独自の広告ユニット ID に置き換えてください。

広告を読み込む

次の例では、medium サイズのネイティブテンプレートを使用してネイティブ広告を読み込んでいます。

class NativeExampleState extends State<NativeExample> {
  NativeAd? nativeAd;
  bool _nativeAdIsLoaded = false;

 // TODO: replace this test ad unit with your own ad unit.
 final _adUnitId = '/6499/example/native';

  /// Loads a native ad.
  void loadAd() {
    _nativeAd = NativeAd(
        adUnitId: _adUnitId,
        listener: NativeAdListener(
          onAdLoaded: (ad) {
            debugPrint('$NativeAd loaded.');
            setState(() {
              _nativeAdIsLoaded = true;
            });
          },
          onAdFailedToLoad: (ad, error) {
            // Dispose the ad here to free resources.
            debugPrint('$NativeAd failed to load: $error');
            ad.dispose();
          },
        ),
        request: const AdManagerAdRequest(),
        // Styling
        nativeTemplateStyle: NativeTemplateStyle(
            // Required: Choose a template.
            templateType: TemplateType.medium,
            // Optional: Customize the ad's style.
            mainBackgroundColor: Colors.purple,
            cornerRadius: 10.0,
            callToActionTextStyle: NativeTemplateTextStyle(
                textColor: Colors.cyan,
                backgroundColor: Colors.red,
                style: NativeTemplateFontStyle.monospace,
                size: 16.0),
            primaryTextStyle: NativeTemplateTextStyle(
                textColor: Colors.red,
                backgroundColor: Colors.cyan,
                style: NativeTemplateFontStyle.italic,
                size: 16.0),
            secondaryTextStyle: NativeTemplateTextStyle(
                textColor: Colors.green,
                backgroundColor: Colors.black,
                style: NativeTemplateFontStyle.bold,
                size: 16.0),
            tertiaryTextStyle: NativeTemplateTextStyle(
                textColor: Colors.brown,
                backgroundColor: Colors.amber,
                style: NativeTemplateFontStyle.normal,
                size: 16.0)))
      ..load();
  }
}

利用可能なスタイルのオプションについては、NativeTemplateStyle と NativeTemplateTextStyle をご覧ください。

広告をカスタマイズ

ネイティブテンプレートを使用してネイティブ広告をカスタマイズする場合、広告の UI 設定が NativeTemplateStyle クラスで反映されるため、Dart コードでネイティブ広告全体のスタイルを設定できます。

テンプレートのサイズ

Flutter ネイティブ広告テンプレートには、TemplateType.small と TemplateType.medium の 2 種類があります。小型のテンプレートは、TableView や GridView のインフィード広告や、薄い長方形の広告ビューが必要な場所に最適です。中サイズのテンプレートはページビューが 2 分の 3 から 4 分の 3 に相当し、ランディングページやスプラッシュページに適しています。

小
Android	iOS
中
Android	iOS

ネイティブ広告イベント

ネイティブ広告のインタラクションに関するイベントの通知を受けるには、広告の listener プロパティを使用します。次に、NativeAdListener を実装して、広告イベントコールバックを受け取ります。

class NativeExampleState extends State<NativeExample> {
  NativeAd? _nativeAd;
  bool _nativeAdIsLoaded = false;

 // TODO: replace this test ad unit with your own ad unit.
 final _adUnitId = '/6499/example/native';

  /// Loads a native ad.
  void loadAd() {
    _nativeAd = NativeAd(
        adUnitId: _adUnitId,
        listener: NativeAdListener(
          onAdLoaded: (ad) {
            print('$NativeAd loaded.');
            setState(() {
              _nativeAdIsLoaded = true;
            });
          },
          onAdFailedToLoad: (ad, error) {
            // Dispose the ad here to free resources.
            print('$NativeAd failedToLoad: $error');
            ad.dispose();
          },
          // Called when a click is recorded for a NativeAd.
          onAdClicked: (ad) {},
          // Called when an impression occurs on the ad.
          onAdImpression: (ad) {},
          // Called when an ad removes an overlay that covers the screen.
          onAdClosed: (ad) {},
          // Called when an ad opens an overlay that covers the screen.
          onAdOpened: (ad) {},
          // For iOS only. Called before dismissing a full screen view
          onAdWillDismissScreen: (ad) {},
          // Called when an ad receives revenue value.
          onPaidEvent: (ad, valueMicros, precision, currencyCode) {},
        ),
        request: const AdManagerAdRequest(),
        // Styling
        nativeTemplateStyle: NativeTemplateStyle(
            // Required: Choose a template.
            templateType: TemplateType.medium,
            // Optional: Customize the ad's style.
            mainBackgroundColor: Colors.purple,
            cornerRadius: 10.0,
            callToActionTextStyle: NativeTemplateTextStyle(
                textColor: Colors.cyan,
                backgroundColor: Colors.red,
                style: NativeTemplateFontStyle.monospace,
                size: 16.0),
            primaryTextStyle: NativeTemplateTextStyle(
                textColor: Colors.red,
                backgroundColor: Colors.cyan,
                style: NativeTemplateFontStyle.italic,
                size: 16.0),
            secondaryTextStyle: NativeTemplateTextStyle(
                textColor: Colors.green,
                backgroundColor: Colors.black,
                style: NativeTemplateFontStyle.bold,
                size: 16.0),
            tertiaryTextStyle: NativeTemplateTextStyle(
                textColor: Colors.brown,
                backgroundColor: Colors.amber,
                style: NativeTemplateFontStyle.normal,
                size: 16.0)))
      ..load();
  }
}

表示広告

NativeAd をウィジェットとして表示するには、load() を呼び出した後に、サポートされている広告を含む AdWidget をインスタンス化する必要があります。ウィジェットは load() を呼び出す前に作成できますが、ウィジェットツリーに追加する前に load() を呼び出す必要があります。

AdWidget は Flutter の Widget クラスを継承し、他のウィジェットと同様に使用できます。iOS では、指定した幅と高さのコンテナにウィジェットを配置します。準拠していない場合、広告が表示されない可能性があります。

// Small template
final adContainer = ConstrainedBox(
  constraints: const BoxConstraints(
    minWidth: 320, // minimum recommended width
    minHeight: 90, // minimum recommended height
    maxWidth: 400,
    maxHeight: 200,
  ),
  child: AdWidget(ad: _nativeAd!),
);

// Medium template
final adContainer = ConstrainedBox(
  constraints: const BoxConstraints(
    minWidth: 320, // minimum recommended width
    minHeight: 320, // minimum recommended height
    maxWidth: 400,
    maxHeight: 400,
  ),
  child: AdWidget(ad: _nativeAd!),
);

広告を破棄

NativeAd は、そのアクセスが不要になったら破棄する必要があります。dispose() を呼び出すタイミングに関するおすすめの方法は、ネイティブ広告に関連付けられた AdWidget をウィジェットツリーと AdListener.onAdFailedToLoad() コールバックで削除した後です。

Dart のネイティブ テンプレート