Page Summary
-
Integrate Ad Metadata with the Google Mobile Ads SDK for Android to get more information about served ads.
-
Ensure your project meets the prerequisites of Google Mobile Ads SDK version 17.0.0 or higher and has completed the Rewarded Video setup.
-
Listen for ad metadata changes using the
onAdMetadataChanged()callback, which provides a Bundle containing ad metadata keys. -
Different ad types have varying metadata keys, with VAST video ads including keys like
AdId,AdTitle,CreativeDurationMs, andWrappers. -
Access ad metadata after the
onAdMetadataChanged()callback as it is not guaranteed to be available immediately upon ad load.
This guide is intended for publishers integrating Ad Metadata with the Google Mobile Ads SDK for Android.
Prerequisites
- Minimum version 17.0.0 of the Google Mobile Ads SDK.
- Complete the steps in Rewarded Video .
Fetching ad metadata
To know more about served ads, listen for ad metadata changes on rewarded video ads.
onAdMetadataChanged()
is called just after an ad loads or when its
metadata changes asynchronously after it loads. It is not guaranteed
that an ad's metadata will be available at the time the ad is
loaded, so we recommend waiting for this callback before accessing an ad's
metadata.
Here is a code example showing how to retrieve the ad metadata:
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" ) } } })
After retrieving the metadata, you can check the Bundle for the keys you care about. Different types of ads may have different ad metadata keys associated with them. VAST video ads have the following keys:
Key
AdId
AdTitle
CreativeDurationMs
TraffickingParameters
DealId
AdSystem
CreativeId
MediaURL
Wrappers
-
AdId - String . Ad ID used for wrapper ad, empty if not available.
-
AdSystem - String . Ad system used for wrapper ad, empty if not available.
-
CreativeId - String . Creative ID used for wrapper ad, empty if not available.
