com.enremmeta.rtb.proto.bidswitch

Class BidSwitchAdapter

java.lang.Object

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

com.enremmeta.rtb.proto.bidswitch.BidSwitchAdapter

All Implemented Interfaces:

ExchangeAdapter<OpenRtbRequest,OpenRtbResponse>

public class BidSwitchAdapter
extends ExchangeAdapterImpl<OpenRtbRequest,OpenRtbResponse>

Adapter for BidSwitch.

Author:

Gregory Golberg (grisha@alum.mit.edu)

Copyright © Enremmeta LLC 2015. All Rights Reserved.

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 BidSwitchConfig	config
static String	RESPONSE_MEDIA_TYPE
private String	seatId

Constructor Summary

Constructors

Constructor and Description
BidSwitchAdapter()
BidSwitchAdapter(BidSwitchConfig bsConf)

Method Summary

Modifier and Type	Method and Description
OpenRtbRequest	convertRequest(OpenRtbRequest req)
OpenRtbResponse	convertResponse(OpenRtbRequest req, OpenRtbResponse resp)
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).
String	getName()
String	getPartnerInitiatedSyncUrl(String myUserId)
String	getResponseMediaType()
String	getSampleWinningPrice() Return sample winning price suitable for decoding with ExchangeAdapter.parse(String, long)
String	getSeat(Ad ad)
String	getWinningPriceMacro() Winning price macro.
boolean	isAggregator()
boolean	isMacrosInNurl()
boolean	isNurlRequired() Whether NUrl is required (two-step response).
boolean	localUserMapping() Whether the mapping of our user ID to exchange ID is stored by us.
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

checkExchangeTargeting, debug, error, error, fillPlatformInfoFromUa, getBidChoiceAlgorithm, getOptoutBuilder, getWinTimeout, info, makeExchangeSpecificInstructionsMap, massageBid, parseUserId, setHeaders, trace, validateAd

Field Detail

seatId

private final String seatId

config

private final BidSwitchConfig config

RESPONSE_MEDIA_TYPE

public static final String RESPONSE_MEDIA_TYPE

See Also:

Constant Field Values

Constructor Detail

BidSwitchAdapter

public BidSwitchAdapter(BidSwitchConfig bsConf)

BidSwitchAdapter

public BidSwitchAdapter()

Method Detail

getSampleWinningPrice

public String getSampleWinningPrice()

Description copied from interface: ExchangeAdapter

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

isAggregator

public final boolean isAggregator()

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).

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()

getPartnerInitiatedSyncUrl

public String getPartnerInitiatedSyncUrl(String myUserId)

convertResponse

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

Throws:

Exception

parse

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

Throws:

Throwable

See Also:

ExchangeAdapter.getWinningPriceMacro()

isNurlRequired

public boolean isNurlRequired()

Description copied from interface: ExchangeAdapter

Whether NUrl is required (two-step response). Since most exchanges for now accept single-step response (returning the entire markup at once, we default the implementation to false.

See Also:

OpenRTB 2.3, section 4.3

isMacrosInNurl

public boolean isMacrosInNurl()

getClickMacro

public String getClickMacro()

getClickEncMacro

public String getClickEncMacro()

getSeat

public final String getSeat(Ad ad)

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)

getResponseMediaType

public String getResponseMediaType()