広告レスポンスに関する情報を取得する

デバッグとロギングの用途では、正常に読み込まれた広告が GADResponseInfo オブジェクトを提供します。このオブジェクトには、広告を読み込む際に使用されたメディエーションの順次処理の情報とともに、読み込まれた広告の情報が含まれています。

広告の読み込みが成功した場合、広告オブジェクトは GADResponseInfo プロパティを持ちます。たとえば、GADInterstitialAd.responseInfo により、読み込まれたインタースティシャル広告のレスポンス情報を取得可能です。

広告の読み込みに失敗してエラーだけが返された場合は、そのエラーの userInfo リスト上のキー GADErrorUserInfoKeyResponseInfo を使って GADResponseInfo を取得できます。

Swift

fileprivate func loadInterstitial() {
  GADInterstitialAd.load(
    withAdUnitID: "ca-app-pub-3940256099942544/4411468910", request: request
  ) { (ad, error) in
    if let error = error {
      let responseInfo = (error as NSError).userInfo[GADErrorUserInfoKeyResponseInfo] as? GADResponseInfo
      print("\(String(describing: responseInfo))")
      return
    }
    let responseInfo = ad?.responseInfo
    print("\(String(describing: responseInfo))")
  }
}

Objective-C

- (void)loadInterstitial {
  [GADInterstitialAd
   loadWithAdUnitID:@"ca-app-pub-3940256099942544/4411468910"
   request:request
   completionHandler:^(GADInterstitialAd *ad, NSError *error) {
    if (error) {
      GADResponseInfo *responseInfo = error.userInfo[GADErrorUserInfoKeyResponseInfo];
      NSLog(@"%@", responseInfo.description);
      return;
    }
    GADResponseInfo *responseInfo = ad.responseInfo;
    NSLog(@"%@", responseInfo.description);
  }];
}

レスポンス情報

以下は、読み込まれた広告についてのデバッグ用データが表示されている出力の例です。

  ** Response Info **
    Response ID: CLz5r-KMtfoCFQvv7QodfGAMHw
    Network: GADMAdapterGoogleAdMobAds

  ** Loaded Adapter Response **
    Network: GADMAdapterGoogleAdMobAds
    Ad Source Name:Reservation campaign
    Ad Source ID:7068401028668408324
    Ad Source Instance Name:[DO NOT EDIT] Publisher Test Interstitial
    Ad Source Instance ID:[DO NOT EDIT] Publisher Test Interstitial
    AdUnitMapping:
{
}
    Error: (null)
    Latency: 0.357

  ** Extras Dictionary **
    {
        "mediation_group_name" = Campaign;
    }

  ** Mediation line items **
    Entry (1)
    Network: GADMAdapterGoogleAdMobAds
    Ad Source Name:Reservation campaign
    Ad Source ID:7068401028668408324
    Ad Source Instance Name:[DO NOT EDIT] Publisher Test Interstitial
    Ad Source Instance ID:[DO NOT EDIT] Publisher Test Interstitial
    AdUnitMapping:
{
}
    Error: (null)
    Latency: 0.357

GADResponseInfo のプロパティには、以下が含まれます。

プロパティ 説明
adNetworkInfoArray 広告レスポンスに含まれる各アダプタのメタデータを含む GADAdNetworkResponseInfo のリストを返します。このメソッドは、ウォーターフォール型メディエーションと入札の実行をデバッグする際に使用できます。リストの順序は、この広告リクエストのメディエーション ウォーターフォールの順序と同じです。

詳細については、アダプタ レスポンス情報をご覧ください。

loadedAdNetworkResponseInfo 広告を読み込んだアダプタに対応する GADAdNetworkResponseInfo を返します。
adNetworkClassName 広告を読み込んだ広告ネットワークのメディエーション アダプタ クラス名を返します。
responseIdentifier レスポンス ID は、広告レスポンスごとに固有の ID で、広告レビュー センター(ARC)で広告を識別してブロックするために使われます。
extrasDictionary

広告レスポンスについての追加情報を返します。 追加情報には次のキーが含まれます。

  • mediation_group_name: メディエーション グループの名前
  • mediation_ab_test_name: メディエーション A/B テストの名前(該当する場合)
  • mediation_ab_test_variant: メディエーション A/B テストで使用されたパターン(該当する場合)

Swift

fileprivate func loadInterstitial() {
  GADInterstitialAd.load(
    withAdUnitID: "ca-app-pub-3940256099942544/4411468910", request: request
  ) { (ad, error) in
    let responseInfo = ad?.responseInfo

    let responseIdentifier = responseInfo?.responseIdentifier
    let adNetworkClassName = responseInfo?.adNetworkClassName
    let adNetworkInfoArray = responseInfo?.adNetworkInfoArray
    let loadedAdNetworkResponseInfo = responseInfo?.loadedAdNetworkResponseInfo
    let mediationGroupName = responseInfo?.extrasDictionary["mediation_group_name"]
    let mediationABTestName = responseInfo?.extrasDictionary["mediation_ab_test_name"]
    let mediationABTestVariant = responseInfo?.extrasDictionary["mediation_ab_test_variant"]
  }
}

Objective-C

- (void)loadInterstitial {
  [GADInterstitialAd
   loadWithAdUnitID:@"ca-app-pub-3940256099942544/4411468910"
   request:request
   completionHandler:^(GADInterstitialAd *ad, NSError *error) {
    GADResponseInfo *responseInfo = ad.responseInfo;

    NSString *responseIdentifier = responseInfo.responseIdentifier;
    NSString *adNetworkClassName = responseInfo.adNetworkClassName;
    NSArray *adNetworkInfoArray = responseInfo.adNetworkInfoArray;
    GADAdNetworkResponseInfo *loadedAdNetworkResponseInfo = responseInfo.loadedAdNetworkResponseInfo;
    NSString *mediationGroupName = responseInfo.extrasDictionary[@"mediation_group_name"];
    NSString *mediationABTestName = responseInfo.extrasDictionary[@"mediation_ab_test_name"];
    NSString *mediationABTestVariant = responseInfo.extrasDictionary[@"mediation_ab_test_variant"];
  }];
}

アダプタ レスポンス情報

GADAdNetworkResponseInfo には、広告レスポンスに含まれる各アダプタのメタデータが格納されており、この情報はウォーターフォール メディエーションと入札処理のデバッグに使用できます。リストの順序は、広告リクエストのメディエーション ウォーターフォールの順序と同じです。

GADAdNetworkResponseInfo の出力例を次に示します。

    Network: GADMAdapterGoogleAdMobAds
    Ad Source Name:Reservation campaign
    Ad Source ID:7068401028668408324
    Ad Source Instance Name:[DO NOT EDIT] Publisher Test Interstitial
    Ad Source Instance ID:[DO NOT EDIT] Publisher Test Interstitial
    AdUnitMapping:
{
}
    Error: (null)
    Latency: 0.277

広告ネットワークごとに、GADAdNetworkResponseInfo は次のプロパティを提供します。

プロパティ 説明
error ネットワークへのリクエストに関連したエラー。ネットワークが広告の読み込みに成功した場合や、読み込みを試行しなかった場合は、「nil」が返されます。
adSourceId このアダプタ レスポンスに関連付けられている広告ソース ID。キャンペーンについて、キャンペーンの目標タイプがメディエーション広告なら 6060308706800320801 が、インプレッション(表示回数)やクリックなら 7068401028668408324 が返されます。広告ネットワークが広告を配信する際に使用される可能性がある広告ソース ID の一覧は、広告ソースで確認できます。
adSourceInstanceId このアダプタ レスポンスに関連付けられている広告ソースのインスタンス ID。
adSourceInstanceName このアダプタ レスポンスに関連付けられている広告ソースのインスタンス名。
adSourceName インプレッションを配信する広告ネットワークに対応する広告ソース。キャンペーンについて、キャンペーンの目標タイプがメディエーション広告なら Mediated House Ads が、インプレッション(表示回数)やクリックなら Reservation Campaign が返されます。広告ネットワークが広告を配信する際の広告ソース名の一覧は、広告ソースで確認できます。
adNetworkClassName 広告を読み込んだ広告ネットワーク アダプタのクラス名。
adUnitMapping AdMob 管理画面で設定されたネットワーク設定。
latency 広告ネットワークが広告の読み込みに費やした時間。読み込みを試行しなかった場合は 0 を返します。

Swift

fileprivate func loadInterstitial() {
  GADInterstitialAd.load(
    withAdUnitID: "ca-app-pub-3940256099942544/4411468910", request: request
  ) { (ad, error) in
    let responseInfo = ad?.responseInfo
    let loadedAdNetworkResponseInfo = responseInfo?.loadedAdNetworkResponseInfo

    let adNetworkError = loadedAdNetworkResponseInfo?.error
    let adSourceId = loadedAdNetworkResponseInfo?.adSourceID
    let adSourceInstanceId = loadedAdNetworkResponseInfo?.adSourceInstanceID
    let adSourceInstanceName = loadedAdNetworkResponseInfo?.adSourceInstanceName
    let adSourceName = loadedAdNetworkResponseInfo?.adSourceName
    let adNetworkClassName = loadedAdNetworkResponseInfo?.adNetworkClassName
    let adUnitMapping = loadedAdNetworkResponseInfo?.adUnitMapping
    let latency = loadedAdNetworkResponseInfo?.latency
  }
}

Objective-C

- (void)loadInterstitial {
  [GADInterstitialAd
   loadWithAdUnitID:@"ca-app-pub-3940256099942544/4411468910"
   request:request
   completionHandler:^(GADInterstitialAd *ad, NSError *error) {
    GADResponseInfo *responseInfo = ad.responseInfo;
    GADAdNetworkResponseInfo *loadedAdNetworkResponseInfo = responseInfo.loadedAdNetworkResponseInfo;

    NSError *adNetworkError = loadedAdNetworkResponseInfo.error;
    NSString *adSourceId = loadedAdNetworkResponseInfo.adSourceID;
    NSString *adSourceInstanceId = loadedAdNetworkResponseInfo.adSourceInstanceID;
    NSString *adSourceInstanceName = loadedAdNetworkResponseInfo.adSourceInstanceName;
    NSString *adSourceName = loadedAdNetworkResponseInfo.adSourceName;
    NSString *adNetworkClassName = loadedAdNetworkResponseInfo.adNetworkClassName;
    NSDictionary *adUnitMapping = loadedAdNetworkResponseInfo.adUnitMapping;
    NSTimeInterval latency = loadedAdNetworkResponseInfo.latency;
  }];
}