Prerequisites
- Google Mobile Ads SDK 19.7.0 or higher.
- Complete the Get started guide .
Always test with test ads
When building and testing your apps, make sure you use test ads rather than live, production ads. Failure to do so can lead to suspension of your account.
The easiest way to load test ads is to use our dedicated test ad unit ID for Android rewarded ads:
ca-app-pub-3940256099942544/5224354917
It's been specially configured to return test ads for every request, and you're free to use it in your own apps while coding, testing, and debugging. Just make sure you replace it with your own ad unit ID before publishing your app.
For more information about how Google Mobile Ads SDK test ads work, see Test Ads .
Load a rewarded ad object
Rewarded ads are loaded by calling the static load()
method on the RewardedAd
class and passing in a RewardedAdLoadCallback
. This is usually
done in the onCreate()
method of an Activity
.
Notice that like other format load callbacks, RewardedAdLoadCallback
leverages LoadAdError
to provide higher fidelity error details.
Java
Kotlin
Replace AD_UNIT_ID with your ad unit ID.
Set the FullScreenContentCallback
The FullScreenContentCallback
handles events related to displaying your RewardedAd
. Before you show your RewardedAd
, make sure to set the callback
like so:
Java
rewardedAd
.
setFullScreenContentCallback
(
new
FullScreenContentCallback
()
{
@Override
public
void
onAdDismissedFullScreenContent
()
{
// Called when fullscreen content is dismissed.
Log
.
d
(
TAG
,
"Ad was dismissed."
);
// Don't forget to set the ad reference to null so you
// don't show the ad a second time.
rewardedAd
=
null
;
}
@Override
public
void
onAdFailedToShowFullScreenContent
(
AdError
adError
)
{
// Called when fullscreen content failed to show.
Log
.
d
(
TAG
,
"Ad failed to show."
);
// Don't forget to set the ad reference to null so you
// don't show the ad a second time.
rewardedAd
=
null
;
}
@Override
public
void
onAdShowedFullScreenContent
()
{
// Called when fullscreen content is shown.
Log
.
d
(
TAG
,
"Ad showed fullscreen content."
);
}
@Override
public
void
onAdImpression
()
{
// Called when an impression is recorded for an ad.
Log
.
d
(
TAG
,
"Ad recorded an impression."
);
}
@Override
public
void
onAdClicked
()
{
// Called when an ad is clicked.
Log
.
d
(
TAG
,
"Ad was clicked."
);
}
});
Kotlin
rewardedAd
?.
fullScreenContentCallback
=
object
:
FullScreenContentCallback
()
{
override
fun
onAdDismissedFullScreenContent
()
{
// Called when fullscreen content is dismissed.
Log
.
d
(
TAG
,
"Ad was dismissed."
)
// Don't forget to set the ad reference to null so you
// don't show the ad a second time.
rewardedAd
=
null
}
override
fun
onAdFailedToShowFullScreenContent
(
adError
:
AdError
)
{
// Called when fullscreen content failed to show.
Log
.
d
(
TAG
,
"Ad failed to show."
)
// Don't forget to set the ad reference to null so you
// don't show the ad a second time.
rewardedAd
=
null
}
override
fun
onAdShowedFullScreenContent
()
{
// Called when fullscreen content is shown.
Log
.
d
(
TAG
,
"Ad showed fullscreen content."
)
}
override
fun
onAdImpression
()
{
// Called when an impression is recorded for an ad.
Log
.
d
(
TAG
,
"Ad recorded an impression."
)
}
override
fun
onAdClicked
()
{
// Called when an ad is clicked.
Log
.
d
(
TAG
,
"Ad was clicked."
)
}
}
Show the ad
When you show a rewarded ad, you will use an OnUserEarnedRewardListener
object
to handle reward events.
Java
rewardedAd
.
show
(
MainActivity
.
this
,
new
OnUserEarnedRewardListener
()
{
@Override
public
void
onUserEarnedReward
(
@NonNull
RewardItem
rewardItem
)
{
Log
.
d
(
TAG
,
"User earned the reward."
);
// Handle the reward.
}
});
Kotlin
rewardedAd
?.
show
(
this
,
OnUserEarnedRewardListener
{
rewardItem
-
>
Log
.
d
(
TAG
,
"User earned the reward."
)
// Handle the reward.
val
rewardAmount
=
rewardItem
.
amount
val
rewardType
=
rewardItem
.
type
},
)
[Optional] Validate server-side verification (SSV) callbacks
Apps that require extra data in server-side
verification
callbacks should use the custom data feature of rewarded ads. Any string value
set on a rewarded ad object is passed to the custom_data
query parameter of
the SSV callback. If no custom data value is set, the custom_data
query
parameter value won't be present in the SSV callback.
The following code sample demonstrates how to set custom data on a rewarded ad object before requesting an ad.
Java
Kotlin
Replace SAMPLE_CUSTOM_DATA_STRING with your custom data.
If you want to set the custom reward string, you must do so before showing the ad.
FAQ
- Is there a timeout for the initialization call?
- After 10 seconds, Google Mobile Ads SDK invokes the
OnInitializationCompleteListenereven if a mediation network still hasn't completed initialization. - What if some mediation networks aren't ready when I get the initialization callback?
-
We recommend loading an ad inside the callback of the
OnInitializationCompleteListener. Even if a mediation network is not ready, Google Mobile Ads SDK still asks that network for an ad. So if a mediation network finishes initializing after the timeout, it can still service future ad requests in that session.You can continue to poll the initialization status of all adapters throughout your app session by calling
MobileAds.getInitializationStatus(). - How do I find out why a particular mediation network isn't ready?
-
AdapterStatus.getDescription()describes why an adapter is not ready to service ad requests. - Does the
onUserEarnedReward()callback always get called before theonAdDismissedFullScreenContent()callback? -
For Google ads, all
onUserEarnedReward()calls occur beforeonAdDismissedFullScreenContent(). For ads served through mediation , the third-party ad network SDK's implementation determines the callback order. For ad network SDKs that provide a single close callback with reward information, the mediation adapter invokesonUserEarnedReward()beforeonAdDismissedFullScreenContent().
Examples on GitHub
Next steps
Explore the following topics:
