広告メタデータ

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

前提条件

  • Google Mobile Ads SDK の最小バージョンは 17.0.0 です。
  • リワード動画の手順を完了します。

広告メタデータの取得

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

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