Skip to content

Bid Ranking #3977

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 8 commits into from
Jun 10, 2025
Merged

Bid Ranking #3977

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
06a5873
Bid Ranking
AntoxaAntoxic May 29, 2025
ae32b81
Fix tests failing
AntoxaAntoxic Jun 4, 2025
060fa97
Merge remote-tracking branch 'origin/master' into bid-ranking
AntoxaAntoxic Jun 4, 2025
b6d45f8
Fix comments
AntoxaAntoxic Jun 6, 2025
96c0727
Tests: Record a default core bid ranking (#3833)
osulzhenko Jun 10, 2025
da96959
Merge branch 'refs/heads/master' into bid-ranking
osulzhenko Jun 10, 2025
9effac7
fix merge conflicts
osulzhenko Jun 10, 2025
eee253e
Fix comments
AntoxaAntoxic Jun 10, 2025
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
163 changes: 82 additions & 81 deletions src/main/java/org/prebid/server/auction/BidResponseCreator.java
View file
Open in desktop
Comment thread
AntoxaAntoxic marked this conversation as resolved.
Comment thread
AntoxaAntoxic marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.tuple.Pair;
import org.prebid.server.auction.categorymapping.CategoryMappingService;
import org.prebid.server.auction.model.AuctionContext;
import org.prebid.server.auction.model.AuctionParticipation;
Expand Down Expand Up @@ -115,9 +116,9 @@
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
Expand Down Expand Up @@ -645,11 +646,10 @@ private Future<BidResponse> cacheBidsAndCreateResponse(List<BidderResponseInfo>

final ExtRequestTargeting targeting = targeting(bidRequest);

final List<BidderResponseInfo> bidderResponseInfos = injectWithTargetingAndBidRanking(
final List<BidderResponseInfo> bidderResponseInfos = toBidderResponseWithTargetingBidInfos(
bidderResponses,
bidderToMultiBids,
preferDeals(targeting),
isBidRankingEnabled(auctionContext.getAccount()));
preferDeals(targeting));

final Set<BidInfo> bidInfos = bidderResponseInfos.stream()
.map(BidderResponseInfo::getSeatBid)
Expand Down Expand Up @@ -687,96 +687,86 @@ private static boolean preferDeals(ExtRequestTargeting targeting) {
return BooleanUtils.toBooleanDefaultIfNull(targeting != null ? targeting.getPreferdeals() : null, false);
}

private static boolean isBidRankingEnabled(Account account) {
return Optional.ofNullable(account.getAuction())
.map(AccountAuctionConfig::getRanking)
.map(AccountBidRankingConfig::getEnabled)
.orElse(false);
}

private List<BidderResponseInfo> injectWithTargetingAndBidRanking(
private List<BidderResponseInfo> toBidderResponseWithTargetingBidInfos(
List<BidderResponseInfo> bidderResponses,
Map<String, MultiBidConfig> bidderToMultiBids,
boolean preferDeals,
boolean isBidRankingEnabled) {
boolean preferDeals) {

final Map<BidderResponseInfo, List<BidInfo>> bidderResponseToReducedBidInfos = bidderResponses.stream()
.collect(Collectors.toMap(
Function.identity(),
bidderResponse -> toSortedMultiBidInfo(bidderResponse, bidderToMultiBids, preferDeals)));
final Comparator<BidInfo> comparator = winningBidComparatorFactory.create(preferDeals).reversed();

final Map<String, List<BidInfo>> impIdToBidInfos = bidderResponseToReducedBidInfos.values()
.stream()
.flatMap(Collection::stream)
.collect(Collectors.groupingBy(
bidInfo -> bidInfo.getCorrespondingImp().getId(),
Collectors.collectingAndThen(Collectors.toList(), bidInfos -> bidInfos.stream()
.sorted(winningBidComparatorFactory.create(preferDeals).reversed())
.toList())));

final Set<BidInfo> winningBids = new HashSet<>();
final Map<String, Map<String, List<BidInfo>>> seatToBidderToBids = new HashMap<>();

for (final List<BidInfo> bidInfos : impIdToBidInfos.values()) {
final List<BidInfo> bidsWithRanking = isBidRankingEnabled
? IntStream.range(0, bidInfos.size())
.mapToObj(i -> bidInfos.get(i).toBuilder().rank(i + 1).build())
.toList()
: bidInfos;

if (!bidsWithRanking.isEmpty()) {
winningBids.add(bidsWithRanking.getFirst());
bidsWithRanking.forEach(bidInfo ->
seatToBidderToBids.computeIfAbsent(bidInfo.getSeat(), k -> new HashMap<>())
.computeIfAbsent(bidInfo.getBidder(), k -> new ArrayList<>()).add(bidInfo));
}
}
final List<List<BidInfo>> bidInfosPerBidder = bidderResponses.stream()
.map(bidderResponse -> limitMultiBid(bidderResponse, bidderToMultiBids, comparator))
.toList();
final List<List<BidInfo>> rankedBidInfos = applyRanking(bidInfosPerBidder, comparator);

return bidderResponseToReducedBidInfos.keySet().stream()
.map(bidderResponseInfo -> injectBidInfoWithTargeting(
bidderResponseInfo,
bidderToMultiBids,
seatToBidderToBids.getOrDefault(bidderResponseInfo.getSeat(), Collections.emptyMap())
.getOrDefault(bidderResponseInfo.getBidder(), Collections.emptyList()),
winningBids))
return IntStream.range(0, bidderResponses.size())
.mapToObj(i -> enrichBidInfoWithTargeting(
bidderResponses.get(i),
rankedBidInfos.get(i),
bidderToMultiBids))
.toList();
}

private List<BidInfo> toSortedMultiBidInfo(BidderResponseInfo bidderResponse,
private static List<BidInfo> limitMultiBid(BidderResponseInfo bidderResponse,
Map<String, MultiBidConfig> bidderToMultiBids,
boolean preferDeals) {
Comparator<BidInfo> comparator) {

final MultiBidConfig multiBid = bidderToMultiBids.get(bidderResponse.getBidder());
final Integer bidLimit = multiBid != null ? multiBid.getMaxBids() : DEFAULT_BID_LIMIT_MIN;

final List<BidInfo> bidInfos = bidderResponse.getSeatBid().getBidsInfos();
final Map<String, List<BidInfo>> impIdToBidInfos = bidInfos.stream()
.collect(Collectors.groupingBy(bidInfo -> bidInfo.getCorrespondingImp().getId()));

final MultiBidConfig multiBid = bidderToMultiBids.get(bidderResponse.getBidder());
final Integer bidLimit = multiBid != null ? multiBid.getMaxBids() : DEFAULT_BID_LIMIT_MIN;

return impIdToBidInfos.values().stream()
.map(infos -> sortReducedBidInfo(infos, bidLimit, preferDeals))
.flatMap(Collection::stream)
.flatMap(infos -> infos.stream()
.sorted(comparator)
.limit(bidLimit))
.toList();
}

private List<BidInfo> sortReducedBidInfo(List<BidInfo> bidInfos, int limit, boolean preferDeals) {
return bidInfos.stream()
.sorted(winningBidComparatorFactory.create(preferDeals).reversed())
.limit(limit)
.toList();
private static List<List<BidInfo>> applyRanking(List<List<BidInfo>> bidInfosPerBidder,
Comparator<BidInfo> comparator) {

final Map<String, List<Pair<Integer, BidInfo>>> impIdToBidderBidInfo = new HashMap<>();
for (int bidderIndex = 0; bidderIndex < bidInfosPerBidder.size(); bidderIndex++) {
final List<BidInfo> bidInfos = bidInfosPerBidder.get(bidderIndex);

for (final BidInfo bidInfo : bidInfos) {
Comment thread
AntoxaAntoxic marked this conversation as resolved.
Outdated
impIdToBidderBidInfo
.computeIfAbsent(bidInfo.getCorrespondingImp().getId(), ignore -> new ArrayList<>())
.add(Pair.of(bidderIndex, bidInfo));
}
}

for (List<Pair<Integer, BidInfo>> bidderToBidInfo : impIdToBidderBidInfo.values()) {
bidderToBidInfo.sort(Comparator.comparing(Pair::getRight, comparator));
}

final List<List<BidInfo>> rankedBidInfosPerBidder = new ArrayList<>();
for (int i = 0; i < bidInfosPerBidder.size(); i++) {
rankedBidInfosPerBidder.add(new ArrayList<>());
}

for (List<Pair<Integer, BidInfo>> sortedBidderToBidInfo : impIdToBidderBidInfo.values()) {
for (int rank = 0; rank < sortedBidderToBidInfo.size(); rank++) {
final Pair<Integer, BidInfo> bidderToBidInfo = sortedBidderToBidInfo.get(rank);
final BidInfo bidInfo = bidderToBidInfo.getRight();

rankedBidInfosPerBidder.get(bidderToBidInfo.getLeft())
.add(bidInfo.toBuilder().rank(rank + 1).build());
}
}

return rankedBidInfosPerBidder;
}

private static BidderResponseInfo injectBidInfoWithTargeting(BidderResponseInfo bidderResponseInfo,
Map<String, MultiBidConfig> bidderToMultiBids,
private static BidderResponseInfo enrichBidInfoWithTargeting(BidderResponseInfo bidderResponseInfo,
List<BidInfo> bidderBidInfos,
Set<BidInfo> winningBids) {
Map<String, MultiBidConfig> bidderToMultiBids) {

final String bidder = bidderResponseInfo.getBidder();
final List<BidInfo> bidInfosWithTargeting = toBidInfoWithTargeting(
bidderBidInfos,
bidder,
bidderToMultiBids,
winningBids);
final List<BidInfo> bidInfosWithTargeting = toBidInfoWithTargeting(bidderBidInfos, bidder, bidderToMultiBids);

final BidderSeatBidInfo seatBid = bidderResponseInfo.getSeatBid();
final BidderSeatBidInfo modifiedSeatBid = seatBid.with(bidInfosWithTargeting);
Expand All @@ -785,22 +775,20 @@ private static BidderResponseInfo injectBidInfoWithTargeting(BidderResponseInfo

private static List<BidInfo> toBidInfoWithTargeting(List<BidInfo> bidderBidInfos,
String bidder,
Map<String, MultiBidConfig> bidderToMultiBids,
Set<BidInfo> winningBids) {
Map<String, MultiBidConfig> bidderToMultiBids) {

final Map<String, List<BidInfo>> impIdToBidInfos = bidderBidInfos.stream()
.collect(Collectors.groupingBy(bidInfo -> bidInfo.getCorrespondingImp().getId()));

return impIdToBidInfos.values().stream()
.map(bidInfos -> injectTargeting(bidInfos, bidder, bidderToMultiBids, winningBids))
.map(bidInfos -> enrichWithTargeting(bidInfos, bidder, bidderToMultiBids))
.flatMap(Collection::stream)
.toList();
}

private static List<BidInfo> injectTargeting(List<BidInfo> bidderImpIdBidInfos,
String bidder,
Map<String, MultiBidConfig> bidderToMultiBids,
Set<BidInfo> winningBids) {
private static List<BidInfo> enrichWithTargeting(List<BidInfo> bidderImpIdBidInfos,
String bidder,
Map<String, MultiBidConfig> bidderToMultiBids) {

final List<BidInfo> result = new ArrayList<>();

Expand All @@ -815,7 +803,7 @@ private static List<BidInfo> injectTargeting(List<BidInfo> bidderImpIdBidInfos,

final TargetingInfo targetingInfo = TargetingInfo.builder()
.isTargetingEnabled(targetingBidderCode != null)
.isWinningBid(winningBids.contains(bidInfo))
.isWinningBid(bidInfo.getRank() == 1)
.isAddTargetBidderCode(targetingBidderCode != null && multiBidSize > 1)
.bidderCode(targetingBidderCode)
.seat(targetingCode(bidInfo.getSeat(), bidderCodePrefix, i))
Expand All @@ -829,7 +817,11 @@ private static List<BidInfo> injectTargeting(List<BidInfo> bidderImpIdBidInfos,
}

private static String targetingCode(String base, String prefix, int i) {
return i == 0 ? base : prefix != null ? prefix + (i + 1) : null;
if (i == 0) {
return base;
}

return prefix != null ? prefix + (i + 1) : null;
}

private ExtBidResponse toExtBidResponse(List<BidderResponseInfo> bidderResponseInfos,
Expand Down Expand Up @@ -1585,6 +1577,8 @@ private Bid toBid(BidInfo bidInfo,
final ObjectNode originalBidExt = bid.getExt();
final Boolean dealsTierSatisfied = bidInfo.getSatisfiedPriority();

final boolean bidRankingEnabled = isBidRankingEnabled(account);

final ExtBidPrebid updatedExtBidPrebid =
getExtPrebid(originalBidExt, ExtBidPrebid.class)
.map(ExtBidPrebid::toBuilder)
Expand All @@ -1594,7 +1588,7 @@ private Bid toBid(BidInfo bidInfo,
.dealTierSatisfied(dealsTierSatisfied)
.cache(cache)
.passThrough(extractPassThrough(bidInfo.getCorrespondingImp()))
.rank(bidInfo.getRank())
.rank(bidRankingEnabled ? bidInfo.getRank() : null)
.build();

final ObjectNode updatedBidExt =
Expand Down Expand Up @@ -1624,6 +1618,13 @@ private JsonNode extractPassThrough(Imp imp) {
.orElse(null);
}

private static boolean isBidRankingEnabled(Account account) {
return Optional.ofNullable(account.getAuction())
.map(AccountAuctionConfig::getRanking)
.map(AccountBidRankingConfig::getEnabled)
.orElse(false);
}

private String createNativeMarkup(String bidAdm, Imp correspondingImp) {
final Response nativeMarkup;
try {
Expand Down
64 changes: 34 additions & 30 deletions src/test/java/org/prebid/server/auction/BidResponseCreatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@
import org.prebid.server.proto.openrtb.ext.request.ExtRequestTargeting;
import org.prebid.server.proto.openrtb.ext.request.ExtStoredRequest;
import org.prebid.server.proto.openrtb.ext.request.TraceLevel;
import org.prebid.server.proto.openrtb.ext.response.BidType;
import org.prebid.server.proto.openrtb.ext.response.CacheAsset;
import org.prebid.server.proto.openrtb.ext.response.Events;
import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid;
Expand Down Expand Up @@ -162,7 +161,6 @@
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.prebid.server.proto.openrtb.ext.request.ExtRequestPrebidAdservertargetingRule.Source.xStatic;
import static org.prebid.server.proto.openrtb.ext.response.BidType.audio;
Expand Down Expand Up @@ -305,8 +303,22 @@ public void shouldPassBidWithGeneratedIdAndPreserveExtFieldsWhenIdGeneratorTypeU
.put("origbidcur", "test")
.set("prebid", mapper.valueToTree(extBidPrebid)))
.build();
final BidInfo bidInfo = toBidInfo(expectedBid, imp, bidder, "seat", banner, true);
verify(coreCacheService).cacheBidsOpenrtb(eq(singletonList(bidInfo)), any(), any(), any());
final BidInfo expectedBidInfo = BidInfo.builder()
.bid(expectedBid)
.correspondingImp(imp)
.bidder("bidder1")
.seat("seat")
.bidType(banner)
.targetingInfo(TargetingInfo.builder()
.bidderCode("bidder1")
.seat("seat")
.isTargetingEnabled(true)
.isWinningBid(true)
.isAddTargetBidderCode(false)
.build())
.rank(1)
.build();
verify(coreCacheService).cacheBidsOpenrtb(eq(singletonList(expectedBidInfo)), any(), any(), any());
}

@Test
Expand Down Expand Up @@ -956,7 +968,22 @@ public void shouldUseGeneratedBidIdForEventAndCacheWhenIdGeneratorIsUUIDAndEvent
.ext(mapper.createObjectNode().set("prebid", mapper.valueToTree(extBidPrebid)))
.build();

final BidInfo expectedBidInfo = toBidInfo(expectedBid, imp, bidder, "seat", banner, true);
final BidInfo expectedBidInfo = BidInfo.builder()
.bid(expectedBid)
.correspondingImp(imp)
.bidder("bidder1")
.seat("seat")
.bidType(banner)
.targetingInfo(TargetingInfo.builder()
.bidderCode("bidder1")
.seat("seat")
.isTargetingEnabled(true)
.isWinningBid(true)
.isAddTargetBidderCode(false)
.build())
.rank(1)
.build();

verify(coreCacheService).cacheBidsOpenrtb(eq(singletonList(expectedBidInfo)), any(), any(), any());

verify(eventsService).createEvent(eq(generatedBidId), anyString(), anyString(), anyBoolean(), any());
Expand Down Expand Up @@ -1831,7 +1858,7 @@ public void shouldPassPreferDealsToWinningComparatorFactoryWhenBidRequestTrue()
target.create(auctionContext, CACHE_INFO, MULTI_BIDS).result();

// then
verify(winningBidComparatorFactory, times(2)).create(eq(true));
verify(winningBidComparatorFactory).create(eq(true));
}

@Test
Expand All @@ -1851,7 +1878,7 @@ public void shouldPassPreferDealsFalseWhenBidRequestPreferDealsIsNotDefined() {
target.create(auctionContext, CACHE_INFO, MULTI_BIDS).result();

// then
verify(winningBidComparatorFactory, times(2)).create(eq(false));
verify(winningBidComparatorFactory).create(eq(false));
}

@Test
Expand Down Expand Up @@ -5640,29 +5667,6 @@ private static Map<Bid, CacheInfo> zipBidsWithCacheInfos(List<BidInfo> bidInfos,
.collect(Collectors.toMap(i -> bidInfos.get(i).getBid(), cacheInfos::get));
}

private static BidInfo toBidInfo(Bid bid,
Imp correspondingImp,
String bidder,
String seat,
BidType bidType,
boolean isWinningBid) {

return BidInfo.builder()
.bid(bid)
.correspondingImp(correspondingImp)
.bidder(bidder)
.seat(seat)
.bidType(bidType)
.targetingInfo(TargetingInfo.builder()
.bidderCode(bidder)
.seat(seat)
.isTargetingEnabled(true)
.isWinningBid(isWinningBid)
.isAddTargetBidderCode(false)
.build())
.build();
}

private static Imp givenImp() {
return givenImp(IMP_ID);
}
Expand Down
Loading