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

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

広告の読み込みが成功した場合、広告オブジェクトは getResponseInfo() メソッドを持ちます。たとえば、InterstitialAd.getResponseInfo() により、読み込まれたインタースティシャル広告のレスポンス情報を取得可能です。

広告の読み込みが失敗し、エラーだけが返された場合、レスポンス情報は LoadAdError.getResponseInfo() を通して取得できます。

Kotlin

override fun onAdLoaded(interstitialAd: InterstitialAd)) {
  val responseInfo = interstitialAd.responseInfo
  Log.d(TAG, responseInfo.toString())
}

override fun onAdFailedToLoad(adError: LoadAdError) {
  val responseInfo = adError.responseInfo
  Log.d(TAG, responseInfo.toString())
}

Java

@Override
public void onAdLoaded(@NonNull InterstitialAd interstitialAd) {
  ResponseInfo responseInfo = interstitialAd.getResponseInfo();
  Log.d(TAG, responseInfo.toString());
}

@Override
public void onAdFailedToLoad(LoadAdError loadAdError) {
  ResponseInfo responseInfo = loadAdError.getResponseInfo();
  Log.d(TAG, responseInfo.toString());
}

レスポンス情報

以下は ResponseInfo.toString() によって返された出力の例です。読み込まれた広告についてのデバッグ用データが表示されています。

{
  "Response ID": "COOllLGxlPoCFdAx4Aod-Q4A0g",
  "Mediation Adapter Class Name": "com.google.ads.mediation.admob.AdMobAdapter",
  "Adapter Responses": [
    {
      "Adapter": "com.google.ads.mediation.admob.AdMobAdapter",
      "Latency": 328,
      "Ad Source Name": "Reservation campaign",
      "Ad Source ID": "7068401028668408324",
      "Ad Source Instance Name": "[DO NOT EDIT] Publisher Test Interstitial",
      "Ad Source Instance ID": "4665218928925097",
      "Credentials": {},
      "Ad Error": "null"
    }
  ],
  "Loaded Adapter Response": {
    "Adapter": "com.google.ads.mediation.admob.AdMobAdapter",
    "Latency": 328,
    "Ad Source Name": "Reservation campaign",
    "Ad Source ID": "7068401028668408324",
    "Ad Source Instance Name": "[DO NOT EDIT] Publisher Test Interstitial",
    "Ad Source Instance ID": "4665218928925097",
    "Credentials": {},
    "Ad Error": "null"
  },
  "Response Extras": {
    "mediation_group_name": "Campaign"
  }
}

ResponseInfo オブジェクトのメソッドには次のものがあります。

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

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

getLoadedAdapterResponseInfo 広告を読み込んだアダプタに対応する AdapterResponseInfo を返します。
getMediationAdapterClassName 広告を読み込んだ広告ソースのメディエーション アダプタ クラス名を返します。
getResponseId レスポンス ID は、広告レスポンスごとに固有の ID で、広告レビュー センター(ARC)で広告を識別してブロックするために使用されます。
getResponseExtras

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

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

Kotlin

override fun onAdLoaded(interstitialAd: InterstitialAd)) {
  val responseInfo = interstitialAd.responseInfo

  val responseId = responseInfo.responseId
  val mediationAdapterClassName = responseInfo.mediationAdapterClassName
  val adapterResponses = responseInfo.adapterResponses
  val loadedAdapterResponseInfo = responseInfo.loadedAdapterResponseInfo
  val extras = responseInfo.responseExtras
  val mediationGroupName = extras.getString("mediation_group_name")
  val mediationABTestName = extras.getString("mediation_ab_test_name")
  val mediationABTestVariant = extras.getString("mediation_ab_test_variant")
}

Java

@Override
public void onAdLoaded(@NonNull InterstitialAd interstitialAd) {
  MyActivity.this.interstitialAd = interstitialAd;

  ResponseInfo responseInfo = interstitialAd.getResponseInfo();
  String responseId = responseInfo.getResponseId();
  String mediationAdapterClassName = responseInfo.getMediationAdapterClassName();
  List<AdapterResponseInfo> adapterResponses = responseInfo.getAdapterResponses();
  AdapterResponseInfo loadedAdapterResponseInfo = responseInfo.getLoadedAdapterResponseInfo();
  Bundle extras = responseInfo.getResponseExtras();
  String mediationGroupName = extras.getString("mediation_group_name");
  String mediationABTestName = extras.getString("mediation_ab_test_name");
  String mediationABTestVariant = extras.getString("mediation_ab_test_variant");
}

アダプタ レスポンス情報

AdapterResponseInfo には、広告レスポンス内の個々の広告ソースのレスポンス情報が含まれます。

次の AdapterResponseInfo 出力例は、読み込まれた広告のメタデータを示しています。

{
  "Adapter": "com.google.ads.mediation.admob.AdMobAdapter",
  "Latency": 328,
  "Ad Source Name": "Reservation campaign",
  "Ad Source ID": "7068401028668408324",
  "Ad Source Instance Name": "[DO NOT EDIT] Publisher Test Interstitial",
  "Ad Source Instance ID": "4665218928925097",
  "Credentials": {},
  "Ad Error": "null"
}

AdapterResponseInfo は広告ソースごとに、次のメソッドを提供します。

メソッド 説明
getAdError 広告ソースへのリクエストに関連付けられているエラーを取得します。広告ソースが広告の読み込みに成功した場合、または広告ソースの読み込みを試行しなかった場合は、null を返します。
getAdSourceId このアダプタ レスポンスに関連付けられている広告ソース ID を取得します。キャンペーンについて、キャンペーンの目標タイプがメディエーション広告なら 6060308706800320801 が、インプレッション(表示回数)やクリックなら 7068401028668408324 が返されます。広告ソースが広告を配信する際に使用される可能性がある広告ソース ID の一覧は、広告ソースで確認できます。
getAdSourceInstanceId このアダプタ レスポンスに関連付けられている広告ソースのインスタンス ID を取得します。
getAdSourceInstanceName このアダプタ レスポンスに関連付けられている広告ソースのインスタンス名を取得します。
getAdSourceName このアダプタ レスポンスに関連付けられている広告ソース名を取得します。キャンペーンについて、キャンペーンの目標タイプがメディエーション広告なら Mediated House Ads が、インプレッション(表示回数)やクリックなら Reservation Campaign が返されます。広告ソースが広告を配信する際の広告ソース名の一覧は、広告ソースで確認できます。
getAdapterClassName 広告を読み込んだ広告ソース アダプタのクラス名を取得します。
getCredentials AdMob の管理画面で指定された広告ソースのアダプタ認証情報を取得します。
getLatencyMillis 広告ソース アダプタが広告の読み込みに費やした時間を取得します。広告ソースが試行されなかった場合は 0 を返します。

Kotlin

override fun onAdLoaded(interstitialAd: InterstitialAds) {
  val loadedAdapterResponseInfo = interstitialAd.responseInfo.loadedAdapterResponseInfo

  val adError = loadedAdapterResponseInfo.adError
  val adSourceId = loadedAdapterResponseInfo.adSourceId
  val adSourceInstanceId = loadedAdapterResponseInfo.adSourceInstanceId
  val adSourceInstanceName = loadedAdapterResponseInfo.adSourceInstanceName
  val adSourceName = loadedAdapterResponseInfo.adSourceName
  val adapterClassName = loadedAdapterResponseInfo.adapterClassName
  val credentials = loadedAdapterResponseInfo.credentials
  val latencyMillis = loadedAdapterResponseInfo.latencyMillis
}

Java

@Override
public void onAdLoaded(@NonNull InterstitialAd interstitialAd) {
  AdapterResponseInfo loadedAdapterResponseInfo =
      interstitialAd.getResponseInfo().getLoadedAdapterResponseInfo();

  AdError adError = loadedAdapterResponseInfo.getAdError();
  String adSourceId = loadedAdapterResponseInfo.getAdSourceId();
  String adSourceInstanceId = loadedAdapterResponseInfo.getAdSourceInstanceId();
  String adSourceInstanceName = loadedAdapterResponseInfo.getAdSourceInstanceName();
  String adSourceName = loadedAdapterResponseInfo.getAdSourceName();
  String adapterClassName = loadedAdapterResponseInfo.getAdapterClassName();
  Bundle credentials = loadedAdapterResponseInfo.getCredentials();
  long latencyMillis = loadedAdapterResponseInfo.getLatencyMillis();
}