com.enremmeta.rtb.proto.openx

Class OpenXAdapter

java.lang.Object

com.enremmeta.rtb.proto.spotxchange.ExchangeAdapterImpl<OpenRtbRequest,OpenRtbResponse>

com.enremmeta.rtb.proto.openx.OpenXAdapter

All Implemented Interfaces:

ExchangeAdapter<OpenRtbRequest,OpenRtbResponse>

public class OpenXAdapter
extends ExchangeAdapterImpl<OpenRtbRequest,OpenRtbResponse>

Nested Class Summary

Nested classes/interfaces inherited from interface com.enremmeta.rtb.proto.ExchangeAdapter

ExchangeAdapter.BidChoiceAlgorithm

Field Summary

Fields

Modifier and Type	Field and Description
private OpenXConfig	config
private static SsRtbCrypter	OPENX_CRYPTER
static String	RESPONSE_MEDIA_TYPE

Constructor Summary

Constructors

Constructor and Description
OpenXAdapter()

Method Summary

Modifier and Type	Method and Description
String	checkExchangeTargeting(OpenRtbRequest req, Impression imp, ExchangeTargeting targeting) Check any exchange-specific targeting.
OpenRtbRequest	convertRequest(OpenRtbRequest req)
OpenRtbResponse	convertResponse(OpenRtbRequest req, OpenRtbResponse o)
ExchangeAdapter.BidChoiceAlgorithm	getBidChoiceAlgorithm() We put RANDOM here but only because we don't want the default "ALL" - so that we properly key the BidInFlightInfo object.
String	getClickEncMacro()
String	getClickMacro()
long	getDefaultTimeout() What is the default timeout, in milliseconds (default, because timeout can also be provided dynamically as OpenRtbRequest.getTmax() on each request, which takes precedence).
private SecretKeySpec	getKeySpec(String keyStr)
String	getName()
String	getResponseMediaType()
String	getSampleWinningPrice() Return sample winning price suitable for decoding with ExchangeAdapter.parse(String, long)
String	getWinningPriceMacro() Winning price macro.
long	getWinTimeout() How long, in seconds, to wait, before declaring a loss.
boolean	localUserMapping() Whether the mapping of our user ID to exchange ID is stored by us.
Bid	massageBid(OpenRtbRequest req, Impression imp, Tag tag, Bid bid) Post-process a bid.
ParsedPriceInfo	parse(String winningPriceString, long bidMicros)
boolean	trueWinOnNurlOrImpression() Whether the true win is known by the winning price, gotten either during the call of NUrl or out of band.

Methods inherited from class com.enremmeta.rtb.proto.spotxchange.ExchangeAdapterImpl

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.enremmeta.rtb.proto.ExchangeAdapter

debug, error, error, fillPlatformInfoFromUa, getOptoutBuilder, getPartnerInitiatedSyncUrl, getSeat, info, isAggregator, isMacrosInNurl, isNurlRequired, makeExchangeSpecificInstructionsMap, parseUserId, setHeaders, trace, validateAd

Field Detail

OPENX_CRYPTER

private static final SsRtbCrypter OPENX_CRYPTER

config

private final OpenXConfig config

RESPONSE_MEDIA_TYPE

public static final String RESPONSE_MEDIA_TYPE

See Also:

Constant Field Values

Constructor Detail

OpenXAdapter

public OpenXAdapter()
             throws Lot49Exception

Throws:

Lot49Exception

Method Detail

getWinTimeout

public long getWinTimeout()

Description copied from interface: ExchangeAdapter

How long, in seconds, to wait, before declaring a loss.

getBidChoiceAlgorithm

public ExchangeAdapter.BidChoiceAlgorithm getBidChoiceAlgorithm()

We put RANDOM here but only because we don't want the default "ALL" - so that we properly key the BidInFlightInfo object. OpenX in any case allows only one.

getDefaultTimeout

public final long getDefaultTimeout()

Description copied from interface: ExchangeAdapter

What is the default timeout, in milliseconds (default, because timeout can also be provided dynamically as OpenRtbRequest.getTmax() on each request, which takes precedence).

getSampleWinningPrice

public final String getSampleWinningPrice()

Description copied from interface: ExchangeAdapter

Return sample winning price suitable for decoding with ExchangeAdapter.parse(String, long)

getWinningPriceMacro

public final String getWinningPriceMacro()

Description copied from interface: ExchangeAdapter

Winning price macro.

See Also:

ExchangeAdapter.parse(String, long)

localUserMapping

public final boolean localUserMapping()

Description copied from interface: ExchangeAdapter

Whether the mapping of our user ID to exchange ID is stored by us.

convertRequest

public final OpenRtbRequest convertRequest(OpenRtbRequest req)
                                    throws Throwable

Throws:

Throwable

getName

public String getName()

convertResponse

public OpenRtbResponse convertResponse(OpenRtbRequest req,
                                       OpenRtbResponse o)
                                throws Exception

Throws:

Exception

parse

public ParsedPriceInfo parse(String winningPriceString,
                             long bidMicros)
                      throws Throwable

Throws:

Throwable

See Also:

ExchangeAdapter.getWinningPriceMacro()

getKeySpec

private final SecretKeySpec getKeySpec(String keyStr)
                                throws UnsupportedEncodingException,
                                       org.apache.commons.codec.DecoderException

Throws:

UnsupportedEncodingException

org.apache.commons.codec.DecoderException

getClickMacro

public String getClickMacro()

getClickEncMacro

public String getClickEncMacro()

trueWinOnNurlOrImpression

public boolean trueWinOnNurlOrImpression()

Description copied from interface: ExchangeAdapter

Whether the true win is known by the winning price, gotten either during the call of NUrl or out of band. For example, OpenX does the latter, and so a true Win should be registered in StatsSvc.resultsOpenX(javax.ws.rs.core.UriInfo, String, com.enremmeta.rtb.proto.openx.AuctionResultMessage, String, javax.servlet.http.HttpServletRequest, String, javax.ws.rs.core.HttpHeaders)

See Also:

StatsSvc#nurl(javax.ws.rs.core.UriInfo, String, String, String, String, String, String, String, String, String, String, long, String, String, String, String, String, String, javax.servlet.http.HttpServletRequest, String, String, String, String, String), LogUtils.logWin(String, String, String, String, String, String, String, double, long, long, long, String, String, String, String, String, javax.servlet.http.HttpServletRequest, String, Long, String, java.net.URI, boolean, String, String, String, String, String, String, boolean, boolean, String), StatsSvc.impression(javax.ws.rs.core.UriInfo, String, String, String, String, String, String, String, String, String, long, String, int, String, String, String, String, String, String, String, javax.servlet.http.HttpServletRequest, String, javax.ws.rs.core.HttpHeaders, String, String)

checkExchangeTargeting

public String checkExchangeTargeting(OpenRtbRequest req,
                                     Impression imp,
                                     ExchangeTargeting targeting)

Description copied from interface: ExchangeAdapter

Check any exchange-specific targeting. For an example, see ExchangeAdapter.checkExchangeTargeting(OpenRtbRequest, Impression, ExchangeTargeting)

Returns:

null if everything is OK, otherwise a String with an error message.

See Also:

MatchingAdId

massageBid

public Bid massageBid(OpenRtbRequest req,
                      Impression imp,
                      Tag tag,
                      Bid bid)

Description copied from interface: ExchangeAdapter

Post-process a bid. TODO should really be part of convertResponse and that should be passed request.

See Also:

Tag.getBid(OpenRtbRequest, Impression)

getResponseMediaType

public String getResponseMediaType()