com.enremmeta.rtb.proto.adx

Class AdXAdapter

java.lang.Object

com.enremmeta.rtb.proto.adx.AdXAdapter

All Implemented Interfaces:

ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

public class AdXAdapter
extends Object
implements ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

Google (AdX) connector.

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
static String	ADX_SPECIFIC_INSTRUCTION_VENDOR_TYPE
private AdXConfig	config
private static Map<Integer,AdxGeo>	geo
private com.google.doubleclick.crypto.DoubleClickCrypto.Keys	keys
static String	RESPONSE_MEDIA_TYPE
private long	timeout

Constructor Summary

Constructors

Constructor and Description
AdXAdapter()
AdXAdapter(boolean test) The only one purpose of this constructors is to run test AdxTest

Method Summary

Modifier and Type	Method and Description
OpenRtbRequest	convertRequest(com.google.protos.adx.NetworkBid.BidRequest req)
com.google.protos.adx.NetworkBid.BidResponse	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()
javax.ws.rs.core.Response.ResponseBuilder	getOptoutBuilder(OpenRtbRequest req) Default behavior is not OK here per Build the Response document.
String	getPartnerInitiatedSyncUrl(String myUserId)
String	getResponseMediaType()
String	getSampleWinningPrice() Return sample winning price suitable for decoding with ExchangeAdapter.parse(String, long)
static String	getStringFromByteSting(com.google.protobuf.ByteString bs)
String	getWinningPriceMacro() Winning price macro.
boolean	localUserMapping() Whether the mapping of our user ID to exchange ID is stored by us.
Map<String,Object>	makeExchangeSpecificInstructionsMap()
ParsedPriceInfo	parse(String winningPriceString, long bidMicros)
List<String>	validateAd(Ad ad) For calls from Ad.validate(), for example.

Methods inherited from class java.lang.Object

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

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

checkExchangeTargeting, debug, error, error, fillPlatformInfoFromUa, getBidChoiceAlgorithm, getSeat, getWinTimeout, info, isAggregator, isMacrosInNurl, isNurlRequired, massageBid, parseUserId, setHeaders, trace, trueWinOnNurlOrImpression

Field Detail

config

private final AdXConfig config

timeout

private final long timeout

geo

private static Map<Integer,AdxGeo> geo

keys

private final com.google.doubleclick.crypto.DoubleClickCrypto.Keys keys

ADX_SPECIFIC_INSTRUCTION_VENDOR_TYPE

public static final String ADX_SPECIFIC_INSTRUCTION_VENDOR_TYPE

See Also:

Constant Field Values

RESPONSE_MEDIA_TYPE

public static final String RESPONSE_MEDIA_TYPE

See Also:

Constant Field Values

Constructor Detail

AdXAdapter

public AdXAdapter(boolean test)
           throws Lot49Exception

The only one purpose of this constructors is to run test AdxTest

Parameters:

test -

Throws:

Lot49Exception

AdXAdapter

public AdXAdapter()
           throws Lot49Exception

Throws:

Lot49Exception

Method Detail

getDefaultTimeout

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

Specified by:

getDefaultTimeout in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

getWinningPriceMacro

public String getWinningPriceMacro()

Description copied from interface: ExchangeAdapter

Winning price macro.

Specified by:

getWinningPriceMacro in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

See Also:

ExchangeAdapter.parse(String, long)

localUserMapping

public boolean localUserMapping()

Description copied from interface: ExchangeAdapter

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

Specified by:

localUserMapping in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

getStringFromByteSting

public static final String getStringFromByteSting(com.google.protobuf.ByteString bs)

getPartnerInitiatedSyncUrl

public String getPartnerInitiatedSyncUrl(String myUserId)

Specified by:

getPartnerInitiatedSyncUrl in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

convertRequest

public OpenRtbRequest convertRequest(com.google.protos.adx.NetworkBid.BidRequest req)

Specified by:

convertRequest in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

getOptoutBuilder

public javax.ws.rs.core.Response.ResponseBuilder getOptoutBuilder(OpenRtbRequest req)

Default behavior is not OK here per Build the Response document.

Specified by:

getOptoutBuilder in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

makeExchangeSpecificInstructionsMap

public Map<String,Object> makeExchangeSpecificInstructionsMap()

Specified by:

makeExchangeSpecificInstructionsMap in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

convertResponse

public com.google.protos.adx.NetworkBid.BidResponse convertResponse(OpenRtbRequest req,
                                                                    OpenRtbResponse resp)
                                                             throws Throwable

Specified by:

convertResponse in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

Throws:

Throwable

parse

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

Specified by:

parse in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

Throws:

Throwable

See Also:

https://developers.google.com/ad-exchange/rtb/response-guide/decrypt-price, DoubleClickCrypto

getName

public String getName()

Specified by:

getName in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

getClickMacro

public String getClickMacro()

Specified by:

getClickMacro in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

getClickEncMacro

public String getClickEncMacro()

Specified by:

getClickEncMacro in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

getResponseMediaType

public String getResponseMediaType()

Specified by:

getResponseMediaType in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

validateAd

public List<String> validateAd(Ad ad)

Description copied from interface: ExchangeAdapter

For calls from Ad.validate(), for example. Same semantics. Default implementation is to return null.

Specified by:

validateAd in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>

getSampleWinningPrice

public String getSampleWinningPrice()

Description copied from interface: ExchangeAdapter

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

Specified by:

getSampleWinningPrice in interface ExchangeAdapter<com.google.protos.adx.NetworkBid.BidRequest,com.google.protos.adx.NetworkBid.BidResponse>