A builder for generating NonceRequest objects.
Public Constructor Summary
|
Builder()
|
Public Method Summary
| abstract NonceRequest |
build()
Build the
NonceRequest.
|
| abstract NonceRequest.Builder |
continuousPlayback(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 | |
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder |
omidPartnerVersion(String
omidPartnerVersion)
Sets version of the partner integrating OMID measurement.
|
| abstract NonceRequest.Builder |
omidVersion(String omidVersion)
This method is deprecated. Instead set
omidPartnerName,
omidPartnerVersion, and supportedApiFrameworks.
|
| abstract NonceRequest.Builder |
platformSignalCollector(PlatformSignalCollector
platformSignalCollector)
Set a
PlatformSignalCollector
|
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder |
playerVersion(String
playerVersion)
Sets the version of the partner player being used to play the ad.
|
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder | |
| 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/main/AdCOM%20v1.0%20FINAL.md#list_apiframeworks
|
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder | |
| abstract NonceRequest.Builder |
Inherited Method Summary
Public Constructors
public Builder ()
Public Methods
public abstract NonceRequest build ()
Build the NonceRequest.
public abstract NonceRequest.Builder continuousPlayback (Boolean toggle)
Sets whether the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist.
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.
public abstract NonceRequest.Builder iconsSupported (Boolean toggle)
Sets whether VAST icons are supported by the video player.
public abstract NonceRequest.Builder nonceLengthLimit (Integer nonceLengthLimit)
Sets the maximum allowed length for the generated nonce.
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
| 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. |
|---|
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
| omidPartnerVersion | The OMID Integration Partner's version string. This must match the string supplied to the OM SDK for the ad session. |
|---|
public abstract NonceRequest.Builder omidVersion (String omidVersion)
This method is deprecated.
Instead, set omidPartnerName, omidPartnerVersion, and
supportedApiFrameworks.
Sets the version of the OMID SDK supported by the ad player. Any OMID version string longer than 200 characters will be ignored and excluded from the nonce.
Parameters
| omidVersion | The version of OMID supported by the ad player. This must be set to the version provided by the OM SDK's Omid.getVersion() method. For further details, see the OMID API docs. |
|---|
public abstract NonceRequest.Builder platformSignalCollector (PlatformSignalCollector platformSignalCollector)
Set a PlatformSignalCollector
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.
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.
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.
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.
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: //github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-
public abstract NonceRequest.Builder videoPlayerHeight (Integer videoPlayerHeight)
Sets the height of the video player.
public abstract NonceRequest.Builder videoPlayerWidth (Integer videoPlayerWidth)
Sets the width of the video player.
public abstract NonceRequest.Builder willAdAutoPlay (Boolean toggle)
Sets whether the ad will begin playback automatically.
public abstract NonceRequest.Builder willAdPlayMuted (Boolean toggle)
Sets whether the ad will begin playback while muted.