NonceRequest.Builder
@AutoValue.Builder
abstract class NonceRequest.Builder
A builder for generating NonceRequest objects.
Summary
Public constructors |
|---|
Builder() |
Public functions |
|
|---|---|
abstract NonceRequest! |
build()Build the |
abstract NonceRequest.Builder! |
continuousPlayback(toggle: Boolean?)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(descriptionURL: String!)Sets the description URL of the video being played. |
abstract NonceRequest.Builder! |
iconsSupported(toggle: Boolean!)Sets whether VAST icons are supported by the video player. |
abstract NonceRequest.Builder! |
nonceLengthLimit(nonceLengthLimit: Int?)Sets the maximum allowed length for the generated nonce. |
abstract NonceRequest.Builder! |
omidPartnerName(omidPartnerName: String!)Sets the name of the partner integrating OMID measurement. |
abstract NonceRequest.Builder! |
omidPartnerVersion(omidPartnerVersion: String!)Sets version of the partner integrating OMID measurement. |
abstract NonceRequest.Builder! |
platformSignalCollector(Set a |
abstract NonceRequest.Builder! |
playerType(playerType: String!)Sets the name of the partner player being used to play the ad. |
abstract NonceRequest.Builder! |
playerVersion(playerVersion: String!)Sets the version of the partner player being used to play the ad. |
abstract NonceRequest.Builder! |
Sets the publisher provided id (PPID). |
abstract NonceRequest.Builder! |
Sets the session ID which is a temporary random ID. |
abstract NonceRequest.Builder! |
supportedApiFrameworks(supportedApiFrameworks: (Mutable)Set<Int!>!)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(videoPlayerHeight: Int?)Sets the height of the video player. |
abstract NonceRequest.Builder! |
videoPlayerWidth(videoPlayerWidth: Int?)Sets the width of the video player. |
abstract NonceRequest.Builder! |
willAdAutoPlay(toggle: Boolean?)Sets whether the ad will begin playback automatically. |
abstract NonceRequest.Builder! |
willAdPlayMuted(toggle: Boolean?)Sets whether the ad will begin playback while muted. |
Public constructors
Public functions
continuousPlayback
abstract fun continuousPlayback(toggle: Boolean?): NonceRequest.Builder!
Sets whether the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist.
descriptionURL
abstract fun descriptionURL(descriptionURL: String!): NonceRequest.Builder!
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
abstract fun iconsSupported(toggle: Boolean!): NonceRequest.Builder!
Sets whether VAST icons are supported by the video player.
nonceLengthLimit
abstract fun nonceLengthLimit(nonceLengthLimit: Int?): NonceRequest.Builder!
Sets the maximum allowed length for the generated nonce.
omidPartnerName
abstract fun omidPartnerName(omidPartnerName: String!): NonceRequest.Builder!
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 | |
|---|---|
omidPartnerName: String! |
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
abstract fun omidPartnerVersion(omidPartnerVersion: String!): NonceRequest.Builder!
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 | |
|---|---|
omidPartnerVersion: String! |
The OMID Integration Partner's version string. This must match the string supplied to the OM SDK for the ad session. |
platformSignalCollector
abstract fun platformSignalCollector(
platformSignalCollector: PlatformSignalCollector?
): NonceRequest.Builder!
Set a PlatformSignalCollector
playerType
abstract fun playerType(playerType: String!): NonceRequest.Builder!
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
abstract fun playerVersion(playerVersion: String!): NonceRequest.Builder!
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
abstract fun ppid(ppid: String!): NonceRequest.Builder!
Sets the publisher provided id (PPID). Any PPID longer than 200 characters will be ignored and excluded from the nonce.
sessionId
abstract fun sessionId(sessionId: String!): NonceRequest.Builder!
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
abstract fun supportedApiFrameworks(supportedApiFrameworks: (Mutable)Set<Int!>!): NonceRequest.Builder!
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
abstract fun videoPlayerHeight(videoPlayerHeight: Int?): NonceRequest.Builder!
Sets the height of the video player.
videoPlayerWidth
abstract fun videoPlayerWidth(videoPlayerWidth: Int?): NonceRequest.Builder!
Sets the width of the video player.
willAdAutoPlay
abstract fun willAdAutoPlay(toggle: Boolean?): NonceRequest.Builder!
Sets whether the ad will begin playback automatically.
willAdPlayMuted
abstract fun willAdPlayMuted(toggle: Boolean?): NonceRequest.Builder!
Sets whether the ad will begin playback while muted.