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:
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"
);
}
});
};
};
);
Replace AD_UNIT_ID
ad unit. For example, /21775744923/example/rewarded
for rewarded ads.
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.
