広告メタデータ

プラットフォームを選択: Android iOS

このガイドは、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"];
}

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

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