Getting Started

Rewarded ads are full-screen video ads that reward viewers for watching the ad.

Prerequisites

• Getting Started
• Ad Request Parameters

Adding Dependencies

To use rewarded ads, add the GFPSDK/MediationNDARich module to your Podfile.

# When using static library
pod 'GFPSDK/MediationNDARich'

# When using dynamic library
pod 'GFPSDK-Dynamic/MediationNDARich'

NAMSDK Import

Import the SDK module.

Swift

import GFPSDK

Objective-C

@import GFPSDK;

Initializing C2S Rewarded Ad Providers

With the Pod for the rewarded ad provider you want to integrate added to your project, initialize via GFPAdManager. (Perform only once when the app launches)

Provider Option	Ad Provider	CocoaPods
GFPRewardedAdProviderOptionNDA	Naver NDA	pod 'GFPSDK/MediationNDA'
GFPRewardedAdProviderOptionDFP	Google GAM (Google Ad Manager)	pod 'GFPSDKMediationDFP'
GFPRewardedAdProviderOptionFAN	Meta Audience Network	pod 'GFPSDKMediationFAN'
GFPRewardedAdProviderOptionUnity	Unity Ads	pod 'GFPSDKMediationUnity'
GFPRewardedAdProviderOptionAppLovin	AppLovin MAX	pod 'GFPSDKMediationAppLovin'
GFPRewardedAdProviderOptionVungle	Liftoff (Vungle)	pod 'GFPSDKMediationVungle'
GFPRewardedAdProviderOptionDT	Digital Turbine	pod 'GFPSDKMediationDT'
GFPRewardedAdProviderOptionIS	IronSource	pod 'GFPSDKMediationIronSource'
GFPRewardedAdProviderOptionAPS	Amazon Publisher Services	pod 'GFPSDKMediationAPS'
GFPRewardedAdProviderOptionLAN	LINE Ads Network	pod 'GFPSDKMediationLAN'
GFPRewardedAdProviderOptionChartBoost	Chartboost	pod 'GFPSDKMediationChartBoost'
GFPRewardedAdProviderOptionBidMachine	BidMachine	pod 'GFPSDKMediationBidMachine'
GFPRewardedAdProviderOptionPangle	Pangle	pod 'GFPSDKMediationPangle'

info

S2S rewarded ads do not require a separate provider initialization.

Swift

// DFP, Facebook 보상형 광고를 연동하려는 경우 cocoapods 의존성 추가.
GFPAdManager.setup(withPublisherCd: "publisherCd") { (error : GFPError?) in
    print("Setup Eror: \(String(describing: error?.description))")
}

Objective-C

// DFP, NDA, Inmobi, Facebook 배너 광고를 연동하려는 경우 cocoapods 의존성 추가.
[GFPAdManager setupWithPublisherCd:@"publisherCd" completionHandler:^(GFPError * _Nullable error) {
    NSLog(@"Setup ERROR: %@", error);
}];

tip

For detailed GFPAdManager configuration, refer to Ad Manager Settings.

Writing the View Controller

Create a view controller (MyViewController) and perform the following steps in the header file (MyViewController.h).
(In this example, the view controller owns the manager.)

1. Declare a *GFPRewardedAdManager adManager property in the view controller.
2. Implement the GFPRewardedAdManagerDelegate protocol in the view controller.

GFPRewardedAdManagerDelegate delivers load success/failure and click events for rewarded ads.

Swift

// MyViewController.h
import GFPSDK

class MyViewController : UIViewController, GFPRewardedAdManagerDelegate {
    private var adManager : GFPReweardedAdManager?
}

Objective-C

// MyViewController.h

@import GFPSDK;

@interface MyViewController : UIViewController <GFPRewardedAdManagerDelegate>

@property (nonatomic) GFPRewardedAdManager *adManager;

@end

GFPReweardedAdManager Usage Guide

Creating GFPReweardedAdManager and Requesting Ad Load

In the viewDidLoad method of MyViewController.m, create an instance of GFPReweardedAdManager and request an ad.

• After creating the instance, make sure to set the delegate.
• When creating a GFPReweardedAdManager instance, set user information in GFPAdParam along with your issued ad unit ID. GFPAdParam is used for targeting to improve ad effectiveness.

Swift

override func viewDidLoad() {
    super.viewDidLoad()
        
    let adParam = GFPAdParam()
    adParam.yearOfBirth = 1990
    adParam.gender = .male
    ...
    
    //인스턴스 생성    
    self.adManager = GFPRewardedAdManager(unitID: "UnitID", adParam: adParam)
    //Delegate
    self.adManager?.delegate = self
    //Timeout
    self.adManager?.requestTimeoutInterval = 60
    //광고 요청
    self.adManager?.load()
}

Objective-C

- (void)viewDidLoad {
    [super viewDidLoad];

    GFPAdParam *adParam = [[GFPAdParam alloc]init];
    adParam.yearOfBirth = 1990;
    adParam.gender = GFPAdParamGenderTypeMale;
    ...

	//인스턴스 생성
    self.adManager = [[GFPRewardedAdManager alloc] initWithUnitID:@"UnitID" adParam:adParam];               
    //Delegate
    self.adManager.delegate = self;
    //Timeout
    self.adManager.requestTimeoutInterval = 60;
    //광고 요청
    [self.adManager load];

}

tip

The manager is designed to be used for loading a single ad. Create a new manager each time you need to load a new ad.

tip

On successful ad request, the GFPRewardedAdManagerDelegate rewardedAdManager:didLoadAd: method is called.

Resuming a Rewarded Ad Video

To resume a rewarded ad video after pausing it, use the resumeCurrentRewardVideo class method.

Swift

GFPRewardedAdManager.resumeCurrentRewardVideo()

Objective-C

[GFPRewardedAdManager resumeCurrentRewardVideo];

Requesting Ad Display

Once you receive a success response from GFPRewardedAdManagerDelegate rewardedAdManager:didLoadAd:, you can request ad display using the show:(UIViewController *) method.

Checking Ad Load Completion

Use the isAdLoaded property to check whether an ad has been successfully loaded.

Swift

if self.adManager?.isAdLoaded == true {
    // The ad is in a loaded state.
}

Objective-C

if (self.adManager.isAdLoaded) {
    // The ad is in a loaded state.
}

Checking Ad Invalidation

When displaying a pre-loaded cached ad, you must use the isAdInvalidate method to verify that the ad has not expired. Displaying an expired ad will prevent you from receiving a reward for the ad impression.

Swift

if rewardedAd.isAdInvalidate {
    self.adManager?.show(self)
}

Objective-C

if (rewardedAd.isAdInvalidate) {
    [self.adManager show:self];
}

tip

If the ad display request fails, the GFPRewardedAdManagerDelegate rewardedAdManager:didFailWithError:responseInfo: method will be called.

tip

Since ad loading and ad display are separate, you can implement a flow that loads first and then displays. The loaded ad validity period is DFP, FAN: 60 minutes.

GFPRewardedAdManagerDelegate

By implementing GFPRewardedAdManagerDelegate, you can receive rewarded ad events through the following methods.

Load Events

On Load Success

Swift

func rewardedAdManager(_ manager: GFPRewardedAdManager, didLoad rewardedAd: GFPRewardedAd) {
     ...
}

Objective-C

- (void)rewardedAdManager:(nonnull GFPRewardedAdManager *)manager didLoadAd:(nonnull GFPRewardedAd *)rewardedAd {
    ...
}

On Load Failure

Swift

 func rewardedAdManager(_ manager: GFPRewardedAdManager, didFailWithError error: GFPError, responseInfo:GFPLoadResponseInfo!) {
	...   
}
    

Objective-C

- (void)rewardedAdManager:(nonnull GFPRewardedAdManager *)manager didFailWithError:(nonnull GFPError *)error responseInfo:(nullable GFPLoadResponseInfo *)responseInfo {
	...
}

tip

This method delivers not only load failures, but also display failures, expiration errors, and all other failure cases.

LifeCycle Event

When Ad View Screen Starts

Swift

func rewardedAdManager(_ manager: GFPRewardedAdManager, didStart rewardedAd: GFPRewardedAd) {
	...
}

Objective-C

- (void)rewardedAdManager:(nonnull GFPRewardedAdManager *)manager didStartAd:(nonnull GFPRewardedAd *)rewardedAd {
	...
}

On Ad View Completion

Swift

func rewardedAdManager(_ manager: GFPRewardedAdManager, didComplete rewardedAd: GFPRewardedAd, with reward: GFPReward?) {
	...
}    

Objective-C

- (void)rewardedAdManager:(nonnull GFPRewardedAdManager *)manager didCompleteAd:(nonnull GFPRewardedAd *)rewardedAd withReward:(nullable GFPReward *)reward {
	...
}

tip

FAN does not provide reward information, so the reward value will be nil.

When Ad Screen Dismisses

Swift

func rewardedAdManager(_ manager: GFPRewardedAdManager, didClose rewardedAd: GFPRewardedAd) {
	...
}    

Objective-C

- (void)rewardedAdManager:(nonnull GFPRewardedAdManager *)manager didCloseAd:(nonnull GFPRewardedAd *)rewardedAd {
...
}

When Ad Screen is Clicked

Swift

func rewardedAdManager(_ manager: GFPRewardedAdManager, wasClickedAd rewardedAd: GFPRewardedAd) {
	...
}

Objective-C

- (void)rewardedAdManager:(nonnull GFPRewardedAdManager *)manager wasClickedAd:(nonnull GFPRewardedAd *)rewardedAd {
	...
}

tip

DFP versions in the 7.x.x range do not support click events, so this event will not be triggered.

The following methods are declared as @optional, so implement them only when needed.

On Mute State Change (S2S Ads Only)

Called when the player's mute state changes in S2S ads.

Swift

func rewardedAdManager(_ manager: GFPRewardedAdManager, didChangedMute isMuted: Bool) {
    ...
}

Objective-C

- (void)rewardedAdManager:(nonnull GFPRewardedAdManager *)manager didChangedMute:(BOOL)isMuted {
    ...
}

When Ad Impression Occurs

Called when the ad is actually impressed (impression).

Swift

func rewardedAdManagerDidReceiveImpression(_ manager: GFPRewardedAdManager) {
    ...
}

Objective-C

- (void)rewardedAdManagerDidReceiveImpression:(nonnull GFPRewardedAdManager *)manager {
    ...
}

When In-App Browser Opens

Called when the in-app browser opens due to an ad click or similar action.

Swift

func rewardedAdManagerDidPresentDefaultInAppBrowser(_ manager: GFPRewardedAdManager) {
    ...
}

Objective-C

- (void)rewardedAdManagerDidPresentDefaultInAppBrowser:(nonnull GFPRewardedAdManager *)manager {
    ...
}

When In-App Browser Closes

Called when the in-app browser is dismissed.

Swift

func rewardedAdManagerDidDismissDefaultInAppBrowser(_ manager: GFPRewardedAdManager) {
    ...
}

Objective-C

- (void)rewardedAdManagerDidDismissDefaultInAppBrowser:(nonnull GFPRewardedAdManager *)manager {
    ...
}