Skip to content

TheTradeDesk: Resolve AUCTION_PRICE macro #4081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CTMBNara merged 1 commit into from
Jul 29, 2025
Merged

TheTradeDesk: Resolve AUCTION_PRICE macro #4081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 32 additions & 7 deletions src/main/java/org/prebid/server/bidder/thetradedesk/TheTradeDeskBidder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.prebid.server.util.BidderUtil;
import org.prebid.server.util.HttpUtil;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
Expand All @@ -44,6 +45,7 @@ public class TheTradeDeskBidder implements Bidder<BidRequest> {

private static final String SUPPLY_ID_MACRO = "{{SupplyId}}";
private static final Pattern SUPPLY_ID_PATTERN = Pattern.compile("([a-z]+)$");
private static final String PRICE_MACRO = "${AUCTION_PRICE}";

private final String endpointUrl;
private final String supplyId;
Expand Down Expand Up @@ -180,32 +182,55 @@ private String resolveEndpoint(String sourceSupplyId) {
public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
try {
final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
return Result.withValues(extractBids(bidResponse));
} catch (DecodeException | PreBidException e) {
final List<BidderError> errors = new ArrayList<>();
final List<BidderBid> bids = extractBids(bidResponse, errors);
return Result.of(bids, errors);
} catch (DecodeException e) {
return Result.withError(BidderError.badServerResponse(e.getMessage()));
}
}

private static List<BidderBid> extractBids(BidResponse bidResponse) {
private static List<BidderBid> extractBids(BidResponse bidResponse, List<BidderError> errors) {
if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
return Collections.emptyList();
}

return bidResponse.getSeatbid().stream()
.filter(Objects::nonNull)
.map(SeatBid::getBid).filter(Objects::nonNull)
.map(SeatBid::getBid)
.filter(Objects::nonNull)
.flatMap(Collection::stream)
.filter(Objects::nonNull)
.map(bid -> BidderBid.of(bid, getBidType(bid), bidResponse.getCur()))
.map(bid -> makeBid(bid, bidResponse.getCur(), errors))
.filter(Objects::nonNull)
.toList();
}

private static BidType getBidType(Bid bid) {
private static BidderBid makeBid(Bid bid, String currency, List<BidderError> errors) {
final BidType bidType = getBidType(bid, errors);
return bidType != null ? BidderBid.of(resolvePriceMacros(bid), bidType, currency) : null;
}

private static BidType getBidType(Bid bid, List<BidderError> errors) {
return switch (bid.getMtype()) {
case 1 -> BidType.banner;
case 2 -> BidType.video;
case 4 -> BidType.xNative;
case null, default -> throw new PreBidException("unsupported mtype: %s".formatted(bid.getMtype()));
case null, default -> {
errors.add(BidderError.badServerResponse(
"could not define media type for impression: " + bid.getImpid()));
yield null;
}
};
}

private static Bid resolvePriceMacros(Bid bid) {
final BigDecimal price = bid.getPrice();
final String priceAsString = price != null ? price.toPlainString() : "0";

return bid.toBuilder()
.nurl(StringUtils.replace(bid.getNurl(), PRICE_MACRO, priceAsString))
.adm(StringUtils.replace(bid.getAdm(), PRICE_MACRO, priceAsString))
.build();
}
}
234 changes: 231 additions & 3 deletions src/test/java/org/prebid/server/bidder/thetradedesk/TheTradeDeskBidderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.prebid.server.proto.openrtb.ext.ExtPrebid;
import org.prebid.server.proto.openrtb.ext.request.thetradedesk.ExtImpTheTradeDesk;

import java.math.BigDecimal;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
Expand All @@ -33,6 +34,7 @@
import static java.util.function.UnaryOperator.identity;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.assertj.core.api.Assertions.tuple;
import static org.prebid.server.proto.openrtb.ext.response.BidType.banner;
import static org.prebid.server.proto.openrtb.ext.response.BidType.video;
import static org.prebid.server.proto.openrtb.ext.response.BidType.xNative;
Expand Down Expand Up @@ -458,7 +460,7 @@ public void makeBidsShouldReturnVideoBid() throws JsonProcessingException {
}

@Test
public void makeBidsShouldThrowErrorWhenMediaTypeIsMissing() throws JsonProcessingException {
public void makeBidsShouldReturnErrorWhenMediaTypeIsMissing() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder.impid("123")));
Expand All @@ -469,7 +471,234 @@ public void makeBidsShouldThrowErrorWhenMediaTypeIsMissing() throws JsonProcessi
// then
assertThat(result.getValue()).isEmpty();
assertThat(result.getErrors()).hasSize(1)
.containsOnly(BidderError.badServerResponse("unsupported mtype: null"));
.containsOnly(BidderError.badServerResponse("could not define media type for impression: 123"));
}

@Test
public void makeBidsShouldReturnValidBidsAndErrorsForMixedMediaTypes() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
mapper.writeValueAsString(BidResponse.builder()
.cur("USD")
.seatbid(singletonList(SeatBid.builder()
.bid(Arrays.asList(
Bid.builder().mtype(1).impid("valid1").build(), // valid banner
Bid.builder().mtype(3).impid("invalid1").build(), // invalid mtype
Bid.builder().mtype(2).impid("valid2").build(), // valid video
Bid.builder().mtype(null).impid("invalid2").build() // null mtype
))
.build()))
.build()));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getValue()).hasSize(2)
.extracting(bidderBid -> bidderBid.getBid().getImpid())
.containsExactly("valid1", "valid2");
assertThat(result.getErrors()).hasSize(2)
.containsExactly(
BidderError.badServerResponse("could not define media type for impression: invalid1"),
BidderError.badServerResponse("could not define media type for impression: invalid2"));
}

@Test
public void makeBidsShouldReplacePriceMacroInNurlAndAdmWithBidPrice() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(BigDecimal.valueOf(1.23))
.nurl("http://example.com/nurl?price=${AUCTION_PRICE}")
.adm("<div>Price: ${AUCTION_PRICE}</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm, Bid::getPrice)
.containsOnly(tuple("http://example.com/nurl?price=1.23", "<div>Price: 1.23</div>", BigDecimal.valueOf(1.23)));
}

@Test
public void makeBidsShouldReplacePriceMacroWithZeroWhenBidPriceIsNull() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(null)
.nurl("http://example.com/nurl?price=${AUCTION_PRICE}")
.adm("<div>Price: ${AUCTION_PRICE}</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple("http://example.com/nurl?price=0", "<div>Price: 0</div>"));
}

@Test
public void makeBidsShouldReplacePriceMacroWithZeroWhenBidPriceIsZero() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(BigDecimal.ZERO)
.nurl("http://example.com/nurl?price=${AUCTION_PRICE}")
.adm("<div>Price: ${AUCTION_PRICE}</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple("http://example.com/nurl?price=0", "<div>Price: 0</div>"));
}

@Test
public void makeBidsShouldReplacePriceMacroInNurlOnlyWhenAdmDoesNotContainMacro() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(BigDecimal.valueOf(5.67))
.nurl("http://example.com/nurl?price=${AUCTION_PRICE}")
.adm("<div>No macro here</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple("http://example.com/nurl?price=5.67", "<div>No macro here</div>"));
}

@Test
public void makeBidsShouldReplacePriceMacroInAdmOnlyWhenNurlDoesNotContainMacro() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(BigDecimal.valueOf(8.90))
.nurl("http://example.com/nurl")
.adm("<div>Price: ${AUCTION_PRICE}</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple("http://example.com/nurl", "<div>Price: 8.9</div>"));
}

@Test
public void makeBidsShouldNotReplacePriceMacroWhenNurlAndAdmDoNotContainMacro() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(BigDecimal.valueOf(12.34))
.nurl("http://example.com/nurl")
.adm("<div>No macro</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple("http://example.com/nurl", "<div>No macro</div>"));
}

@Test
public void makeBidsShouldHandleNullNurlAndAdm() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(BigDecimal.valueOf(15.00))
.nurl(null)
.adm(null)));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple(null, null));
}

@Test
public void makeBidsShouldReplaceMultiplePriceMacrosInSameField() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(BigDecimal.valueOf(9.99))
.nurl("http://example.com/nurl?price=${AUCTION_PRICE}&backup_price=${AUCTION_PRICE}")
.adm("<div>Price: ${AUCTION_PRICE}, Fallback: ${AUCTION_PRICE}</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple("http://example.com/nurl?price=9.99&backup_price=9.99", "<div>Price: 9.99, Fallback: 9.99</div>"));
}

@Test
public void makeBidsShouldHandleLargeDecimalPrices() throws JsonProcessingException {
// given
final BidderCall<BidRequest> httpCall = givenHttpCall(
givenBidResponse(bidBuilder -> bidBuilder
.mtype(1)
.impid("123")
.price(new BigDecimal("123456789.123456789"))
.nurl("http://example.com/nurl?price=${AUCTION_PRICE}")
.adm("<div>Price: ${AUCTION_PRICE}</div>")));

// when
final Result<List<BidderBid>> result = target.makeBids(httpCall, null);

// then
assertThat(result.getErrors()).isEmpty();
assertThat(result.getValue()).hasSize(1)
.extracting(BidderBid::getBid)
.extracting(Bid::getNurl, Bid::getAdm)
.containsOnly(tuple("http://example.com/nurl?price=123456789.123456789", "<div>Price: 123456789.123456789</div>"));
}

private String givenBidResponse(UnaryOperator<Bid.BidBuilder> bidCustomizer) throws JsonProcessingException {
Expand Down Expand Up @@ -508,5 +737,4 @@ private static ObjectNode impExt(String publisherId) {
private static ObjectNode impExt(String publisherId, String supplySourceId) {
return mapper.valueToTree(ExtPrebid.of(null, ExtImpTheTradeDesk.of(publisherId, supplySourceId)));
}

}
Loading