広告メタデータ

このガイドは、広告メタデータを Google Mobile Ads iOS SDK と統合するパブリッシャー様を対象としています。

前提条件

広告メタデータを取得しています

配信される広告について、アプリが詳しく把握できるようにするには、広告を独自の GADAdMetadataDelegate に設定します。その後、GADAdMetadataDelegate に adMetadataDidChange: メソッドを実装することで、広告メタデータの変更をリッスンできます。このデリゲートが呼び出されたら、広告の adMetadata プロパティを確認します。

adMetadataDidChange: は、広告が読み込まれた直後か、広告のメタデータが読み込み後に非同期に変更されたときに呼び出されます。広告メタデータは読み込み時に利用できるとは限りません。そのため、このコールバックを待ってから、広告のメタデータにアクセスすることをおすすめします。

次のコードサンプルは、リワード広告の広告メタデータを取得する方法を示しています。

@interface ViewController () <GADFullScreenContentDelegate, GADAdMetadataDelegate>

@end

@implementation ViewController
- (void)loadRewardedAd {
   *request = [ request];
  [GADRewardedAd
       loadWithAdUnitID:@"ca-app-pub-3940256099942544/4806952744"
                request:request
      completionHandler:^(GADRewardedAd *ad, NSError *error) {
        if (error) {
          NSLog(@"Rewarded ad failed to load with error: %@", [error localizedDescription]);
          return;
        }
        self.rewardedAd = ad;
        self.rewardedAd.fullScreenContentDelegate = self;

        /// Set the ad to be the delegate of its ad metadata.
        self.rewardedAd.adMetadataDelegate = self;

        NSLog(@"Rewarded ad loaded.");
      }];
}

/#pragma mark GADAdMetadataDelegate implementation

- (void)adMetadataDidChange:(id<GADAdMetadataProvider>)ad {
  NSDictionary<NSString*, id> *adMetadata = _rewardedAd.adMetadata;
  NSString *adId = adMetadata[@"AdId"];
}

メタデータを取得したら、バンドルで目的のキーを確認できます。広告の種類によって、関連付けられている広告メタデータ キーが異なる場合があります。VAST 動画広告には次のキーがあります。

キー 種類 説明
AdId 文字列 広告の ID。使用できない場合は空の文字列。
AdTitle 文字列 タイトル。指定しない場合は空になります。
CreativeDurationMs Integer 選択されたクリエイティブの再生時間（ミリ秒単位）。ノンリニアの場合は -1。
TraffickingParameters 文字列 入稿パラメータ。使用できない場合は空の文字列。
DealId 文字列 現在の広告のラッパー チェーンに存在する最初の取引 ID。先頭から始まります。この情報を取得できない場合は空の文字列。
AdSystem 文字列 広告のソース広告サーバー。使用できない場合は空です。
CreativeId 文字列 広告に対して選択されたクリエイティブの ID。存在しない場合は空白です。
MediaURL 文字列 選択したメディアの URL です。
Wrappers 配列 この配列には、最も内側のラッパー広告（インライン広告の近く）で始まり、最も外側のラッパー広告に向かって外側に移動する要素が入力されます。配列内の各要素は、次のキーと値を含む辞書です。
AdId
文字列。ラッパー広告に使用される広告 ID。使用できない場合は空です。
AdSystem
文字列。ラッパー広告に使用される広告システム。使用できない場合は空です。
CreativeId
文字列。ラッパー広告に使用されるクリエイティブ ID。使用できない場合は空です。