Ad Request Parameters

Information Available via GFPUserParam

You can configure user targeting information through GFPUserParam. (optional)

Providing demographic information (gender, age) and other additional details can improve ad targeting effectiveness. Unlike information passed through GFPAdParam, these are values that remain fixed per user and are configured at the global scope of the app.

GFPUserParam.h reference

• yearOfBirth : Year of birth
• gender : Gender
• userCountryCode : Region code (a different param from "Country")
• userID : User identifier
• contentId : Content ID provided by the Naver Login API

Swift

let userParam = GFPAdManager.userParam() ?? GFPUserParam()
userParam.gender = .female
userParam.yearOfBirth = 1995
userParam.userCountryCode = "KR"
userParam.userID = "abcd"
userParam.contentId = "my-content-id"
GFPAdManager.setUserParam(userParam)

Objective-C

GFPUserParam *userParam;
if (GFPAdManager.userParam != nil) {
    userParam = GFPAdManager.userParam;
} else {
    userParam = [[GFPUserParam alloc] init];
}
userParam.gender = GFPUserParamGenderTypeFemale;
userParam.yearOfBirth = 1995;
userParam.userCountryCode = @"KR";
userParam.userID = @"abcd";
userParam.contentId = @"my-content-id";
[GFPAdManager setUserParam: userParam];

Year of Birth

(optional) An integer value representing the user's year of birth or age.

Swift

let userParam = GFPUserParam()
...
userParam.yearOfBirth = 1995
...

Objective-C

GFPUserParam * userParam = [[GFPUserParam alloc] init];
...
userParam.yearOfBirth = 1995;
...

Country

(optional) The user's nationality (country of residence). Assign a value corresponding to ISO 3166-1 alpha-2.

Swift

let userParam = GFPUserParam()
...
userParam.userCountryCode = "KO"
...

Objective-C

GFPUserParam * userParam = [[GFPUserParam alloc] init];
...
userParam.userCountryCode = @"KR";
...

Gender

(optional) The user's gender.

Select and assign one of the values declared in the GFPUserParamGenderType enum below.

Swift

typedef NS_ENUM(NSInteger, GFPUserParamGenderType) {
    GFPUserParamGenderTypeMale = 1,   // Male
    GFPUserParamGenderTypeFemale = 2, // Female
    GFPUserParamGenderTypeOther = 3,  // Unknown
};

let userParam = GFPUserParam()
...
userParam.gender = .female
...

Objective-C

typedef NS_ENUM(NSInteger, GFPUserParamGenderType) {
    GFPUserParamGenderTypeMale = 1,   // Male
    GFPUserParamGenderTypeFemale = 2, // Female
    GFPUserParamGenderTypeOther = 3,  // Unknown
};

GFPUserParam *userParam = [[GFPUserParam alloc] init];
...
userParam.gender = GFPUserParamGenderTypeFemale;
...

User ID

(optional) Assign the user identifier value used within your service.

Swift

let userParam = GFPUserParam()
...
userParam.userID = "abcd"
...

Objective-C

GFPUserParam * userParam = [[GFPUserParam alloc] init];
...
userParam.userID = @"abcd";
...

Content ID

(optional) Assign the Content ID provided by the Naver Login API. Used for targeted advertising.

Swift

let userParam = GFPUserParam()
...
userParam.contentId = "my-content-id"
...

Objective-C

GFPUserParam *userParam = [[GFPUserParam alloc] init];
...
userParam.contentId = @"my-content-id";
...

Information Available via GFPAdParam

You can pass common information along with ad requests through GFPAdParam. (optional)

Using custom parameters, you can receive reports in GFP Admin or use them to determine how ads are delivered.
Using header bidding parameters, you can utilize header bidding provided by PrebidMobile and APS (Amazon Publisher Services).

GFPAdParam.h reference

• currentPageUrl: URL representing the current page
• keywords : List of keywords describing the content
• referrerPageUrl : Referrer URL
• opt-out : (0: not set, 1: set) (deprecated.)
• customUserParam : Custom parameters you define yourself
• prebidHBParam : PrebidMobile header bidding parameters
• apsParam : Amazon header bidding parameters

Swift

let adParam = GFPAdParam()
adParam.keywords = ["KWD_1", "KWD_2"]
adParam.currentPageUrl = "https://naver.com"
adParam.customUserParam = ["key1":"value1"]

Objective-C

GFPAdParam *adParam = [[GFPAdParam alloc] init];
adParam.keywords = @[@"KWD_1", @"KWD_2"];
adParam.currentPageUrl = @"https://naver.com";
adParam.customUserParam = @{@"key1": @"value1"};

Current Page URL

(optional) The URL of the page representing the current screen.

This value is used as a targeting parameter when making ad requests to external demand (ad networks).

Swift

let adParam = GFPAdParam()
...
adParam.currentPageUrl = "https://naver.com"
...

Objective-C

GFPAdParam *adParam = [[GFPAdParam alloc] init];
...
adParam.currentPageUrl = @"https://naver.com";
...

Keyword

(optional) Keywords related to the current screen. Multiple keywords can be assigned as an Array<String>.

This value is used as a targeting parameter when making ad requests to external demand.

Swift

let adParam = GFPAdParam()
...
adParam.keywords = ["KWD_1", "KWD_2"]
...

Objective-C

GFPAdParam *adParam = [[GFPAdParam alloc] init];
...
adParam.keywords = @[@"KWD_1", @"KWD_2"];
...

Custom User Parameter

(optional) A parameter used in GFP admin for detailed targeting and reporting.

Set it as a dictionary where both keys and values are strings.

Swift

let adParam = GFPAdParam()
...
adParam.customUserParam = ["key1":"value1", "language":"ko"]
...

Objective-C

GFPAdParam *adParam = [[GFPAdParam alloc] init];
...
adParam.customUserParam = @{@"key1": @"value1", @"language":@"ko"};
...

Header Bidding Parameter

(Optional) Use header bidding parameters to utilize header bidding provided by PrebidMobile and APS (Amazon Publisher Services).

• prebidHBParam
  • Set the information obtained through PrebidMobile.
  • A dictionary where both keys and values are strings.
• apsParam (see GFPAPSAdParam)
  • Set the information obtained through APS. (crid, size, apsHBParam)

info

For information on how to configure header bidding parameters using PrebidMobile and APS, refer to Header Bidding.

Ad Request Query

You can obtain the query related to an ad request using the adCallQuery method of the GFPAdParam object.

Swift

let adParam = GFPAdParam()
...
let query = adParam.adCallQuery(with: "adUnitId")
...

Objective-C

GFPAdParam *adParam = [[GFPAdParam alloc] init];
...
NSString *query = [adParam adCallQueryWith:@"adUnitId"];
...