NonceRequest

Kotlin |Java

@AutoValue
public abstract class NonceRequest

---

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

Summary

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

Public constructors
NonceRequest()

Public methods
static NonceRequest.Builder	builder() A builder for generating NonceRequest objects.
abstract @Nullable 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 @Nullable 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 Set<Integer>	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 @Nullable Integer	videoPlayerHeight() Gets the height of the video player.
abstract @Nullable Integer	videoPlayerWidth() Gets the width of the video player.
abstract @Nullable Boolean	willAdAutoPlay() Gets whether the ad will begin playback automatically.
abstract @Nullable Boolean	willAdPlayMuted() Gets whether the ad will begin playback while muted.

Public constructors

NonceRequest

public NonceRequest()

Public methods

builder

public static NonceRequest.Builder builder()

A builder for generating NonceRequest objects.

continuousPlayback

public abstract @Nullable Boolean continuousPlayback()

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

descriptionURL

public abstract String descriptionURL()

Gets the description URL of the video being played.

iconsSupported

public abstract @Nullable Boolean iconsSupported()

Gets whether VAST icons are supported by the video player.

omidPartnerName

public abstract String omidPartnerName()

Gets the name of the partner integrating OMID measurement.

omidPartnerVersion

public abstract String omidPartnerVersion()

Gets the version of the partner integrating OMID measurement.

playerType

public abstract String playerType()

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

playerVersion

public abstract String playerVersion()

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

ppid

public abstract String ppid()

Gets the publisher provided id.

sessionId

public abstract String sessionId()

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

public abstract Set<Integer> supportedApiFrameworks()

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

toBuilder

public abstract NonceRequest.Builder toBuilder()

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

videoPlayerHeight

public abstract @Nullable Integer videoPlayerHeight()

Gets the height of the video player.

videoPlayerWidth

public abstract @Nullable Integer videoPlayerWidth()

Gets the width of the video player.

willAdAutoPlay

public abstract @Nullable Boolean willAdAutoPlay()

Gets whether the ad will begin playback automatically.

willAdPlayMuted

public abstract @Nullable Boolean willAdPlayMuted()

Gets whether the ad will begin playback while muted.