Instream SDK/com.smartadserver.android.instreamsdk.model.adplacement/SVSAdPlacement

SVSAdPlacement

open class SVSAdPlacement : Parcelable, Serializable

Class representing an instream ad placement

Constructors

SVSAdPlacement

constructor(siteID: Long, @Nullable pageName: String, formatId: Long)

Creates a SVSAdPlacement instance from specified parameters

constructor(siteID: Long, pageId: Long, formatId: Long)

Creates a SVSAdPlacement instance from specified parameters.

Properties

FORMAT_ID_PARAMETER

val FORMAT_ID_PARAMETER: String = "fmtid"

Constant for format id property key string

formatId

open val formatId: Long

globalTargetingString

@Nullable

@get:Nullable

open var globalTargetingString: String

midrollTargetingString

@Nullable

@get:Nullable

open var midrollTargetingString: String

PAGE_ID_PARAMETER

val PAGE_ID_PARAMETER: String = "pgid"

Constant for page id property key string

PAGE_NAME_PARAMETER

val PAGE_NAME_PARAMETER: String = "pgname"

Constant for page name property key string

pageId

open val pageId: Long

pageName

@Nullable

@get:Nullable

open val pageName: String

postrollTargetingString

@Nullable

@get:Nullable

open var postrollTargetingString: String

PREROLL_MIDROLL_POSTROLL

val PREROLL_MIDROLL_POSTROLL: SVSAdPlacement

A test placement that will return one ad for preroll, midroll and postroll

prerollTargetingString

@Nullable

@get:Nullable

open var prerollTargetingString: String

SCO_PARAMETER

val SCO_PARAMETER: String = "schain"

Constant for supply chain object property key string

SITE_ID_PARAMETER

val SITE_ID_PARAMETER: String = "siteid"

Constant for site id property key string

siteID

open val siteID: Long

supplyChainObjectString

@Nullable

@get:Nullable

open var supplyChainObjectString: String

TARGET_PARAMETER

val TARGET_PARAMETER: String = "tgt"

Constant for target property key string

Functions

getParameters

open fun getParameters(@NonNull parameters: HashMap<String, String>, @NonNull adBreakType: SVSAdBreakType)

Fills the passed HashMap with all relevant parameters of this SVSAdPlacement Object

getTargetingForAdBreakType

@NonNull

open fun getTargetingForAdBreakType(@NonNull type: SVSAdBreakType): String

Returns the appropriate targeting string for the given ad break type.

usesPageName

open fun usesPageName(): Boolean

Returns whether this placement relies on a page name or a page Id.