広告メタデータ

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

前提条件

  • Google Mobile Ads SDK のバージョン 17.0.0 以降。
  • 動画リワード広告に記載されている手順を完了します。

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

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

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

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

Java

RewardedAd.load(this, "/6499/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, "/6499/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")
        }
      }
    })

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

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