Banner Ads

バナー広告は、デバイス画面の上部か下部にアプリのレイアウト内の一部分を使用して表示されます。アプリの操作中は画面に表示され続けますが、一定時間が経過すると自動的に更新されるよう設定できます。モバイル広告を初めてお使いの場合は、この広告から始めることをおすすめします。

このガイドでは、Ad Manager のバナー広告を iOS アプリに組み込む方法について説明します。コード スニペットと設定方法のほか、バナーの適切なサイズに関する情報および他の関連情報へのリンクも紹介します。

前提条件

常にテスト広告でテストする

アプリの開発とテストでは実際の広告ではなく、必ずテスト広告を使ってください。実際の広告でテストすると、アカウントが停止される場合があります。

テスト広告は、次に示す iOS バナー広告向けのテスト専用広告ユニット ID を使うと簡単に読み込むことができます。 /6499/example/banner

この ID は、すべてのリクエストに対してテスト広告を返すように構成されており、アプリのコーディング、テスト、デバッグで自由に使うことができます。なお、テスト用 ID は、アプリを公開する前に必ずご自身の広告ユニット ID に置き換えてください。

Mobile Ads SDK のテスト広告の仕組みについて詳しくは、テスト広告をご覧ください。

DFPBannerView を作成する

バナー広告は DFPBannerView オブジェクトに表示されるため、バナー広告を組み込むための最初のステップは、ビュー階層に DFPBannerView を含めることです。この手順は、通常インターフェース ビルダーかプログラムで行います。

インターフェース ビルダー

DFPBannerView は、通常のビューと同様にストーリーボードまたは xib ファイルに追加できます。このメソッドを使用する場合は、表示する広告サイズに合わせて幅と高さの制約を追加してください。たとえば、バナー(320×50)を表示する場合は、320 ポイントの幅制約と 50 ポイントの高さ制約を使用します。

プログラムで行う場合

DFPBannerView は、直接インスタンス化することもできます。次の例では、DFPBannerView を作成して、画面のセーフエリアの下中央に合わせて配置し、バナーのサイズを 320×50 に設定します。

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController {

  var bannerView: DFPBannerView!

  override func viewDidLoad() {
    super.viewDidLoad()
    
    // In this case, we instantiate the banner with desired ad size.
    bannerView = DFPBannerView(adSize: kGADAdSizeBanner)

    addBannerViewToView(bannerView)
  }

  func addBannerViewToView(_ bannerView: DFPBannerView) {
    bannerView.translatesAutoresizingMaskIntoConstraints = false
    view.addSubview(bannerView)
    view.addConstraints(
      [NSLayoutConstraint(item: bannerView,
                          attribute: .bottom,
                          relatedBy: .equal,
                          toItem: bottomLayoutGuide,
                          attribute: .top,
                          multiplier: 1,
                          constant: 0),
       NSLayoutConstraint(item: bannerView,
                          attribute: .centerX,
                          relatedBy: .equal,
                          toItem: view,
                          attribute: .centerX,
                          multiplier: 1,
                          constant: 0)
      ])
   }
   
}

Objective-C

@import GoogleMobileAds;

@interface ViewController ()

@property(nonatomic, strong) DFPBannerView *bannerView;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  
  // In this case, we instantiate the banner with desired ad size.
  self.bannerView = [[DFPBannerView alloc]
      initWithAdSize:kGADAdSizeBanner];

  [self addBannerViewToView:self.bannerView];
}

- (void)addBannerViewToView:(UIView *)bannerView {
  bannerView.translatesAutoresizingMaskIntoConstraints = NO;
  [self.view addSubview:bannerView];
  [self.view addConstraints:@[
    [NSLayoutConstraint constraintWithItem:bannerView
                               attribute:NSLayoutAttributeBottom
                               relatedBy:NSLayoutRelationEqual
                                  toItem:self.bottomLayoutGuide
                               attribute:NSLayoutAttributeTop
                              multiplier:1
                                constant:0],
    [NSLayoutConstraint constraintWithItem:bannerView
                               attribute:NSLayoutAttributeCenterX
                               relatedBy:NSLayoutRelationEqual
                                  toItem:self.view
                               attribute:NSLayoutAttributeCenterX
                              multiplier:1
                                constant:0]
                                ]];
}
  

@end

この場合、提供される広告サイズによりバナーのコンテンツ サイズが決まるため、幅や高さの制約は与えません。

定数で定義された標準サイズを使用しない場合は、GADAdSizeFromCGSize を使用してカスタムサイズを設定できます。詳しくは、バナーサイズのセクションをご覧ください。

DFPBannerView プロパティを設定する

広告を読み込んで表示するには、DFPBannerView にいくつかのプロパティを設定する必要があります。

  • rootViewController - このビュー コントローラは、広告のクリック時に、オーバーレイの表示に使用されます。通常は、DFPBannerView を含むビュー コントローラに設定されます。
  • adUnitID - DFPBannerView が広告を読み込む広告ユニットの ID です。

UIViewController の viewDidLoad メソッドで 2 つの必須プロパティを設定するコードサンプルを次に示します。

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  ...

  bannerView.adUnitID = "/6499/example/banner"
  bannerView.rootViewController = self
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];
  ...

  self.bannerView.adUnitID = @"/6499/example/banner";
  self.bannerView.rootViewController = self;
}

広告を読み込む

DFPBannerView を配置してそのプロパティを設定したら、次のステップとして広告を読み込みます。これは DFPRequest オブジェクトの loadRequest: を で呼び出すことで行います。

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  ...

  bannerView.adUnitID = "/6499/example/banner"
  bannerView.rootViewController = self
  bannerView.load(DFPRequest())
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];
  ...

  self.bannerView.adUnitID = @"/6499/example/banner";
  self.bannerView.rootViewController = self;
  [self.bannerView loadRequest:[DFPRequest request]];
}

DFPRequest オブジェクトは単一の広告リクエストを表し、ターゲティング情報などのプロパティを含みます。

広告イベント

広告が閉じられたときや、ユーザーがアプリから離れたときなどのライフサイクル イベントは、GADBannerViewDelegate を使用してリッスンできます。

バナー広告イベントを登録する

バナー広告イベントを登録するには、GADBannerViewDelegate プロトコルを実装しているオブジェクトに、DFPBannerViewdelegate プロパティを設定します。通常は、バナー広告を実装するクラスがデリゲート クラスとしての役割も果たすため、delegate プロパティを self に設定できます。

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController, GADBannerViewDelegate {

  var bannerView: DFPBannerView!

  override func viewDidLoad() {
    super.viewDidLoad()
    ...
    bannerView.delegate = self
  }
}

Objective-C

@import GoogleMobileAds;

@interface ViewController () <GADBannerViewDelegate>

@property(nonatomic, strong) DFPBannerView *bannerView;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  ...
  self.bannerView.delegate = self;
}

バナー広告イベントを実装する

GADBannerViewDelegate の各メソッドはオプションのため、必要なメソッドを実装すれば問題ありません。各メソッドを実装してメッセージのログをコンソールに記録する場合のサンプルを、次に示します。

Swift

/// Tells the delegate an ad request loaded an ad.
func adViewDidReceiveAd(_ bannerView: GADBannerView) {
  print("adViewDidReceiveAd")
}

/// Tells the delegate an ad request failed.
func adView(_ bannerView: GADBannerView,
    didFailToReceiveAdWithError error: GADRequestError) {
  print("adView:didFailToReceiveAdWithError: \(error.localizedDescription)")
}

/// Tells the delegate that a full-screen view will be presented in response
/// to the user clicking on an ad.
func adViewWillPresentScreen(_ bannerView: GADBannerView) {
  print("adViewWillPresentScreen")
}

/// Tells the delegate that the full-screen view will be dismissed.
func adViewWillDismissScreen(_ bannerView: GADBannerView) {
  print("adViewWillDismissScreen")
}

/// Tells the delegate that the full-screen view has been dismissed.
func adViewDidDismissScreen(_ bannerView: GADBannerView) {
  print("adViewDidDismissScreen")
}

/// Tells the delegate that a user click will open another app (such as
/// the App Store), backgrounding the current app.
func adViewWillLeaveApplication(_ bannerView: GADBannerView) {
  print("adViewWillLeaveApplication")
}

Objective-C

/// Tells the delegate an ad request loaded an ad.
- (void)adViewDidReceiveAd:(DFPBannerView *)adView {
  NSLog(@"adViewDidReceiveAd");
}

/// Tells the delegate an ad request failed.
- (void)adView:(DFPBannerView *)adView
    didFailToReceiveAdWithError:(GADRequestError *)error {
  NSLog(@"adView:didFailToReceiveAdWithError: %@", [error localizedDescription]);
}

/// Tells the delegate that a full-screen view will be presented in response
/// to the user clicking on an ad.
- (void)adViewWillPresentScreen:(DFPBannerView *)adView {
  NSLog(@"adViewWillPresentScreen");
}

/// Tells the delegate that the full-screen view will be dismissed.
- (void)adViewWillDismissScreen:(DFPBannerView *)adView {
  NSLog(@"adViewWillDismissScreen");
}

/// Tells the delegate that the full-screen view has been dismissed.
- (void)adViewDidDismissScreen:(DFPBannerView *)adView {
  NSLog(@"adViewDidDismissScreen");
}

/// Tells the delegate that a user click will open another app (such as
/// the App Store), backgrounding the current app.
- (void)adViewWillLeaveApplication:(DFPBannerView *)adView {
  NSLog(@"adViewWillLeaveApplication");
}

iOS API デモアプリでバナー デリゲート メソッドを使用するには、広告デリゲートのサンプルをご覧ください。

Swift Objective-C

ユースケース

これらの広告イベント メソッドの使用に適したケースをいくつか紹介します。

広告を取得してからバナーをビュー階層に追加する

広告が取得されるまで、ビュー階層に DFPBannerView を追加するのを遅らせる場合は、adViewDidReceiveAd: イベントをリッスンします。

Swift

func adViewDidReceiveAd(_ bannerView: GADBannerView) {
  // Add banner to view and add constraints as above.
  addBannerViewToView(bannerView)
}

Objective-C

- (void)adViewDidReceiveAd:(DFPBannerView *)adView {
  // Add adView to view and add constraints as above.
  [self addBannerViewToView:self.bannerView];
}

バナー広告をアニメーション表示する

バナー広告が返されたら、adViewDidReceiveAd: イベントを使用して、バナー広告をアニメーション表示することもできます。次にサンプルを示します。

Swift

func adViewDidReceiveAd(_ bannerView: GADBannerView) {
  bannerView.alpha = 0
  UIView.animate(withDuration: 1, animations: {
    bannerView.alpha = 1
  })
}

Objective-C

- (void)adViewDidReceiveAd:(DFPBannerView *)adView {
  adView.alpha = 0;
  [UIView animateWithDuration:1.0 animations:^{
    adView.alpha = 1;
  }];
}

アプリを一時停止したり再開したりする

GADBannerViewDelegate プロトコルには、クリックによってオーバーレイを表示したり閉じたりする、または外部ブラウザを起動する、などのイベントを通知するメソッドがあります。広告が要因となってこれらのイベントが発生したことを確認するには、GADBannerViewDelegate メソッドを登録します。

全種類のオーバーレイ表示または外部ブラウザの起動を確認するには、広告クリックで呼び出されるメソッドだけでなく、UIViewControllerUIApplication の同等のメソッドをアプリでリッスンすることをおすすめします。以下の表には、GADBannerViewDelegate のメソッドと同じタイミングで呼び出される、iOS の同等のメソッドが示されています。

GADBannerViewDelegate のメソッド iOS のメソッド
adViewWillPresentScreen: UIViewController の viewWillDisappear:
adViewWillDismissScreen: UIViewController の viewWillAppear:
adViewDidDismissScreen: UIViewController の viewDidAppear:
adViewWillLeaveApplication: UIApplicationDelegate の applicationDidEnterBackground:

標準のバナーサイズについては、以下の表をご覧ください。

サイズ(単位はポイント、幅×高さ) 説明 対応デバイス AdSize の定数値
320×50 バナー スマートフォン、タブレット kGADAdSizeBanner
320×100 バナー(大) スマートフォン、タブレット kGADAdSizeLargeBanner
300×250 IAB レクタングル(中) スマートフォン、タブレット kGADAdSizeMediumRectangle
468×60 IAB フルサイズ バナー タブレット kGADAdSizeFullBanner
728×90 IAB ビッグバナー タブレット kGADAdSizeLeaderboard
指定された幅×最適な高さ アダプティブ バナー スマートフォン、タブレット なし
画面の幅×32|50|90 スマートバナー スマートフォン、タブレット kGADAdSizeSmartBannerPortrait
kGADAdSizeSmartBannerLandscape
今後はスマートバナーに代わってアダプティブ バナーが使用される予定です。詳しくは、アダプティブ バナーをご覧ください。

カスタム広告サイズ

カスタムのバナーサイズを定義するには、GADAdSizeFromCGSize を使って希望のサイズを次のように設定します。

Swift

let adSize = GADAdSizeFromCGSize(CGSize(width: 300, height: 50))

Objective-C

GADAdSize size = GADAdSizeFromCGSize(CGSizeMake(300, 50));

カスタムの広告サイズ

Google アド マネージャーでは、標準の広告ユニットのほか、任意のサイズの広告ユニットをアプリ内で配信できます。広告リクエストで定義する広告サイズ(幅、高さ)は、アプリに表示される広告ビュー(DFPBannerView)のサイズと一致している必要があります。カスタムサイズを設定するには、GADAdSizeFromCGSize を使用します。

Swift

// Define custom GADAdSize of 250x250 for DFPBannerView.
let customAdSize = GADAdSizeFromCGSize(CGSize(width: 250, height: 250))
bannerView = DFPBannerView(adSize: customAdSize)

Objective-C

// Define custom GADAdSize of 250x250 for DFPBannerView
GADAdSize customAdSize = GADAdSizeFromCGSize(CGSizeMake(250, 250));
self.bannerView = [[DFPBannerView alloc] initWithAdSize:customAdSize];

iOS API デモアプリでカスタム広告ユニットを実装するには、アド マネージャーによる複数の広告サイズの実装例をご覧ください。

Swift Objective-C

複数の広告サイズ

アド マネージャーでは、DFPBannerView の配信対象となる広告サイズを複数指定できます。この機能を使用するためのステップは、次の 3 つです。

  1. アド マネージャーの管理画面で、広告ユニットを対象とする広告申込情報を作成し、サイズが異なる複数のクリエイティブに関連付けます。

  2. アプリで、validAdSizes プロパティを次のように DFPBannerView に設定します。

    Swift

    // Define an optional array of GADAdSize to specify all valid sizes that are appropriate
    // for this slot. Never create your own GADAdSize directly. Use one of the
    // predefined standard ad sizes (such as kGADAdSizeBanner), or create one using
    // the GADAdSizeFromCGSize method.
    //
    // Note: Ensure that the allocated DFPBannerView is defined with an ad size. Also note
    // that all desired sizes should be included in the validAdSizes array.
    bannerView.validAdSizes = [NSValueFromGADAdSize(kGADAdSizeBanner),
        NSValueFromGADAdSize(kGADAdSizeMediumRectangle),
        NSValueFromGADAdSize(GADAdSizeFromCGSize(CGSize(width: 120, height: 20)))]
    

    Objective-C

    // Define an optional array of GADAdSize to specify all valid sizes that are appropriate
    // for this slot. Never create your own GADAdSize directly. Use one of the
    // predefined standard ad sizes (such as kGADAdSizeBanner), or create one using
    // the GADAdSizeFromCGSize method.
    //
    // Note: Ensure that the allocated DFPBannerView is defined with an ad size. Also note
    // that all desired sizes should be included in the validAdSizes array.
    self.bannerView.validAdSizes = @[
        NSValueFromGADAdSize(kGADAdSizeBanner),
        NSValueFromGADAdSize(kGADAdSizeMediumRectangle),
        NSValueFromGADAdSize(GADAdSizeFromCGSize(CGSizeMake(120, 20)))
    ];
    
  3. 広告サイズの変化を検出するために、GADAdSizeDelegate メソッドを実装します。

    Swift

    public func adView(_ bannerView: GADBannerView, willChangeAdSizeTo size: GADAdSize)
    

    Objective-C

    • (void)adView:(DFPBannerView *)view willChangeAdSizeTo:(GADAdSize)size;
  4. 広告のリクエストの前にデリゲートを設定します。

    Swift

    bannerView.adSizeDelegate = self

    Objective-C

    self.bannerView.adSizeDelegate = self;

iOS API デモアプリでカスタム広告ユニットを実装するには、アド マネージャーによる複数の広告サイズの実装例をご覧ください。

Swift Objective-C

インプレッションの手動カウント

インプレッションを記録するタイミングについて特別な条件がある場合は、インプレッションの信号をアド マネージャーに手動で送信できます。それには、広告を読み込む前に、DFPBannerView で手動インプレッションを有効にします。

Swift

bannerView.enableManualImpressions = true

Objective-C

self.bannerView.enableManualImpressions = YES;

広告が正常に返され、画面に表示されていることを確認したら、インプレッションを手動でカウントします。

Swift

bannerView.recordImpression()

Objective-C

[self.bannerView recordImpression];

アプリ内イベント

アプリ内イベントを利用することで、アプリのコードにメッセージを送信する広告を作成できます。アプリは、送信されたメッセージに基づいて処理を行います。

アド マネージャー専用のアプリ内イベントをリッスンするには、GADAppEventDelegate を使用します。アド マネージャーのアプリ内イベントは、広告ライフサイクルのあらゆるタイミングで(GADBannerViewDelegate オブジェクトの adViewDidReceiveAd: が呼び出される前でも)発生する可能性があります。

Swift

// Implement your app event within this method. The delegate will be
// notified when the SDK receives an app event message from the ad.

// Called when the banner receives an app event.
optional public func adView(_ banner: GADBannerView,
    didReceiveAppEvent name: String, withInfo info: String?)

Objective-C

// Implement your app event within this method. The delegate will be
// notified when the SDK receives an app event message from the ad.

@optional
// Called when the banner receives an app event.
- (void)adView:(DFPBannerView *)banner
    didReceiveAppEvent:(NSString *)name
              withInfo:(NSString *)info;

アプリ内イベントに対するメソッドは、ビュー コントローラ内に実装します。

Swift

import GoogleMobileAds

class ViewController: UIViewController, GADAppEventDelegate {
}

Objective-C

@import GoogleMobileAds;

@interface ViewController : UIViewController <GADAppEventDelegate> {
}

@end

広告のリクエストを行う前に、appEventDelegate プロパティを使用してデリゲートを設定します。

Swift

bannerView.appEventDelegate = self

Objective-C

self.bannerView.appEventDelegate = self;

アプリ内イベントに応じてアプリの背景色が指定した色に変わるようにする方法は次のとおりです。

Swift

func adView(_ banner: GADBannerView, didReceiveAppEvent name: String,
    withInfo info: String?) {
  if name == "color" {
    guard let info = info else { return }
    switch info {
    case "green":
      // Set background color to green.
      view.backgroundColor = UIColor.green
    case "blue":
      // Set background color to blue.
      view.backgroundColor = UIColor.blue
    default:
      // Set background color to black.
      view.backgroundColor = UIColor.black
    }
  }
}

Objective-C

- (void)adView:(DFPBannerView *)banner
    didReceiveAppEvent:(NSString *)name
              withInfo:(NSString *)info {
  if ([name isEqual:@"color"]) {
    if ([info isEqual:@"green"]) {
      // Set background color to green.
      self.view.backgroundColor = [UIColor greenColor];
    } else if ([info isEqual:@"blue"]) {
      // Set background color to blue.
      self.view.backgroundColor = [UIColor blueColor];
    } else
      // Set background color to black.
      self.view.backgroundColor = [UIColor blackColor];
    }
  }
}

また、対応するクリエイティブは次のとおりです。これは、色に関するアプリ内イベント メッセージを appEventDelegate に送信します。

<html>
<head>
  <script src="//media.admob.com/api/v1/google_mobile_app_ads.js"></script>
  <script>
    document.addEventListener("DOMContentLoaded", function() {
      // Send a color=green event when ad loads.
      admob.events.dispatchAppEvent("color", "green");

      document.getElementById("ad").addEventListener("click", function() {
        // Send a color=blue event when ad is clicked.
        admob.events.dispatchAppEvent("color", "blue");
      });
    });
  </script>
  <style>
    #ad {
      width: 320px;
      height: 50px;
      top: 0px;
      left: 0px;
      font-size: 24pt;
      font-weight: bold;
      position: absolute;
      background: black;
      color: white;
      text-align: center;
    }
  </style>
</head>
<body>
  <div id="ad">Carpe diem!</div>
</body>
</html>

iOS API デモアプリでアプリ内イベントを実装するには、アド マネージャーによるアプリ内イベントの実装例をご覧ください。

Swift Objective-C

Additional resources

Samples on GitHub

Mobile Ads Garage video tutorials