library-core/com.naver.gfpsdk/AdParam

AdParam

class AdParam : Serializable

Class representing parameters for ad requests. Contains various parameters needed for ad targeting and customization.

Types

class Builder : Serializable

Builder class for creating AdParam instances

interface Callback

Callback interface for ad call query operations

object Companion

Properties

adDuplicationKeys

val adDuplicationKeys: MutableSet<String>

Set of ad duplication keys from WF AdCallResponse. Used in duplication control see {@link GfpDedupeManager}

val adUnitId: String?

The ad unit ID for the ad request

advertiserDomains

val advertiserDomains: MutableSet<String>

Set of advertiser domains from WF AdCallResponse. Used in duplication control see {@link GfpDedupeManager}

var apsParam: GfpApsAdParam?

APS (Amazon Publisher Services) parameters

val builder: AdParam.Builder

val customParam: Map<String, String>

Custom parameters for ad targeting

val keywords: Set<String>

Keywords for ad targeting

val prebidParam: Map<String, String>

Prebid parameters for ad request

val vcl: Long?

Video content length

val vri: String?

Video request ID

val vrr: Int?

Video reminder request flag

val vsd: Long?

Video start delay

val vsi: String?

Video schedule ID

Functions

fun buildUpon(): AdParam.Builder

Creates a new Builder with current parameters

fetchAdCallQuery

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

Fetches the ad call query asynchronously

getApsParameter

fun getApsParameter(): String

Returns a string of APS parameters if any exist. Format: "key:value,key:value,key:value|value,..." - if one single key has multiple values, use '|' as delimiter

fun getContentInfo(): GfpContentInfo?

Returns the content information

getCurrentPageUrl

fun getCurrentPageUrl(): String

Returns the encoded current page URL

fun getCurrentPageUrl(isEncodingNeeded: Boolean): String

Returns the current page URL with optional encoding

getPrebidParameter

fun getPrebidParameter(): String

Returns a string of prebid parameters which is serialized and formatted like "key:value,key:value,...". Default is empty string.

getRefererPageUrl

fun getRefererPageUrl(): String

Returns the encoded referer page URL

fun getRefererPageUrl(isEncodingNeeded: Boolean): String

Returns the referer page URL with optional encoding

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

Sets the APS parameter.