Package com.brightcove.ssai.omid

Class OpenMeasurementTracker.Config

java.lang.Object

com.brightcove.ssai.omid.OpenMeasurementTracker.Config

Enclosing interface:

OpenMeasurementTracker

public static final class OpenMeasurementTracker.Config
extends java.lang.Object

Config class used to configure the open-measurement ad session.

Constructor Summary

Constructors

Constructor	Description
Config()

Method Summary

Modifier and Type	Method	Description
OpenMeasurementTracker.Config	withCustomReferenceData(java.lang.String data)	Set the custom reference data to be used when creating the OM AdSession.
OpenMeasurementTracker.Config	withVerificationScript(java.lang.String url)	Add a verification/validation script to each ad session.
OpenMeasurementTracker.Config	withVerificationScript(java.lang.String vendor, java.lang.String url, java.lang.String params)	Add a verification/validation script to each ad session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Config

public Config()

Method Detail

withCustomReferenceData

public OpenMeasurementTracker.Config withCustomReferenceData(java.lang.String data)

Set the custom reference data to be used when creating the OM AdSession.

Parameters:

data - The custom reference JSON

Returns:

This config object for the chaining of method calls.

withVerificationScript

public OpenMeasurementTracker.Config withVerificationScript(java.lang.String url)
                                                     throws OpenMeasurementTracker.Error

Add a verification/validation script to each ad session.

Parameters:

url - The URL for the validation script.

Returns:

This config object for the chaining of method calls.

Throws:

OpenMeasurementTracker.Error - If the URL is malformed.

See Also:

withVerificationScript(String, String, String)

withVerificationScript

public OpenMeasurementTracker.Config withVerificationScript(java.lang.String vendor,
                                                            java.lang.String url,
                                                            java.lang.String params)

Add a verification/validation script to each ad session.

Parameters:

vendor - The vendor key.

url - The URL for the validation script.

params - The verification parameters as a string.

Returns:

This config object for the chaining of method calls.

Throws:

OpenMeasurementTracker.Error - If the URL is malformed.

See Also:

withVerificationScript(String)