Getting Started

Supported Versions

iOS 13.0 or later
Xcode 12.0 or later

danger

Starting from NAMSDK 4.3.0, Xcode 12.0 or later is required (supports iOS 14 or later).

danger

Starting from NAMSDK 6.0.0, Xcode 14.1 or later is required when using Google DFP.

Starting from NAMSDK 7.0.0, Xcode 15 or later is required when using Unity or IronSource.

Adding Cocoapods Dependencies

Add 'NAMSDK' to your Podfile.

Add the Mediation Pods for the ad networks you plan to use.

target 'MyApplication' do
    pod 'NAMSDK'                        # SDK Core
    pod 'NAMSDK/MediationNDA'           # Naver in-house Banner & Native Ads
    pod 'NAMSDK/MediationNDAVideo'      # Naver in-house Video Ads
    pod 'NAMSDK/MediationNDARich'       # Naver in-house Premium Ads (requires 7.2.0>=)

    pod 'NAMSDKMediationDFP'           # Google DFP         (since 8.0.0)
    pod 'NAMSDKMediationFAN'           # Facebook FAN       (since 8.0.0)
    pod 'NAMSDKMediationInMobi'        # InMobi             (since 8.0.0)
    pod 'NAMSDKMediationUnity'         # Unity              (since 8.0.0)
    pod 'NAMSDKMediationAppLovin'      # AppLovin           (since 8.0.0)
    pod 'NAMSDKMediationVungle'        # Vungle             (since 8.0.0)
    pod 'NAMSDKMediationDT'            # Digital Turbine    (since 8.0.0)
    pod 'NAMSDKMediationIronSource'    # Iron Source        (since 8.0.0)
    pod 'NAMSDKMediationAPS'           # APS                (since 8.0.0)
    pod 'NAMSDKMediationLAN'           # LAN                (since 8.0.0)
end

List of In-house Ads

Ad Network	Supported Ad Type	Cocoapods Settings
NAVER	Banner, Native	`pod NAMSDK/MediationNDA`
NAVER	Video	`pod NAMSDK/MediationNDAVideo`
NAVER	Native Rich Reward	`pod NAMSDK/MediationNDARich`

List of Mediated Ad Networks

Ad Network	Supported Ad Type	Cocoapods Settings
Google DFP	Banner, Native, Interstitial, Reward	`pod NAMSDKMediationDFP`
Google IMA	Video	`pod NAMSDKMediationIMA`
Facebook	Banner, Native, Interstitial, Reward	`pod NAMSDKMediationFAN`
InMobi	Banner, Native	`pod NAMSDKMediationInMobi`
Unity	Banner, Interstitial, Reward	`pod NAMSDKMediationUnity`
AppLovin	Banner, Native, Interstitial, Reward	`pod NAMSDKMediationAppLovin`
Vungle	Interstitial, Reward	`pod NAMSDKMediationVungle`
DigitalTurbine	Banner, Interstitial, Reward	`pod NAMSDKMediationDT`
IronSource	Interstitial, Reward	`pod NAMSDKMediationIronSource`
APS	Reward	`pod NAMSDKMediationAPS`
LAN	Native, Interstitial, Reward	`pod NAMSDKMediationLAN`

info

See the up-to-date list of available ad networks in GFPProviderOptions.swift

GFPBannerProviderOption
GFPVideoProviderOption
GFPNativeProviderOption
GFPCombinedProviderOption
GFPRewardedAdProviderOption
GFPInterstitialAdProviderOption

App Transport Security (ATS) settings

App Transport Security (ATS) has been introduced in iOS 9 which allows apps to make network requests over HTTPS by default.

In order to allow ad requests to external ad networks over HTTP, add following value to your Info.plist.

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

Requirements while linking with Google DFP

To link Google DFP, add the following values to your Info.plist.

Otherwise, you will get “The Google Mobile Ads SDK was initialized incorrectly” error message with the operation suspended.

<key>GADIsAdManagerApp</key>
<true/>

danger

To apply Google DFP >= 10, follow addtional steps in the reference below.

https://developers.google.com/ad-manager/mobile-ads-sdk/ios/migration?hl=en#requirement_of_ad_manager_app_id

Importing NAMSDK

First, import GFPSDK.

Swift
Objective-C

import GFPSDK

@import GFPSDK;

GFPAdManager

Initializing Ad Networks

GFP SDK must be initialized prior to requesting ads, once, in your app's life cycle.
Ad networks added in your Podfile will be automatically initialized with the GFP SDK.
- Note that ads from networks not included in your Podfile will fail to render, even if a valid ad response is received.
To initialize GFPAdManager, pass Publisher Code (required) which is registered in GFP dashboard.
Pass Service Code (optional) to manage multiple apps separately.
You can validate initialization by isSdkInitialized property.

tip

For NAMSDK >= 7.3.0 the new ServiceCd is available for initializing SDK. Use ServiceCd (optional) with PublisherCd (required) when managing multiple apps of a same publisher.

See more information about initialization in GFPAdManager.h.

Swift
Objective-C

import GFPSDK

// 1. Example of initializing without GFPAdConfiguration, with a PublisherCd.
GFPAdManager.setup(withPublisherCd: "publisherCd" target:self) { (error : GFPError?) in
    print("Setup Error: \(String(describing: error?.description))")
}

// 2. Example of initializing without GFPAdConfiguration, with PublisherCd & ServiceCd.
GFPAdManager.setup(withPublisherCd: "publisherCd", serviceCd: "serviceCd", target: self) { error in
    print("Setup Error: \(String(describing: error?.description))")
}

// Check for initialization success.
GFPAdManager.isSdkInitialized()

// Initializing with GFPAdConfiguration: set test mode, request timeouts, log levels, ad redering time, etc.
let configuration = GFPAdConfiguration()
GFPAdManager.setup(withPublisherCd: nil, serviceCd: "serviceCd", target:self configuration: configuration) { (error : GFPError?) in
    print("Setup Error: \(String(describing: error?.description))")
}

@import GFPSDK;

// 1. Example of initializing without GFPAdConfiguration, with a PublisherCd.
[GFPAdManager setupWithPublisherCd:@"publisherCd" target:self completionHandler:^(GFPError * _Nullable error) {
    NSLog(@"Setup Error: %@", error);
}];

// 2. Example of initializing without GFPAdConfiguration, with PublisherCd & ServiceCd.
[GFPAdManager setupWithPublisherCd:@"publisherCd" serviceCd:@"serviceCd" target:self completionHandler:^(GFPError * _Nullable error) {
    NSLog(@"Setup Error: %@", error);
}];

// Check for initialization success.
[GFPAdManager isSdkInitialized];

// Initializing with GFPAdConfiguration: set test mode, request timeouts, log levels, ad redering time, etc.
GFPAdConfiguration *configuration = [[GFPAdConfiguration alloc] init];

[GFPAdManager setupWithPublisherCd:@"publisherCd" serviceCd:@"serviceCd" configuration:configuration target:self completionHandler:^(GFPError * _Nullable error) {
    NSLog(@"Setup Error: %@", error);
}];

GFPAdManagerDelegate

danger

For NAMSDK >= 3.1.3, you must provide GFPAdManagerDelegate to GFPAdManager.

Implement ad tracking mechanism of your app using Apple ATTrackingManager and provide tracking status to GFPAdManagerDelegate

@protocol GFPAdManagerDelegate <NSObject>

- (GFPATTAuthorizationStatus)attStatus;

@end

typedef NS_ENUM(NSInteger, GFPATTAuthorizationStatus) {
    GFPATTAuthorizeNotDetermined = 0, // = ATTrackingManager.AuthorizationStatus.notDetermined
    GFPATTAuthorizeRestricted,        // = ATTrackingManager.AuthorizationStatus.restricted
    GFPATTAuthorizeDenied,            // = ATTrackingManager.AuthorizationStatus.denied
    GFPATTAuthorizeAuthorized         // = ATTrackingManager.AuthorizationStatus.authorized
};

Swift
Objective-C

func attStatus() -> GFPATTAuthorizationStatus {
    if #available(iOS 14, *) {
        switch ATTrackingManager.trackingAuthorizationStatus {
                case .notDetermined: return .authorizeNotDetermined
                case .restricted: return .authorizeRestricted
                case .denied: return .authorizeDenied
                case .authorized: return .authorizeAuthorized
                
                default: print("value is invalid."); return .authorizeNotDetermined
        }
    } else {
        if ASIdentifierManager.shared().isAdvertisingTrackingEnabled {
            return GFPATTAuthorizeAuthorized
        }

        return GFPATTAuthorizeNotDetermined
    }
}

- (GFPATTAuthorizationStatus)attStatus {
     if (@available(iOS 14.5, *)) {
        switch (ATTrackingManager.trackingAuthorizationStatus) {
            case ATTrackingManagerAuthorizationStatusNotDetermined:
                return GFPATTAuthorizeNotDetermined;
            case ATTrackingManagerAuthorizationStatusRestricted:
                return GFPATTAuthorizeRestricted;
            case ATTrackingManagerAuthorizationStatusDenied:
                return GFPATTAuthorizeDenied;
            case ATTrackingManagerAuthorizationStatusAuthorized:
                return GFPATTAuthorizeAuthorized;
        }
    } else {
        if ([[ASIdentifierManager sharedManager] isAdvertisingTrackingEnabled]) {
            return GFPATTAuthorizeAuthorized;
        }
        
        return GFPATTAuthorizeNotDetermined;
    }
}

Registering WebViews

Starting from SDK 8.2.0, it is required to register any WKWebViews used in the app with our manager.

Follow instructions in Registering WebViews

Available settings in GFPAdConfiguration

Banner ad request timeout (default: 60 seconds)
Video ad request timeout (default: 60 seconds)
Native ad request timeout (default: 60 seconds)
Integrated ad request timeout (default: 60 seconds)
Rewarded ad request timeout (default: 60 seconds)
Interstitial ad request timeout (default: 60 seconds)
DFP test ad setting (default: NO)
FAN test ad setting (default: NO)
NAMSDK log level settings (default: no logs)
Enable default user agent (default: NO)
Ad interface style settings (default: Light)
Disable crash report external ad network SDKs (default: NO)
Global customUserParam settings
Mute audio by default for rewarded video ads (applies to Naver and most of other ad network ads) (default: YES)
Language settings for advertising UI components (default: none)
Disable ADID colletion option (default: NO)
Using Default In APP Browser Landing option (default: NO)

Ad language settings

Language settings for advertising UI components (default: none). However, this applies only to advertisements served through s2s.

Supported languages: Korean, English, Thai, French, Spanish, Indonesian, Simplified/Traditional Chinese, Japanese, German

If set to 'none', ads will be rendered based on the device's language. For unsupported languages, English will be displayed by default.

info

Set this before loading ads. Changes made afterward won’t affect ads already loaded. The new language setting will only apply to ads loaded after the change.

Swift
Objective-C

GFPAdManager.adConfiguration().preferredLanguage = .ko

[GFPAdManager adConfiguration].preferredLanguage = GFPLanguageType_ko;

You can also setup Naver user identifiers with GFPAdManager.

Swift
Objective-C

let cookie = ["key1": "value1", "key2": "value2"]
GFPAdManager.setCookie(cookie)
        
GFPAdManager.appendCookie(["key3":"value3"])        

GFPAdManager.clearCookie()

NSDictionary <NSString *, NSString *> *cookie = @{@"key1": @"value1", @"key2": @"value2"};
[GFPAdManager setCookie:cookie];

[GFPAdManager appendCookie: @{@"key3": @"value3"}];

[GFPAdManager clearCookie];

Test Mode Settings

You can enable test modes, which restrict ad delivery to non-commercial test ads from certain ad networks.

Supports Google and Facebook test modes.

See more information about test modes in GFPAdProviderSetting.h

Interface Styles

Interface Style changes "AdMute" icon at the corner of ad, according to user device's theme settings.

Swift
Objective-C

GFPAdManager.adConfiguration().adInterfaceStyle = .light
GFPAdManager.adConfiguration().adInterfaceStyle = .dark
GFPAdManager.adConfiguration().adInterfaceStyle = .system

[GFPAdManager adConfiguration].adInterfaceStyle = GFPAdInterfaceStyleLight;
[GFPAdManager adConfiguration].adInterfaceStyle = GFPAdInterfaceStyleDark;
[GFPAdManager adConfiguration].adInterfaceStyle = GFPAdInterfaceStyleSystem;

Global CustomParam Settings

(GFP SDK >= 6.0.0) Some apps might be advised to set CustomParams for better algorithm.
Set CustomParam in a form of dictionary of both key and value strings.

info

For dictionary values that must contain mutiple values should separate them with "|" letter (not array of strings).
GFPAdParam.customUserParam is prioritized over GFPAdConfiguration.customParam

Swift
Objective-C

GFPAdManager.adConfiguration().customParam = ["key1": "value1", "key2": "value2", "key3":"a|b|c"]

[GFPAdManager adConfiguration].customParam = @{@"key1": @"value1", @"key2": @"value2", @"key3":@"a|b|c"};

A/B Test Parameters

(GFP SDK >= 6.5.0) Some Naver apps that demands A/B Test can use abt param.

Swift
Objective-C

let abt = "SUBS:V0;HOME:V2;NEWS:V1"
let configuration = GFPAdManager.adConfiguration
configuration.abt = abt
GFPAdManager.adConfiguration = configuration

NSString *abt = @"SUBS:V0;HOME:V2;NEWS:V1";
GFPAdConfiguration *configuration = GFPAdManager.adConfiguration;
configuration.abt = abt;
GFPAdManager.adConfiguration = configuration;

Deprecated

Adding Cocoapods Dependencies (until 7.x.x)

Add 'NAMSDK' to your Podfile.

Add the Mediation Pods for the ad networks you plan to use.

target 'MyApplication' do
    pod 'NAMSDK'                        # 
    pod 'NAMSDK/MediationNDA'           # Naver Banner & Native ads
    pod 'NAMSDK/MediationNDAVideo'      # Naver Video ads (requires >= 4.3.0)
    pod 'NAMSDK/MediationNDARich'       # Naver Premium ads (requires >= 7.2.0)
    pod 'NAMSDK/MediationDFP'           
    pod 'NAMSDK/MediationIMA'           
    pod 'NAMSDK/MediationFAN'           
    pod 'NAMSDK/MediationInMobi'        
    pod 'NAMSDK/MediationUnity'         
    pod 'NAMSDK/MediationAppLovin'      
    pod 'NAMSDK/MediationVungle'        
    pod 'NAMSDK/MediationDT'            # (requires >= 6.4.0)
    pod 'NAMSDK/MediationIronSource'    # (requires >= 7.0.0)
    pod 'NAMSDK/MediationAPS'           # (requires >= 7.2.0)
    pod 'NAMSDK/MediationLAN'           # (requires >= 7.7.0)
end

List of Supported Ad Networks (until 7.x.x)

Ad Network	Supported Ad Type	Cocoapods Settings
NAVER	Banner, Native	`pod NAMSDK/MediationNDA`
NAVER	Video	`pod NAMSDK/MediationNDAVideo`
NAVER	Native Rich Reward	`pod NAMSDK/MediationNDARich`
Google DFP	Banner, Native, Interstitial, Reward	`pod NAMSDK/MediationDFP`
Google IMA	Video	`pod NAMSDK/MediationIMA`
Facebook	Banner, Native, Interstitial, Reward	`pod NAMSDK/MediationFAN`
InMobi	Banner, Native	`pod NAMSDK/MediationInMobi`
Unity	Banner, Interstitial, Reward	`pod NAMSDK/MediationUnity`
AppLovin	Banner, Native, Interstitial, Reward	`pod NAMSDK/MediationAppLovin`
Vungle	Interstitial, Reward	`pod NAMSDK/MediationVungle`
DigitalTurbine	Banner, Interstitial, Reward	`pod NAMSDK/MediationDT`
IronSource	Interstitial, Reward	`pod NAMSDK/MediationIronSource`
APS	Reward	`pod NAMSDK/MediationAPS`
LAN	Native, Interstitial, Reward	`pod NAMSDK/MediationLAN`

Contact NAM SDK iOS Developers

Supported Versions​

Adding Cocoapods Dependencies​

List of In-house Ads​

List of Mediated Ad Networks​

App Transport Security (ATS) settings​

Requirements while linking with Google DFP​

Importing NAMSDK​

GFPAdManager​

Initializing Ad Networks​

GFPAdManagerDelegate​

Registering WebViews​

Available settings in GFPAdConfiguration​

Ad language settings​

Advertising Cookie settings​

Test Mode Settings​

Interface Styles​

Global CustomParam Settings​

A/B Test Parameters​

Deprecated​

Adding Cocoapods Dependencies (until 7.x.x)​

List of Supported Ad Networks (until 7.x.x)​

Supported Versions

Adding Cocoapods Dependencies

List of In-house Ads

List of Mediated Ad Networks

App Transport Security (ATS) settings

Requirements while linking with Google DFP

Importing NAMSDK

GFPAdManager

Initializing Ad Networks

GFPAdManagerDelegate

Registering WebViews

Available settings in GFPAdConfiguration

Ad language settings

Advertising Cookie settings

Test Mode Settings

Interface Styles

Global CustomParam Settings

A/B Test Parameters

Deprecated

Adding Cocoapods Dependencies (until 7.x.x)

List of Supported Ad Networks (until 7.x.x)