BaseRequest

public interface BaseRequest
Known Indirect Subclasses

Base interface for requesting ads. Subclassed by AdsRequest for directly requested ads and StreamRequest for dynamic ad insertion streams.

Public Method Summary

abstract String
getContentUrl()
Returns the deep link to the content's screen provided in setContentUrl()
abstract SecureSignals
getSecureSignals()
Returns the Secure Signals with custom data
abstract Object
getUserRequestContext()
Returns the user-provided object that is associated with the request.
abstract void
setContentUrl(String url)
Specifies the deep link to the content's screen.
abstract void
setSecureSignals(SecureSignals signal)
Specifies the Secure Signals with custom data for this request.
abstract void
setUserRequestContext(Object userRequestContext)
Sets the user-provided object that is associated with the request.

Public Methods

public abstract String getContentUrl ()

Returns the deep link to the content's screen provided in setContentUrl()

public abstract SecureSignals getSecureSignals ()

Returns the Secure Signals with custom data

public abstract Object getUserRequestContext ()

Returns the user-provided object that is associated with the request.

public abstract void setContentUrl (String url)

Specifies the deep link to the content's screen. If provided, this parameter is passed to the OM SDK. See Android documentation for more information.

Parameters
url

public abstract void setSecureSignals (SecureSignals signal)

Specifies the Secure Signals with custom data for this request. Secure Signals with custom data is an encrypted blob containing signals collected by the publisher and previously agreed upon by the publisher and bidder. The Secure Signals with custom data can be cleared out by passing null to this function.

Parameters
signal

public abstract void setUserRequestContext (Object userRequestContext)

Sets the user-provided object that is associated with the request. If supplied here, it will be available once the ad load is complete or fails. This object can be used to identify the request that caused an error or which request loaded a particular ads manager.

Parameters
userRequestContext