library-core/com.naver.gfpsdk/AdParam

AdParam

class AdParam : Serializable

Parameters for an ad request, including targeting, deduplication, and video ad settings. Use Builder to create an instance.

Types

class Builder : Serializable

Builder for creating AdParam instances.

interface Callback

Callback for fetchAdCallQuery results.

object Companion

Properties

adDuplicationKeys

val adDuplicationKeys: MutableSet<String>

Ad deduplication keys collected from WF AdCallResponse. Used by GfpDedupeManager to filter duplicate ads.

val adUnitId: String?

advertiserDomains

val advertiserDomains: MutableSet<String>

Advertiser domains collected from WF AdCallResponse. Used by GfpDedupeManager to prevent duplicate exposure from the same advertiser.

var apsParam: GfpApsAdParam?

val builder: AdParam.Builder

val customParam: Map<String, String>

val keywords: Set<String>

val prebidParam: Map<String, String>

val userToken: String?

val vcl: Long?

Video content length in milliseconds (the main content length, not the ad length).

val vri: String?

Video request identifier for tracking individual video ad requests.

val vrr: Int?

Flag indicating whether a reminder ad is requested for this video.

val vsd: Long?

Video start delay in milliseconds before the ad begins playback.

val vsi: String?

Video schedule identifier used to group related video ad requests.

Functions

fun buildUpon(): AdParam.Builder

Creates a new Builder pre-populated with this instance's parameters.

fetchAdCallQuery

fun fetchAdCallQuery(context: Context, callback: AdParam.Callback)

Fetches the ad call query asynchronously in a background thread. The result includes all parameters such as Advertising ID, App Set ID, and mediation provider signals.

getAdCallQueryWithoutAsyncParams

fun getAdCallQueryWithoutAsyncParams(): String

Returns the ad call query without asynchronously collected parameters. This method returns immediately without waiting for:

getApsParameter

fun getApsParameter(): String

Returns APS parameters as a string in "key:value,key:value,..." format. Multiple values for a single key are delimited by '|' (e.g., "key:value1|value2").

fun getContentInfo(): GfpContentInfo?

Returns the content information associated with this ad request.

getCurrentPageUrl

fun getCurrentPageUrl(): String

Returns the current page URL encoded via Uri.encode.

fun getCurrentPageUrl(isEncodingNeeded: Boolean): String

Returns the current page URL, optionally encoded via Uri.encode.

getPrebidParameter

fun getPrebidParameter(): String

Returns prebid parameters as a URI-encoded string in "key:value,key:value,..." format. Both keys and values are encoded via Uri.encode.

getRefererPageUrl

fun getRefererPageUrl(): String

Returns the referer page URL encoded via Uri.encode.

fun getRefererPageUrl(isEncodingNeeded: Boolean): String

Returns the referer page URL, optionally encoded via Uri.encode.

fun ~~setApsParam~~(apsParam: GfpApsAdParam?)