Readpeak: New adapter (#3198)

src/main/java/org/prebid/server/bidder/readpeak/ReadPeakBidder.java

@@ -0,0 +1,223 @@
+package org.prebid.server.bidder.readpeak;
+
+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.Bid;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.lang3.ObjectUtils;
+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.readpeak.ExtImpReadPeak;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid;
+import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebidMeta;
+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;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+public class ReadPeakBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpReadPeak>> READPEAK_EXT_TYPE_REFERENCE =
+            new TypeReference<>() {
+            };
+
+    private static final TypeReference<ExtPrebid<ExtBidPrebid, ?>> EXT_PREBID_TYPE_REFERENCE =
+            new TypeReference<>() {
+            };
+
+    private static final String PRICE_MACRO = "${AUCTION_PRICE}";
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public ReadPeakBidder(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<Imp> modifiedImps = new ArrayList<>();
+        final List<BidderError> errors = new ArrayList<>();
+
+        ExtImpReadPeak extImp = null;
+        for (Imp imp : request.getImp()) {
+            try {
+                extImp = parseImpExt(imp);
+                final Imp modifiedImp = modifyImp(imp, extImp);
+                modifiedImps.add(modifiedImp);
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        if (modifiedImps.isEmpty()) {
+            return Result.withError(BidderError.badInput(
+                    String.format("Failed to find compatible impressions for request %s", request.getId())));
+        }
+
+        final BidRequest modifiedRequest = request.toBuilder().imp(modifiedImps).build();
+        final HttpRequest<BidRequest> httpRequest = makeHttpRequest(modifiedRequest, extImp);
+
+        return Result.of(Collections.singletonList(httpRequest), errors);
+    }
+
+    private ExtImpReadPeak parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), READPEAK_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("Failed to deserialize ReadPeak extension: " + e.getMessage());
+        }
+    }
+
+    private Imp modifyImp(Imp imp, ExtImpReadPeak extImpReadPeak) {
+        return imp.toBuilder()
+                .bidfloor(extImpReadPeak.getBidFloor() != null ? extImpReadPeak.getBidFloor() : imp.getBidfloor())
+                .tagid(StringUtils.isNotBlank(extImpReadPeak.getTagId()) ? extImpReadPeak.getTagId() : imp.getTagid())
+                .build();
+    }
+
+    private static Site modifySite(Site site, String siteId, Publisher publisher) {
+        return site.toBuilder()
+                .id(StringUtils.isNotBlank(siteId) ? siteId : site.getId())
+                .publisher(publisher)
+                .build();
+    }
+
+    private static App modifyApp(App app, ExtImpReadPeak extImp, Publisher publisher) {
+        return app.toBuilder()
+                .id(StringUtils.isNotBlank(extImp.getSiteId()) ? extImp.getSiteId() : app.getId())
+                .publisher(publisher)
+                .build();
+    }
+
+    private HttpRequest<BidRequest> makeHttpRequest(BidRequest request, ExtImpReadPeak extImp) {
+        final Publisher publisher = Publisher.builder().id(extImp.getPublisherId()).build();
+
+        final boolean hasSite = request.getSite() != null;
+        final boolean hasApp = !hasSite && request.getApp() != null;
+
+        final BidRequest outgoingRequest = request.toBuilder()
+                .site(hasSite ? modifySite(request.getSite(), extImp.getSiteId(), publisher) : null)
+                .app(hasApp ? modifyApp(request.getApp(), extImp, publisher) : null)
+                .build();
+
+        return BidderUtil.defaultRequest(outgoingRequest, endpointUrl, mapper);
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
+        final List<BidderError> errors = new ArrayList<>();
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            return Result.of(extractBids(bidResponse, errors), errors);
+        } catch (DecodeException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private List<BidderBid> extractBids(BidResponse bidResponse, List<BidderError> errors) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+        return bidsFromResponse(bidResponse, errors);
+    }
+
+    private List<BidderBid> bidsFromResponse(BidResponse bidResponse, List<BidderError> errors) {
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(Collection::stream)
+                .map(bid -> makeBid(bid, bidResponse.getCur(), errors))
+                .filter(Objects::nonNull)
+                .toList();
+    }
+
+    private BidderBid makeBid(Bid bid, String currency, List<BidderError> errors) {
+        try {
+            final Bid resolvedBid = resolveMacros(bid);
+            final BidType bidType = getBidType(bid);
+            final Bid updatedBid = addBidMeta(resolvedBid);
+            return BidderBid.of(updatedBid, bidType, currency);
+        } catch (PreBidException e) {
+            errors.add(BidderError.badInput(e.getMessage()));
+            return null;
+        }
+
+    }
+
+    private static Bid resolveMacros(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))
+                .burl(StringUtils.replace(bid.getBurl(), PRICE_MACRO, priceAsString))
+                .build();
+    }
+
+    private static BidType getBidType(Bid bid) {
+        final Integer markupType = ObjectUtils.defaultIfNull(bid.getMtype(), 0);
+
+        return switch (markupType) {
+            case 1 -> BidType.banner;
+            case 4 -> BidType.xNative;
+            default -> throw new PreBidException(
+                    "Unable to fetch mediaType " + bid.getMtype() + " in multi-format: " + bid.getImpid());
+        };
+    }
+
+    private Bid addBidMeta(Bid bid) {
+        final ExtBidPrebid prebid = parseExtBidPrebid(bid);
+
+        final ExtBidPrebidMeta modifiedMeta = Optional.ofNullable(prebid).map(ExtBidPrebid::getMeta)
+                .map(ExtBidPrebidMeta::toBuilder)
+                .orElseGet(ExtBidPrebidMeta::builder)
+                .advertiserDomains(bid.getAdomain())
+                .build();
+
+        final ExtBidPrebid modifiedPrebid = Optional.ofNullable(prebid)
+                .map(ExtBidPrebid::toBuilder)
+                .orElseGet(ExtBidPrebid::builder)
+                .meta(modifiedMeta)
+                .build();
+
+        return bid.toBuilder()
+                .ext(mapper.mapper().valueToTree(ExtPrebid.of(modifiedPrebid, null)))
+                .build();
+    }
+
+    private ExtBidPrebid parseExtBidPrebid(Bid bid) {
+        try {
+            return Optional.ofNullable(mapper.mapper().convertValue(bid.getExt(), EXT_PREBID_TYPE_REFERENCE))
+                    .map(ExtPrebid::getPrebid)
+                    .orElse(null);
+        } catch (IllegalArgumentException e) {
+            return null;
+        }
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/readpeak/ExtImpReadPeak.java

@@ -0,0 +1,22 @@
+package org.prebid.server.proto.openrtb.ext.request.readpeak;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+import java.math.BigDecimal;
+
+@Value(staticConstructor = "of")
+public class ExtImpReadPeak {
+
+    @JsonProperty("publisherId")
+    String publisherId;
+
+    @JsonProperty("siteId")
+    String siteId;
+
+    @JsonProperty("bidfloor")
+    BigDecimal bidFloor;
+
+    @JsonProperty("tagId")
+    String tagId;
+}

src/main/java/org/prebid/server/spring/config/bidder/ReadPeakConfiguration.java

@@ -0,0 +1,41 @@
+package org.prebid.server.spring.config.bidder;
+
+import org.prebid.server.bidder.BidderDeps;
+import org.prebid.server.bidder.readpeak.ReadPeakBidder;
+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 jakarta.validation.constraints.NotBlank;
+
+@Configuration
+@PropertySource(value = "classpath:/bidder-config/readpeak.yaml", factory = YamlPropertySourceFactory.class)
+public class ReadPeakConfiguration {
+
+    private static final String BIDDER_NAME = "readpeak";
+
+    @Bean("readpeakConfigurationProperties")
+    @ConfigurationProperties("adapters.readpeak")
+    BidderConfigurationProperties configurationProperties() {
+        return new BidderConfigurationProperties();
+    }
+
+    @Bean
+    BidderDeps readpeakBidderDeps(BidderConfigurationProperties readpeakConfigurationProperties,
+                                  @NotBlank @Value("${external-url}") String externalUrl,
+                                  JacksonMapper mapper) {
+
+        return BidderDepsAssembler.forBidder(BIDDER_NAME)
+                .withConfig(readpeakConfigurationProperties)
+                .usersyncerCreator(UsersyncerCreator.create(externalUrl))
+                .bidderCreator(config -> new ReadPeakBidder(config.getEndpoint(), mapper))
+                .assemble();
+    }
+}

src/main/resources/bidder-config/readpeak.yaml

@@ -0,0 +1,15 @@
+adapters:
+  readpeak:
+    endpoint: https://dsp.readpeak.com/header/prebid
+    geoscope:
+      - EEA
+    meta-info:
+      maintainer-email: devteam@readpeak.com
+      app-media-types:
+        - banner
+        - native
+      site-media-types:
+        - banner
+        - native
+      supported-vendors:
+      vendor-id: 290

src/main/resources/static/bidder-params/readpeak.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Readpeak Adapter Params",
+  "description": "A schema which validates params accepted by the Readpeak adapter",
+  "type": "object",
+  "properties": {
+    "publisherId": {
+      "type": "string",
+      "description": "Publisher ID provided by Readpeak"
+    },
+    "siteId": {
+      "type": "string",
+      "description": "Site/Media ID provided by Readpeak"
+    },
+    "bidfloor": {
+      "type": "number",
+      "description": "CPM Bid Floor"
+    },
+    "tagId": {
+      "type": "string",
+      "description": "Ad placement identifier"
+    }
+  },
+  "required": ["publisherId"]
+}