広告メタデータ

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

前提条件

  • Google Mobile Ads SDK のバージョンが 17.0.0 以降であること。
  • リワード動画の手順を完了します。

広告メタデータの取得

一部のアプリでは、配信された広告の詳細を確認する必要がある場合があります。動画リワード広告の広告メタデータの変更をリッスンするには、AdMetadataListener の実装で RewardedVideoAd.setAdMetadataListener() を呼び出します。AdMetadataListener.onAdMetadataChanged() が呼び出されると、RewardedVideo.getAdMetadata() で広告のメタデータを確認できます。

onAdMetadataChanged() は、広告の読み込み直後、または読み込み後にメタデータが非同期で変更されたときに呼び出されます。広告の読み込み時に広告のメタデータが利用可能になるとは限らないため、広告のメタデータにアクセスする前に、このコールバックを待つことをおすすめします。

広告メタデータを取得する方法のコード例を次に示します。

Java

RewardedAd.load(this, "/21775744923/example/rewarded", new AdManagerAdRequest.Builder().build(),
    new RewardedAdLoadCallback() {
      @Override
      public void onAdLoaded(@NonNull RewardedAd rewardedAd) {
        mRewardedAd = rewardedAd;
        rewardedAd.setOnAdMetadataChangedListener(new OnAdMetadataChangedListener() {
          @Override
          public void onAdMetadataChanged() {
            Bundle metadata = rewardedAd.getAdMetadata();
            String adId = metadata.getString("AdId");
          }
        });
      }
    });

Kotlin

RewardedAd.load(this, "/21775744923/example/rewarded", AdManagerAdRequest.Builder().build(),
                    object : RewardedAdLoadCallback() {
      override fun onAdLoaded(rewardedAd: RewardedAd) {
        mRewardedAd = rewardedAd
        rewardedAd.onAdMetadataChangedListener = OnAdMetadataChangedListener {
          val metadata = rewardedAd.adMetadata
          val adId = metadata.getString("AdId")
        }
      }
    })

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

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