NonceRequest

Kotlin |Java

@AutoValue
abstract class NonceRequest

---

Encapsulates settings for an ad or video stream. Used to request a Nonce.

Summary

Nested types
@AutoValue.Builder abstract class NonceRequest.Builder A builder for generating NonceRequest objects.

Public constructors
NonceRequest()

Public functions
java-static NonceRequest.Builder!	builder() A builder for generating NonceRequest objects.
abstract Boolean?	continuousPlayback() Gets whether the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist.
abstract String!	descriptionURL() Gets the description URL of the video being played.
abstract Boolean?	iconsSupported() Gets whether VAST icons are supported by the video player.
abstract String!	omidPartnerName() Gets the name of the partner integrating OMID measurement.
abstract String!	omidPartnerVersion() Gets the version of the partner integrating OMID measurement.
abstract String!	playerType() Gets the name of the partner player being used to play the ad.
abstract String!	playerVersion() Gets the version of the partner player being used to play the ad.
abstract String!	ppid() Gets the publisher provided id.
abstract String!	sessionId() Gets the session ID which is a temporary random ID.
abstract (Mutable)Set<Int!>!	supportedApiFrameworks() Gets an array of numbers representing frameworks supported by the player as defined in the AdCOM "API Frameworks" list.
abstract NonceRequest.Builder!	toBuilder() Takes a NonceRequest object and a setter method and returns a new, modified NonceRequest object.
abstract Int?	videoPlayerHeight() Gets the height of the video player.
abstract Int?	videoPlayerWidth() Gets the width of the video player.
abstract Boolean?	willAdAutoPlay() Gets whether the ad will begin playback automatically.
abstract Boolean?	willAdPlayMuted() Gets whether the ad will begin playback while muted.

Public constructors

NonceRequest

NonceRequest()

Public functions

builder

java-static fun builder(): NonceRequest.Builder!

A builder for generating NonceRequest objects.

continuousPlayback

abstract fun continuousPlayback(): Boolean?

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

descriptionURL

abstract fun descriptionURL(): String!

Gets the description URL of the video being played.

iconsSupported

abstract fun iconsSupported(): Boolean?

Gets whether VAST icons are supported by the video player.

omidPartnerName

abstract fun omidPartnerName(): String!

Gets the name of the partner integrating OMID measurement.

omidPartnerVersion

abstract fun omidPartnerVersion(): String!

Gets the version of the partner integrating OMID measurement.

playerType

abstract fun playerType(): String!

Gets the name of the partner player being used to play the ad.

playerVersion

abstract fun playerVersion(): String!

Gets the version of the partner player being used to play the ad.

ppid

abstract fun ppid(): String!

Gets the publisher provided id.

sessionId

abstract fun sessionId(): String!

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

supportedApiFrameworks

abstract fun supportedApiFrameworks(): (Mutable)Set<Int!>!

Gets an array of numbers representing frameworks supported by the player as defined in the AdCOM "API Frameworks" list.

toBuilder

abstract fun toBuilder(): NonceRequest.Builder!

Takes a NonceRequest object and a setter method and returns a new, modified NonceRequest object. Example: oldNonceRequest.toBuilder().continuousPlayback(false).build()

videoPlayerHeight

abstract fun videoPlayerHeight(): Int?

Gets the height of the video player.

videoPlayerWidth

abstract fun videoPlayerWidth(): Int?

Gets the width of the video player.

willAdAutoPlay

abstract fun willAdAutoPlay(): Boolean?

Gets whether the ad will begin playback automatically.

willAdPlayMuted

abstract fun willAdPlayMuted(): Boolean?

Gets whether the ad will begin playback while muted.