Package com.jwplayer.pub.api.configuration.ads

Class VmapAdvertisingConfig.Builder

java.lang.Object

com.jwplayer.pub.api.configuration.ads.AdvertisingConfig.Builder

com.jwplayer.pub.api.configuration.ads.AdvertisingWithBasicCustomizations.Builder

com.jwplayer.pub.api.configuration.ads.AdvertisingWithVastCustomizations.Builder

com.jwplayer.pub.api.configuration.ads.VmapAdvertisingConfig.Builder

Enclosing class:

VmapAdvertisingConfig

public static class VmapAdvertisingConfig.Builder
extends AdvertisingWithVastCustomizations.Builder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VmapAdvertisingConfig.Builder	adMessage(String adMessage)
VmapAdvertisingConfig.Builder	adRules(AdRules adRules)
VmapAdvertisingConfig	build()
VmapAdvertisingConfig.Builder	conditionalOptOut(Boolean conditionalOptOut)
VmapAdvertisingConfig.Builder	creativeTimeout(Integer creativeTimeout)
VmapAdvertisingConfig.Builder	cueText(String cueText)
VmapAdvertisingConfig.Builder	liftsVMAPLevelExtensions(boolean enabled)	Opts in to preprocessing inline VMAP XML so any VMAP-level <vmap:Extensions> of supported types (currently skippable) are lifted into each ad's <InLine>/<Wrapper>'s <Extensions>, so the existing JS-side VAST extension handlers run for every ad in the schedule.
VmapAdvertisingConfig.Builder	requestTimeout(Integer requestTimeout)
VmapAdvertisingConfig.Builder	skipMessage(String skipMessage)
VmapAdvertisingConfig.Builder	skipOffset(Integer skipOffset)
VmapAdvertisingConfig.Builder	skipText(String skipText)
VmapAdvertisingConfig.Builder	tag(String tag)
VmapAdvertisingConfig.Builder	vpaidControls(Boolean vpaidControls)

Methods inherited from class com.jwplayer.pub.api.configuration.ads.AdvertisingWithVastCustomizations.Builder

adPodMessage, omidConfig

Methods inherited from class com.jwplayer.pub.api.configuration.ads.AdvertisingConfig.Builder

adClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

skipText

public VmapAdvertisingConfig.Builder skipText(String skipText)

Overrides:

skipText in class AdvertisingWithVastCustomizations.Builder

skipMessage

public VmapAdvertisingConfig.Builder skipMessage(String skipMessage)

Overrides:

skipMessage in class AdvertisingWithVastCustomizations.Builder

skipOffset

public VmapAdvertisingConfig.Builder skipOffset(Integer skipOffset)

Overrides:

skipOffset in class AdvertisingWithVastCustomizations.Builder

adMessage

public VmapAdvertisingConfig.Builder adMessage(String adMessage)

Overrides:

adMessage in class AdvertisingWithVastCustomizations.Builder

cueText

public VmapAdvertisingConfig.Builder cueText(String cueText)

Overrides:

cueText in class AdvertisingWithVastCustomizations.Builder

vpaidControls

public VmapAdvertisingConfig.Builder vpaidControls(Boolean vpaidControls)

Overrides:

vpaidControls in class AdvertisingWithVastCustomizations.Builder

requestTimeout

public VmapAdvertisingConfig.Builder requestTimeout(Integer requestTimeout)

Overrides:

requestTimeout in class AdvertisingWithVastCustomizations.Builder

creativeTimeout

public VmapAdvertisingConfig.Builder creativeTimeout(Integer creativeTimeout)

Overrides:

creativeTimeout in class AdvertisingWithVastCustomizations.Builder

conditionalOptOut

public VmapAdvertisingConfig.Builder conditionalOptOut(Boolean conditionalOptOut)

Overrides:

conditionalOptOut in class AdvertisingWithVastCustomizations.Builder

adRules

public VmapAdvertisingConfig.Builder adRules(AdRules adRules)

Overrides:

adRules in class AdvertisingWithVastCustomizations.Builder

tag

public VmapAdvertisingConfig.Builder tag(String tag)

Parameters:

tag - Either a local, remote URL of the vmap file, or a VMAP (XML) string.

liftsVMAPLevelExtensions

public VmapAdvertisingConfig.Builder liftsVMAPLevelExtensions(boolean enabled)

Opts in to preprocessing inline VMAP XML so any VMAP-level <vmap:Extensions> of supported types (currently skippable) are lifted into each ad's <InLine>/<Wrapper>'s <Extensions>, so the existing JS-side VAST extension handlers run for every ad in the schedule. Defaults to false.

Only affects inline VMAP XML supplied via tag(String). When tag(String) holds a URL, the flag is a no-op.

Parameters:

enabled - when true, the SDK rewrites the VMAP before handing it to the headless player; when false, the VMAP is forwarded unchanged.

build

public VmapAdvertisingConfig build()

Specified by:

build in class AdvertisingConfig.Builder