広告メタデータ

[プラットフォームを選択]: Android(ベータ版) New-selected Android iOS

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

前提条件

広告メタデータを取得する

配信された広告について詳しくは、リワード動画広告の広告メタデータの変更をリッスンしてください。

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

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

Kotlin

RewardedAd.load(
AdRequest.Builder("AD_UNIT_ID").build(),
object : AdLoadCallback<RewardedAd> {
  override fun onAdLoaded(ad: RewardedAd) {
    ...
    ad.adEventCallback = object : RewardedAdEventCallback {
      override fun onAdMetadataChanged() {
        val metadata = ad.adMetadata
        val adId = metadata.getString("AdId")
      }
    }
  }
})

Java

RewardedAd.load(
  new AdRequest.Builder("AD_UNIT_ID").build(),
  new AdLoadCallback<RewardedAd>() {
    @Override
    public void onAdLoaded(@NonNull RewardedAd rewardedAd) {
      Rewarded.this.rewardedAd = rewardedAd;
        ...
        rewardedAd.setAdEventCallback(new RewardedAdEventCallback() {
            @Override
            public void onAdMetadataChanged() {
                Bundle metadata = rewardedAd.getAdMetadata();
                String adId = metadata.getString("AdId");
            }
        });
      };
    };
  );

AD_UNIT_ID は、実際の広告ユニットに置き換えます。たとえば、リワード広告の場合は /21775744923/example/rewarded です。

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

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