Rewarded

This article will go through all the steps required to display a Rewarded ad in your application.

Rewarded ads are skippable fullscreen ads. They allow you to reward users with in-app items for watching ads.

Rewarded ads can only be served to users who explicitly and previously chose to view a rewarded ad. You can specify the reward values associated with the ad units in your application and set different rewards for different ad units.

Prerequisites

Ensure your application is registered on the Ogury Dashboard. If not, please refer to the Getting Started page before proceeding.

Step 1: Create a Rewarded ad unit

• Create a Rewarded ad unit on your asset page in the Ogury Dashboard.

• Copy the ad unit ID, as you will need it for integration. It is in the form of a UUID, which consists of a 36-character string formatted as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where each x represents a hexadecimal digit.

In the following code samples, this ad unit ID will be represented as xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Step 2: Load a Rewarded ad

To load a Rewarded ad, instantiate an OguryRewardedAd object and call its load() method.

Swift

import UIKit
import OguryAds

class ViewController: UIViewController {
    private(set) var rewardedAd: OguryRewardedAd!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        rewardedAd = OguryRewardedAd(adUnitID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
        rewardedAd.load()
    }
}

Objective-C

#import "ViewController.h"
#import <OguryAds/OguryAds.h>

@interface ViewController ()
@property (nonatomic, retain) OguryRewardedAd *rewardedAd;
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    self.rewardedAd = [[OguryRewardedAd alloc] initWithAdUnitId:@"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"];
    [self.rewardedAd load];  
}

@end

OguryRewardedAd requires the following parameter:

• adUnitID: the ad unit ID for the Rewarded ad. If you do not have one, please refer to the first step to create it.

If you are developing a mediation adapter, you must pass an additional parameter, OguryMediation which should be instantiated with:

• name: the name of the mediation.

• version: the version of the mediation SDK.

Swift

self.rewardedAd = OguryRewardedAd(
    adUnitId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    mediation: OguryMediation(name: "your mediation name", 
                              version: "your mediation SDK version")
)

Objective-C

OguryMediation *mediation = [[OguryMediation alloc] initWithName:@"your mediation name" version:@"your mediation SDK version"];
self.rewardedAd = [[OguryRewardedAd alloc] initWithAdUnitId:@"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" mediation:mediation];

Step 3: Register for callbacks

You can monitor the lifecycle of your Rewarded ad by implementing the OguryRewardedAdDelegate protocol. This delegate provides real-time updates on key events, such as successful ad loading, display, reward or errors.

To use it, set your class as the delegate of OguryRewardedAd and implement the necessary methods. This ensures timely notifications, allowing you to manage the ad experience effectively.

If the rewardedAd:didFailWithError: callback is triggered, refer to the Error handling section below for detailed information on troubleshooting.

The rewardedAd:didReceive: callback specifically allows you to handle the rewards given to users after they interact with the ad. The reward name and value can be set in the Reward Settings section of your ad unit on the Ogury Dashboard.

Swift

override func viewDidLoad() {
    super.viewDidLoad()
    rewardedAd = OguryRewardedAd(
        adUnitID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    )
    rewardedAd.delegate = self
    rewardedAd.load()
}

// Called when the ad is loaded and ready to be shown
func rewardedAdDidLoad(_ rewardedAd: OguryRewardedAd) {
    // Call show() to display the ad
}

// Called when an impression is recorded
func rewardedAdDidTriggerImpression(_ rewardedAd: OguryRewardedAd) {
    // Track ad performance here
}

// Called when the user clicks on the ad
func rewardedAdDidClick(_ rewardedAd: OguryRewardedAd) {
    // Handle ad click tracking here
}

// Called when the ad is closed
func rewardedAdDidClose(_ rewardedAd: OguryRewardedAd) {
    // Resume app flow after ad is closed
}

// Called when the reward is granted
func rewardedAd(_ rewardedAd: OguryRewardedAd, didReceive reward: OguryReward) {
}

// Called when the ad fails to load or display
func rewardedAd(_ rewardedAd: OguryRewardedAd, 
      didFailWithError error: OguryAdError) {
    switch error.type {
        case .load:
            // Handle loading error
        case .show:
            // Handle display error
    }
}

Objective-C

 - (void)viewDidLoad {
    [super viewDidLoad];
    self.rewardedAd = [[OguryRewardedAd alloc] initWithAdUnitID:@"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"];
    [self.rewardedAd load];
}

// Called when the ad is loaded and ready to be shown
- (void)rewardedAdDidLoad:(OguryRewardedAd *)rewardedAd {
    // call [interstitialAd show] to display the ad
}

// Called when an impression is recorded
- (void)rewardedAdDidTriggerImpression:(OguryRewardedAd *)rewardedAd { {
    // Track ad performance here
}

// Called when the user clicks on the ad
- (void)rewardedAdDidClick:(OguryRewardedAd *)rewardedAd {
    // Handle ad click tracking here
}

// Called when the ad is closed
- (void)rewardedAdDidClose:(OguryRewardedAd *)rewardedAd {
    // Resume app flow after ad is closed
}

// Called when the reward is granted
- (void)rewardedAd:(OguryRewardedAd *)rewardedAd 
        didReceive:(OguryReward *)reward {
}
  
// Called when the ad fails to load or display
- (void)rewardedAd:(OguryRewardedAd *)rewardedAd 
  didFailWithError:(OguryAdError *)error {
    switch (error.type) {
        case OguryAdErrorTypeLoad:
            // Handle loading error
        case OguryAdErrorTypeShow:
            // Handle display error
    }
}

Step 4: Show a Rewarded Ad

To display a loaded Rewarded ad, invoke the show() method on the instantiated OguryRewardedAd object.

Swift

if rewardedAd.isLoaded {
    // The ad is loaded and ready to be displayed.
    rewardedAd.show(in: self)
} else {
    // The ad is not loaded yet. Handle this situation appropriately.
}

Objective-C

if (self.rewardedAd.isLoaded) {
    [self.rewardedAd showAdInViewController:self];
}

The show() method requires the following parameter:

• A reference to the ViewController where the Rewarded ad will be presented.

Always verify that the ad is loaded before invoking the show() method, particularly if you are not calling it from the rewardedAdDidLoad callback.

Step 5: Test your integration

After registering your app, it may take up to 15 minutes before ads are available.

Ogury exclusively serves ads to users who have provided their consent. Before conducting any tests, it is essential to ensure that your implementation complies with applicable privacy regulations. For more information on the regulations supported by Ogury, please visit the Privacy compliance page.

Since our algorithm uses personalized targeting, you may not receive ads during testing. To obtain test ads, you can append _test to your Rewarded ad unit ID in the code, for example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx_test.

For further details on test mode and enabling debug logs, please refer to the Test your implementation page.

Advanced topics

Error handling

If you are unable to load or display any Rewarded ads, we recommend logging callbacks from the OguryRewardedAdDelegate to monitor the ad's lifecycle, especially the rewardedAd:didFailWithError: callback. This method provides an an OguryAdError instance containing important error details:

• type: indicates the error type through the OguryAdErrorType enum, which distinguishes between loading errors (OguryAdErrorTypeLoad) and showing errors (OguryAdErrorTypeShow).

• code: An integer that identifies the specific error. The enums OguryLoadErrorCode and OguryShowErrorCode define potential error codes that may occur during loading or showing ads. Further details on these enums are provided in the tables below.

• localizedDescription: A descriptive message that provides additional context about the error.

You can utilize these details to diagnose the issue and take appropriate action to resolve it.

OguryLoadErrorCode

Enum value	Description
SDKNotStarted	The load could not proceed because the SDK appears to have not been started, as no asset key was found.
SDKNotProperlyInitialized	The load could not proceed because the SDK is not properly initialized.
NoActiveInternetConnection	The load could not proceed because there is no active Internet connection.
InvalidConfiguration	The load could not proceed due to an invalid SDK configuration.
AdDisabledCountryNotOpened	The load could not proceed because ads are disabled; the user’s country is not yet available for advertising.
AdDisabledConsentDenied	The load could not proceed because ads are disabled; the user has denied consent for advertising.
AdDisabledConsentMissing	The load could not proceed because ads are disabled; the user consent is missing or has not been provided.
AdDisabledUnspecifiedReason	The load could not proceed because ads are disabled for an unspecified reason.
AdRequestFailed	The load failed because the ad request encountered an error, and the server returned an unexpected response.
NoFill	No ad is currently available for this placement (no fill).
AdParsingFailed	The ad could not be loaded due to a failure in parsing.
AdPrecachingFailed	The ad could not be loaded due to a failure in ad precaching.
AdPrecachingTimeout	The ad could not be loaded as precaching exceeded the time limit and timed out.

OguryShowErrorCode

Enum value	Description
SDKNotStarted	The ad could not be displayed because the SDK appears to have not been started, as no asset key was found.
SDKNotProperlyInitialized	The ad could not be displayed because the SDK is not properly initialized.
NoActiveInternetConnection	The ad could not be displayed because there is no active Internet connection.
InvalidConfiguration	The ad could not be displayed due to an invalid SDK configuration.
AdDisabledCountryNotOpened	The ad could not be displayed because ads are disabled; the user’s country is not yet available for advertising.
AdDisabledConsentDenied	The ad could not be displayed because ads are disabled; the user has denied consent for advertising.
AdDisabledConsentMissing	The ad could not be displayed because ads are disabled; the user consent is missing or has not been provided.
AdDisabledUnspecifiedReason	The ad could not be displayed because ads are disabled for an unspecified reason.
AdExpired	The ad could not be displayed because the retention time of the loaded ad has expired.
NoAdLoaded	No ad has been loaded.
ViewInBackground	The ad could not be displayed because the application was running in the background.
AnotherAdAlreadyDisplayed	The ad could not be displayed because another ad is currently being displayed.
WebviewTerminatedBySystem	The ad could not be displayed because the WebView was terminated by the system, resulting in the ad being unloaded due to high resource consumption by the application.
ViewControllerPreventsAdFromBeingDisplayed	The ad could not be displayed because a ViewController is currently being presented, preventing the ad from displaying.