-
Notifications
You must be signed in to change notification settings - Fork 175
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.
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
Tradplus #3508
base: master
Are you sure you want to change the base?
Tradplus #3508
Changes from 5 commits
4f2b2dd
6ee24b5
eed13bc
cef48a1
77816f0
5056de3
1891f43
f926559
b1a4e7a
00f8cd0
77e4074
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
package org.prebid.server.bidder.tradplus; | ||
|
||
import com.fasterxml.jackson.core.type.TypeReference; | ||
import com.fasterxml.jackson.databind.node.ObjectNode; | ||
import com.iab.openrtb.request.BidRequest; | ||
import com.iab.openrtb.request.Imp; | ||
import com.iab.openrtb.response.BidResponse; | ||
import com.iab.openrtb.response.SeatBid; | ||
import org.apache.commons.collections4.CollectionUtils; | ||
import org.apache.commons.lang3.StringUtils; | ||
import org.prebid.server.bidder.Bidder; | ||
import org.prebid.server.bidder.model.BidderBid; | ||
import org.prebid.server.bidder.model.BidderCall; | ||
import org.prebid.server.bidder.model.BidderError; | ||
import org.prebid.server.bidder.model.HttpRequest; | ||
import org.prebid.server.bidder.model.Result; | ||
import org.prebid.server.exception.PreBidException; | ||
import org.prebid.server.json.DecodeException; | ||
import org.prebid.server.json.JacksonMapper; | ||
import org.prebid.server.proto.openrtb.ext.ExtPrebid; | ||
import org.prebid.server.proto.openrtb.ext.request.tradplus.ExtImpTradPlus; | ||
import org.prebid.server.proto.openrtb.ext.response.BidType; | ||
import org.prebid.server.util.BidderUtil; | ||
import org.prebid.server.util.HttpUtil; | ||
|
||
import java.util.ArrayList; | ||
import java.util.Collection; | ||
import java.util.Collections; | ||
import java.util.HashMap; | ||
import java.util.List; | ||
import java.util.Map; | ||
import java.util.Objects; | ||
|
||
public class TradPlusBidder implements Bidder<BidRequest> { | ||
|
||
private static final TypeReference<ExtPrebid<?, ExtImpTradPlus>> EXT_TYPE_REFERENCE = | ||
new TypeReference<>() { | ||
}; | ||
|
||
private static final String ZONE_ID = "{{ZoneID}}"; | ||
private static final String ACCOUNT_ID = "{{AccountID}}"; | ||
|
||
private final String endpointUrl; | ||
private final JacksonMapper mapper; | ||
|
||
public TradPlusBidder(String endpointUrl, JacksonMapper mapper) { | ||
this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); | ||
this.mapper = Objects.requireNonNull(mapper); | ||
} | ||
|
||
@Override | ||
public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest bidRequest) { | ||
final Map<ExtImpTradPlus, List<Imp>> extToImps = new HashMap<>(); | ||
try { | ||
final ExtImpTradPlus extImpTradPlus = parseImpExt(bidRequest.getImp().getFirst().getExt()); | ||
validateImpExt(extImpTradPlus); | ||
extToImps.computeIfAbsent(extImpTradPlus, ext -> new ArrayList<>()).add(bidRequest.getImp().getFirst()); | ||
} catch (PreBidException e) { | ||
return Result.withError(BidderError.badInput(e.getMessage())); | ||
} | ||
|
||
final List<HttpRequest<BidRequest>> httpRequests = extToImps.entrySet().stream() | ||
.map(entry -> makeHttpRequest(entry.getKey(), entry.getValue(), bidRequest)) | ||
.toList(); | ||
|
||
return Result.withValues(httpRequests); | ||
} | ||
|
||
private ExtImpTradPlus parseImpExt(ObjectNode extNode) { | ||
final ExtImpTradPlus extImpTradPlus; | ||
try { | ||
extImpTradPlus = mapper.mapper().convertValue(extNode, EXT_TYPE_REFERENCE).getBidder(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. just return here There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done. |
||
} catch (IllegalArgumentException e) { | ||
throw new PreBidException(e.getMessage()); | ||
} | ||
return extImpTradPlus; | ||
} | ||
|
||
private void validateImpExt(ExtImpTradPlus extImpTradPlus) { | ||
if (StringUtils.isBlank(extImpTradPlus.getAccountId())) { | ||
throw new PreBidException("Invalid/Missing AccountID"); | ||
} | ||
} | ||
|
||
private HttpRequest<BidRequest> makeHttpRequest(ExtImpTradPlus extImpTradPlus, List<Imp> imps, | ||
BidRequest bidRequest) { | ||
final String uri = endpointUrl | ||
.replace(ZONE_ID, extImpTradPlus.getZoneId()) | ||
.replace(ACCOUNT_ID, extImpTradPlus.getAccountId()); | ||
|
||
final BidRequest outgoingRequest = bidRequest.toBuilder().imp(removeFirstImpExt(imps)).build(); | ||
|
||
return BidderUtil.defaultRequest(outgoingRequest, uri, mapper); | ||
} | ||
|
||
private static List<Imp> removeFirstImpExt(List<Imp> imps) { | ||
imps.set(0, imps.getFirst().toBuilder().ext(null).build()); | ||
return imps; | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this looks redundant since the list of imps always has a single imp There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have changed these codes,please review these codes. |
||
|
||
@Override | ||
public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) { | ||
try { | ||
final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); | ||
return Result.of(extractBids(bidResponse, httpCall.getRequest().getPayload()), Collections.emptyList()); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have changed these codes,please review these codes. |
||
} catch (DecodeException | PreBidException e) { | ||
return Result.withError(BidderError.badServerResponse(e.getMessage())); | ||
} | ||
} | ||
|
||
private static List<BidderBid> extractBids(BidResponse bidResponse, BidRequest bidRequest) { | ||
return bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid()) | ||
? Collections.emptyList() | ||
: bidsFromResponse(bidResponse, bidRequest.getImp()); | ||
} | ||
|
||
private static List<BidderBid> bidsFromResponse(BidResponse bidResponse, List<Imp> imps) { | ||
return bidResponse.getSeatbid().stream() | ||
.filter(Objects::nonNull) | ||
.map(SeatBid::getBid) | ||
.filter(Objects::nonNull) | ||
.flatMap(Collection::stream) | ||
.map(bid -> BidderBid.of(bid, getBidType(bid.getImpid(), imps), bidResponse.getCur())) | ||
.toList(); | ||
} | ||
|
||
private static BidType getBidType(String impId, List<Imp> imps) { | ||
for (Imp imp : imps) { | ||
if (imp.getId().equals(impId)) { | ||
if (imp.getVideo() != null) { | ||
return BidType.video; | ||
} | ||
if (imp.getXNative() != null) { | ||
return BidType.xNative; | ||
} | ||
return BidType.banner; | ||
} | ||
} | ||
throw new PreBidException("Invalid bid imp ID #%s does not match any imp IDs from the original bid request" | ||
.formatted(impId)); | ||
} | ||
|
||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
package org.prebid.server.proto.openrtb.ext.request.tradplus; | ||
|
||
import com.fasterxml.jackson.annotation.JsonProperty; | ||
import lombok.Value; | ||
|
||
@Value(staticConstructor = "of") | ||
public class ExtImpTradPlus { | ||
|
||
@JsonProperty("accountId") | ||
String accountId; | ||
|
||
@JsonProperty("zoneId") | ||
String zoneId; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
package org.prebid.server.spring.config.bidder; | ||
|
||
import org.prebid.server.bidder.BidderDeps; | ||
import org.prebid.server.bidder.tradplus.TradPlusBidder; | ||
import org.prebid.server.json.JacksonMapper; | ||
import org.prebid.server.spring.config.bidder.model.BidderConfigurationProperties; | ||
import org.prebid.server.spring.config.bidder.util.BidderDepsAssembler; | ||
import org.prebid.server.spring.config.bidder.util.UsersyncerCreator; | ||
import org.prebid.server.spring.env.YamlPropertySourceFactory; | ||
import org.springframework.beans.factory.annotation.Value; | ||
import org.springframework.boot.context.properties.ConfigurationProperties; | ||
import org.springframework.context.annotation.Bean; | ||
import org.springframework.context.annotation.Configuration; | ||
import org.springframework.context.annotation.PropertySource; | ||
|
||
import javax.validation.constraints.NotBlank; | ||
|
||
@Configuration | ||
@PropertySource(value = "classpath:/bidder-config/tradplus.yaml", factory = YamlPropertySourceFactory.class) | ||
public class TradPlusBidderConfiguration { | ||
|
||
private static final String BIDDER_NAME = "tradplus"; | ||
|
||
@Bean("tradplusConfigurationProperties") | ||
@ConfigurationProperties("adapters.tradplus") | ||
BidderConfigurationProperties configurationProperties() { | ||
return new BidderConfigurationProperties(); | ||
} | ||
|
||
@Bean | ||
BidderDeps tradplusBidderDeps(BidderConfigurationProperties tradplusConfigurationProperties, | ||
@NotBlank @Value("${external-url}") String externalUrl, | ||
JacksonMapper mapper) { | ||
|
||
return BidderDepsAssembler.forBidder(BIDDER_NAME) | ||
.withConfig(tradplusConfigurationProperties) | ||
.usersyncerCreator(UsersyncerCreator.create(externalUrl)) | ||
.bidderCreator(config -> new TradPlusBidder(config.getEndpoint(), mapper)) | ||
.assemble(); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
adapters: | ||
tradplus: | ||
endpoint: "https://{{ZoneID}}adx.tradplusad.com/{{AccountID}}/pserver" | ||
meta-info: | ||
maintainer-email: "[email protected]" | ||
app-media-types: | ||
- banner | ||
- video | ||
- native | ||
supported-vendors: | ||
vendor-id: 0 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"$schema": "http://json-schema.org/draft-04/schema#", | ||
"title": "TradPlus Adapter Params", | ||
"description": "A schema which validates params accepted by the TradPlus adapter", | ||
"type": "object", | ||
"properties": { | ||
"accountId": { | ||
"type": "string", | ||
"description": "Account ID", | ||
"minLength": 1 | ||
}, | ||
"zoneId": { | ||
"type": "string", | ||
"description": "Zone ID" | ||
} | ||
}, | ||
"required": [ | ||
"accountId", | ||
"zoneId" | ||
] | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
using a map here is an overhead since only one single imp is really utilized to retrieve the ext object, please get rid of it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have changed these codes,please review these codes.