NonceRequest.Builder

Kotlin |Java

@AutoValue.Builder
public abstract class NonceRequest.Builder

A builder for generating NonceRequest objects.

Summary

Public constructors
`Builder()`

Public methods
`abstract NonceRequest`	`build()` Build the `NonceRequest`.
`abstract NonceRequest.Builder`	`continuousPlayback(@Nullable Boolean toggle)` Sets whether the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist.
`abstract NonceRequest.Builder`	`descriptionURL(String descriptionURL)` Sets the description URL of the video being played.
`abstract NonceRequest.Builder`	`iconsSupported(Boolean toggle)` Sets whether VAST icons are supported by the video player.
`abstract NonceRequest.Builder`	`nonceLengthLimit(@Nullable Integer nonceLengthLimit)` Sets the maximum allowed length for the generated nonce.
`abstract NonceRequest.Builder`	`omidPartnerName(String omidPartnerName)` Sets the name of the partner integrating OMID measurement.
`abstract NonceRequest.Builder`	`omidPartnerVersion(String omidPartnerVersion)` Sets version of the partner integrating OMID measurement.
`abstract NonceRequest.Builder`	`platformSignalCollector( @Nullable PlatformSignalCollector platformSignalCollector )` Set a `PlatformSignalCollector`
`abstract NonceRequest.Builder`	`playerType(String playerType)` Sets the name of the partner player being used to play the ad.
`abstract NonceRequest.Builder`	`playerVersion(String playerVersion)` Sets the version of the partner player being used to play the ad.
`abstract NonceRequest.Builder`	`ppid(String ppid)` Sets the publisher provided id (PPID).
`abstract NonceRequest.Builder`	`sessionId(String sessionId)` Sets the session ID which is a temporary random ID.
`abstract NonceRequest.Builder`	`supportedApiFrameworks(Set<Integer> supportedApiFrameworks)` Sets an array of numbers representing frameworks supported by the player as defined in the AdCOM "API Frameworks" list: https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-
`abstract NonceRequest.Builder`	`videoPlayerHeight(@Nullable Integer videoPlayerHeight)` Sets the height of the video player.
`abstract NonceRequest.Builder`	`videoPlayerWidth(@Nullable Integer videoPlayerWidth)` Sets the width of the video player.
`abstract NonceRequest.Builder`	`willAdAutoPlay(@Nullable Boolean toggle)` Sets whether the ad will begin playback automatically.
`abstract NonceRequest.Builder`	`willAdPlayMuted(@Nullable Boolean toggle)` Sets whether the ad will begin playback while muted.

Public constructors

Builder

public Builder()

Public methods

build

public abstract NonceRequest build()

Build the NonceRequest.

continuousPlayback

public abstract NonceRequest.Builder continuousPlayback(@Nullable Boolean toggle)

Sets whether the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist.

descriptionURL

public abstract NonceRequest.Builder descriptionURL(String descriptionURL)

Sets the description URL of the video being played. Any description URL string longer than 500 characters will be ignored and excluded from the nonce.

iconsSupported

public abstract NonceRequest.Builder iconsSupported(Boolean toggle)

Sets whether VAST icons are supported by the video player.

nonceLengthLimit

public abstract NonceRequest.Builder nonceLengthLimit(@Nullable Integer nonceLengthLimit)

Sets the maximum allowed length for the generated nonce.

omidPartnerName

public abstract NonceRequest.Builder omidPartnerName(String omidPartnerName)

Sets the name of the partner integrating OMID measurement. Any partner name string longer than 200 characters will be ignored and excluded from the nonce.

To successfully include the omid_p= value in a nonce, both this omidPartnerName and omidPartnerVersion must be set.

Parameters
`String omidPartnerName`	The name of the OMID Integration Partner. This must match the name supplied to the OM SDK for the ad session. For further details, see the OM SDK Onboarding Guide.

omidPartnerVersion

public abstract NonceRequest.Builder omidPartnerVersion(String omidPartnerVersion)

Sets version of the partner integrating OMID measurement. Any partner version string longer than 200 characters will be ignored and excluded from the nonce.

To successfully include the omid_p= value in a nonce, both this omidPartnerVersion and omidPartnerName must be set.

Parameters
`String omidPartnerVersion`	The OMID Integration Partner's version string. This must match the string supplied to the OM SDK for the ad session.

platformSignalCollector

public abstract NonceRequest.Builder platformSignalCollector(
    @Nullable PlatformSignalCollector platformSignalCollector
)

Set a PlatformSignalCollector

playerType

public abstract NonceRequest.Builder playerType(String playerType)

Sets the name of the partner player being used to play the ad. Any player type string longer than 200 characters will be ignored and excluded from the nonce.

playerVersion

public abstract NonceRequest.Builder playerVersion(String playerVersion)

Sets the version of the partner player being used to play the ad. Any player version string longer than 200 characters will be ignored and excluded from the nonce.

ppid

public abstract NonceRequest.Builder ppid(String ppid)

Sets the publisher provided id (PPID). Any PPID longer than 200 characters will be ignored and excluded from the nonce.

sessionId

public abstract NonceRequest.Builder sessionId(String sessionId)

Sets the session ID which is a temporary random ID. It is used exclusively for frequency capping. A session ID must be a UUID.

supportedApiFrameworks

public abstract NonceRequest.Builder supportedApiFrameworks(Set<Integer> supportedApiFrameworks)

Sets an array of numbers representing frameworks supported by the player as defined in the AdCOM "API Frameworks" list: https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-

videoPlayerHeight

public abstract NonceRequest.Builder videoPlayerHeight(@Nullable Integer videoPlayerHeight)

Sets the height of the video player.

videoPlayerWidth

public abstract NonceRequest.Builder videoPlayerWidth(@Nullable Integer videoPlayerWidth)

Sets the width of the video player.

willAdAutoPlay

public abstract NonceRequest.Builder willAdAutoPlay(@Nullable Boolean toggle)

Sets whether the ad will begin playback automatically.

willAdPlayMuted

public abstract NonceRequest.Builder willAdPlayMuted(@Nullable Boolean toggle)

Sets whether the ad will begin playback while muted.