Skip to content

Rewarded ads

Rewarded ads enable users to play games, take surveys, or watch videos to earn in-app rewards, such as coins, extra lives, or points. You can set different rewards for different ad units, and specify the reward values and items the user received.

Prerequisites

Complete the following steps described in 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 rewarded ads:

Android demo ad unit ID iOS demo ad unit ID
ca-app-pub-3940256099942544/5224354917 ca-app-pub-3940256099942544/1712485313

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

To load a rewarded ad, create an instance of UGoogleAdMobRewardedAd class and call it's Load() method.

Header:

class UGoogleAdMobRewardedAd;
// ...
UPROPERTY()
TObjectPtr<UGoogleAdMobRewardedAd> RewardedAd;

Source:

#include "GoogleAdMob.h"
#include "GoogleAdMobRewardedAd.h"
// ...
RewardedAd = NewObject<UGoogleAdMobRewardedAd>(this);
if (UGoogleAdMob::CanRequestAds())
{
#if PLATFORM_ANDROID
    RewardedAd->Load("ca-app-pub-3940256099942544/5224354917");
#elif PLATFORM_IOS
    RewardedAd->Load("ca-app-pub-3940256099942544/1712485313");
#endif
}

Tip

You can use ad load calls to build up a cache of preloaded ads before you intend to show them, so that ads can be shown with zero latency when needed. Since ads expire after an hour, you should clear this cache and reload with new ads every hour. You can see an example of how it can be implemented in the C++ sample project at the bottom of the page.

Show the ad

When you show a rewarded ad, you will use a OnUserEarnedReward delegate to handle reward events. To show a rewarded ad, use it's Show() method.

if (RewardedAd->IsReady())
{
    RewardedAd->Show();
}

Ad events

You can listen for a number of events in the ad's lifecycle, including loading, ad impression and click, as well as show and dismiss events. But for the rewarded ad the most important is OnUserEarnedReward. It is recommended to bind to the delegates before loading the ad.

Header:

struct UGoogleAdMobResponseInfo;
struct UGoogleAdMobAdError;
struct UGoogleAdMobAdValue;
// ...
UFUNCTION()
void OnLoaded(const UGoogleAdMobResponseInfo& ResponseInfo);

UFUNCTION()
void OnFailedToLoad(const UGoogleAdMobAdError& LoadAdError, const UGoogleAdMobResponseInfo& ResponseInfo);

UFUNCTION()
void OnFailedToShow(const UGoogleAdMobAdError& AdError);

UFUNCTION()
void OnShown();

UFUNCTION()
void OnClicked();

UFUNCTION()
void OnImpression();

UFUNCTION()
void OnDismissed();

UFUNCTION()
void OnPaidEvent(const UGoogleAdMobAdValue& AdValue);

UFUNCTION()
void OnUserEarnedReward(int32 RewardAmount, const FString& RewardType);

Source:

#include "GoogleAdMobRewardedAd.h"
#include "GoogleAdMobResponseInfo.h"
#include "GoogleAdMobAdError.h"
#include "GoogleAdMobAdValue.h"
// ...
RewardedAd->OnLoaded.AddDynamic(this, &UYourClass::OnLoaded);
RewardedAd->OnFailedToLoad.AddDynamic(this, &UYourClass::OnFailedToLoad);
RewardedAd->OnFailedToShow.AddDynamic(this, &UYourClass::OnFailedToShow);
RewardedAd->OnShown.AddDynamic(this, &UYourClass::OnShown);
RewardedAd->OnClicked.AddDynamic(this, &UYourClass::OnClicked);
RewardedAd->OnImpression.AddDynamic(this, &UYourClass::OnImpression);
RewardedAd->OnDismissed.AddDynamic(this, &UYourClass::OnDismissed);
RewardedAd->OnPaidEvent.AddDynamic(this, &UYourClass::OnPaidEvent);
RewardedAd->OnUserEarnedReward.AddDynamic(this, &UYourClass::OnUserEarnedReward);

FAQ

Is there a timeout for the initialization call?

After 10 seconds, Google Mobile Ads SDK invokes the OnInitializationComplete delegate even if a mediation network still hasn't completed initialization.

What if some mediation networks aren't ready when I get the initialization callback?

Google recommends loading an ad inside the bound function of the OnInitializationComplete delegate. 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.

Does the OnUserEarnedReward delegate always get called before the OnDismissed delegate?

For Google ads, OnUserEarnedReward is broadcast before the OnDismissed delegate. For ads served through mediation, the third-party ad network SDK's implementation determines the broadcast order. For ad network SDKs that provide a single close callback with reward information, the mediation adapter invokes OnUserEarnedReward delegate before OnDismissed.

Sample projects