-
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
Implement Outbrain bidder #1229
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
178 changes: 178 additions & 0 deletions
178
src/main/java/org/prebid/server/bidder/outbrain/OutbrainBidder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
package org.prebid.server.bidder.outbrain; | ||
|
||
import com.fasterxml.jackson.core.type.TypeReference; | ||
import com.iab.openrtb.request.App; | ||
import com.iab.openrtb.request.BidRequest; | ||
import com.iab.openrtb.request.Imp; | ||
import com.iab.openrtb.request.Publisher; | ||
import com.iab.openrtb.request.Site; | ||
import com.iab.openrtb.response.BidResponse; | ||
import com.iab.openrtb.response.SeatBid; | ||
import io.vertx.core.http.HttpMethod; | ||
import org.apache.commons.collections4.CollectionUtils; | ||
import org.prebid.server.bidder.Bidder; | ||
import org.prebid.server.bidder.model.BidderBid; | ||
import org.prebid.server.bidder.model.BidderError; | ||
import org.prebid.server.bidder.model.HttpCall; | ||
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.outbrains.ExtImpOutbrain; | ||
import org.prebid.server.proto.openrtb.ext.request.outbrains.ExtImpOutbrainPublisher; | ||
import org.prebid.server.proto.openrtb.ext.response.BidType; | ||
import org.prebid.server.util.HttpUtil; | ||
|
||
import java.util.ArrayList; | ||
import java.util.Collection; | ||
import java.util.Collections; | ||
import java.util.List; | ||
import java.util.Objects; | ||
import java.util.stream.Collectors; | ||
|
||
/** | ||
* Outbrain {@link Bidder} implementation. | ||
*/ | ||
public class OutbrainBidder implements Bidder<BidRequest> { | ||
|
||
private static final TypeReference<ExtPrebid<?, ExtImpOutbrain>> OUTBRAIN_EXT_TYPE_REFERENCE = | ||
new TypeReference<ExtPrebid<?, ExtImpOutbrain>>() { | ||
}; | ||
|
||
private final String endpointUrl; | ||
private final JacksonMapper mapper; | ||
|
||
public OutbrainBidder(String endpointUrl, JacksonMapper mapper) { | ||
this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); | ||
this.mapper = Objects.requireNonNull(mapper); | ||
} | ||
|
||
@Override | ||
public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest request) { | ||
final List<BidderError> errors = new ArrayList<>(); | ||
final List<Imp> modifiedImps = new ArrayList<>(); | ||
|
||
ExtImpOutbrain extImpOutbrain = null; | ||
for (Imp imp : request.getImp()) { | ||
try { | ||
extImpOutbrain = parseImpExt(imp); | ||
modifiedImps.add(modifyImp(imp, extImpOutbrain.getTagid())); | ||
} catch (PreBidException e) { | ||
errors.add(BidderError.badInput(e.getMessage())); | ||
} | ||
} | ||
|
||
if (!errors.isEmpty()) { | ||
return Result.withErrors(errors); | ||
} | ||
|
||
final BidRequest updatedRequest = updateBidRequest(request, modifiedImps, extImpOutbrain); | ||
|
||
return Result.of(Collections.singletonList( | ||
HttpRequest.<BidRequest>builder() | ||
.method(HttpMethod.POST) | ||
.uri(endpointUrl) | ||
.body(mapper.encode(updatedRequest)) | ||
.headers(HttpUtil.headers()) | ||
.payload(updatedRequest) | ||
.build()), errors); | ||
} | ||
|
||
private ExtImpOutbrain parseImpExt(Imp imp) { | ||
try { | ||
return mapper.mapper().convertValue(imp.getExt(), OUTBRAIN_EXT_TYPE_REFERENCE).getBidder(); | ||
} catch (IllegalArgumentException e) { | ||
throw new PreBidException(String.format("Impression id=%s, has invalid Ext", imp.getId())); | ||
} | ||
} | ||
|
||
private static Imp modifyImp(Imp imp, String tagId) { | ||
return imp.toBuilder() | ||
.tagid(tagId) | ||
.build(); | ||
} | ||
|
||
private static BidRequest updateBidRequest(BidRequest bidRequest, List<Imp> imps, ExtImpOutbrain extImpOutbrain) { | ||
final BidRequest.BidRequestBuilder bidRequestBuilder = bidRequest.toBuilder(); | ||
final ExtImpOutbrainPublisher extImpPublisher = extImpOutbrain.getPublisher(); | ||
final Publisher publisher = createPublisher(extImpPublisher); | ||
|
||
final Site site = bidRequest.getSite(); | ||
final App app = bidRequest.getApp(); | ||
if (bidRequest.getSite() != null) { | ||
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. Use site instead. |
||
bidRequestBuilder.site(updateSite(site, publisher)); | ||
} else if (bidRequest.getApp() != null) { | ||
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. Use app instead. |
||
bidRequestBuilder.app(updateApp(app, publisher)); | ||
} | ||
|
||
final List<String> bcat = extImpOutbrain.getBcat(); | ||
if (CollectionUtils.isNotEmpty(bcat)) { | ||
bidRequestBuilder.bcat(bcat); | ||
} | ||
|
||
final List<String> badv = extImpOutbrain.getBadv(); | ||
if (CollectionUtils.isNotEmpty(badv)) { | ||
bidRequestBuilder.badv(badv); | ||
} | ||
|
||
return bidRequestBuilder.imp(imps).build(); | ||
} | ||
|
||
private static Publisher createPublisher(ExtImpOutbrainPublisher extImpPublisher) { | ||
return Publisher.builder() | ||
.id(extImpPublisher.getId()) | ||
.name(extImpPublisher.getName()) | ||
.domain(extImpPublisher.getDomain()) | ||
.build(); | ||
} | ||
|
||
private static Site updateSite(Site site, Publisher publisher) { | ||
return site.toBuilder().publisher(publisher).build(); | ||
} | ||
|
||
private static App updateApp(App app, Publisher publisher) { | ||
return app.toBuilder().publisher(publisher).build(); | ||
} | ||
|
||
@Override | ||
public final Result<List<BidderBid>> makeBids(HttpCall<BidRequest> httpCall, BidRequest bidRequest) { | ||
try { | ||
final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); | ||
return Result.of(extractBids(httpCall.getRequest().getPayload(), bidResponse), Collections.emptyList()); | ||
} catch (DecodeException | PreBidException e) { | ||
return Result.withError(BidderError.badServerResponse(e.getMessage())); | ||
} | ||
} | ||
|
||
private static List<BidderBid> extractBids(BidRequest bidRequest, BidResponse bidResponse) { | ||
if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { | ||
return Collections.emptyList(); | ||
} | ||
return bidsFromResponse(bidRequest, bidResponse); | ||
} | ||
|
||
private static List<BidderBid> bidsFromResponse(BidRequest bidRequest, BidResponse bidResponse) { | ||
return bidResponse.getSeatbid().stream() | ||
.filter(Objects::nonNull) | ||
.map(SeatBid::getBid) | ||
.filter(Objects::nonNull) | ||
.flatMap(Collection::stream) | ||
.map(bid -> BidderBid.of(bid, getBidType(bid.getImpid(), bidRequest.getImp()), bidResponse.getCur())) | ||
.collect(Collectors.toList()); | ||
} | ||
|
||
private static BidType getBidType(String impId, List<Imp> imps) { | ||
for (Imp imp : imps) { | ||
if (imp.getId().equals(impId)) { | ||
if (imp.getXNative() != null) { | ||
return BidType.xNative; | ||
} else if (imp.getBanner() != null) { | ||
return BidType.banner; | ||
} | ||
} | ||
} | ||
throw new PreBidException(String.format("Failed to find native/banner impression \"%s\"", impId)); | ||
} | ||
} |
19 changes: 19 additions & 0 deletions
19
src/main/java/org/prebid/server/proto/openrtb/ext/request/outbrains/ExtImpOutbrain.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
package org.prebid.server.proto.openrtb.ext.request.outbrains; | ||
|
||
import lombok.AllArgsConstructor; | ||
import lombok.Value; | ||
|
||
import java.util.List; | ||
|
||
@Value | ||
@AllArgsConstructor(staticName = "of") | ||
public class ExtImpOutbrain { | ||
|
||
ExtImpOutbrainPublisher publisher; | ||
|
||
String tagid; | ||
|
||
List<String> bcat; | ||
|
||
List<String> badv; | ||
} |
15 changes: 15 additions & 0 deletions
15
...n/java/org/prebid/server/proto/openrtb/ext/request/outbrains/ExtImpOutbrainPublisher.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
package org.prebid.server.proto.openrtb.ext.request.outbrains; | ||
|
||
import lombok.AllArgsConstructor; | ||
import lombok.Value; | ||
|
||
@Value | ||
@AllArgsConstructor(staticName = "of") | ||
public class ExtImpOutbrainPublisher { | ||
|
||
String id; | ||
|
||
String name; | ||
|
||
String domain; | ||
} |
51 changes: 51 additions & 0 deletions
51
src/main/java/org/prebid/server/spring/config/bidder/OutbrainConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
package org.prebid.server.spring.config.bidder; | ||
|
||
import org.prebid.server.bidder.BidderDeps; | ||
import org.prebid.server.bidder.outbrain.OutbrainBidder; | ||
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.Autowired; | ||
import org.springframework.beans.factory.annotation.Qualifier; | ||
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/outbrain.yaml", factory = YamlPropertySourceFactory.class) | ||
public class OutbrainConfiguration { | ||
|
||
private static final String BIDDER_NAME = "outbrain"; | ||
|
||
@Value("${external-url}") | ||
@NotBlank | ||
private String externalUrl; | ||
|
||
@Autowired | ||
private JacksonMapper mapper; | ||
|
||
@Autowired | ||
@Qualifier("outbrainConfigurationProperties") | ||
private BidderConfigurationProperties configProperties; | ||
|
||
@Bean("outbrainConfigurationProperties") | ||
@ConfigurationProperties("adapters.outbrain") | ||
BidderConfigurationProperties configurationProperties() { | ||
return new BidderConfigurationProperties(); | ||
} | ||
|
||
@Bean | ||
BidderDeps outbrainBidderDeps() { | ||
return BidderDepsAssembler.forBidder(BIDDER_NAME) | ||
.withConfig(configProperties) | ||
.usersyncerCreator(UsersyncerCreator.create(externalUrl)) | ||
.bidderCreator(config -> new OutbrainBidder(config.getEndpoint(), mapper)) | ||
.assemble(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
adapters: | ||
outbrain: | ||
enabled: false | ||
endpoint: https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/ | ||
pbs-enforces-gdpr: true | ||
pbs-enforces-ccpa: true | ||
modifying-vast-xml-allowed: true | ||
deprecated-names: | ||
aliases: {} | ||
meta-info: | ||
maintainer-email: prog-ops-team@outbrain.com | ||
app-media-types: | ||
- banner | ||
- native | ||
site-media-types: | ||
- banner | ||
- native | ||
supported-vendors: | ||
vendor-id: 164 | ||
usersync: | ||
url: https://prebidtest.zemanta.com/usersync/prebidtest?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&cb= | ||
redirect-url: /setuid?bidder=outbrain&gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&uid=__ZUID__ | ||
cookie-family-name: outbrain | ||
type: redirect | ||
support-cors: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
{ | ||
"$schema": "http://json-schema.org/draft-04/schema#", | ||
"title": "Outbrain Adapter Params", | ||
"description": "A schema which validates params accepted by the Outbrain adapter", | ||
|
||
"type": "object", | ||
"properties": { | ||
"publisher": { | ||
"type": "object", | ||
"properties": { | ||
"id": { | ||
"type": "string" | ||
}, | ||
"name": { | ||
"type": "string" | ||
}, | ||
"domain": { | ||
"type": "string" | ||
} | ||
}, | ||
"required": ["id"] | ||
}, | ||
"tagid": { | ||
"type": "string" | ||
}, | ||
"bcat": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
}, | ||
"badv": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
} | ||
}, | ||
"required": ["publisher"] | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Can be inlined.