Connatix: Port adapter from PBS-Go

src/main/java/org/prebid/server/bidder/connatix/ConnatixBidder.java

@@ -0,0 +1,262 @@
+package org.prebid.server.bidder.connatix;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.iab.openrtb.request.App;
+import com.iab.openrtb.request.Banner;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Device;
+import com.iab.openrtb.request.Format;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.response.Bid;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+import io.vertx.core.MultiMap;
+import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.collections4.ListUtils;
+import org.apache.commons.lang3.ObjectUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.prebid.server.bidder.Bidder;
+import org.prebid.server.bidder.connatix.proto.ConnatixImpExtBidder;
+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.Price;
+import org.prebid.server.bidder.model.Result;
+import org.prebid.server.currency.CurrencyConversionService;
+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.ExtApp;
+import org.prebid.server.proto.openrtb.ext.request.ExtAppPrebid;
+import org.prebid.server.proto.openrtb.ext.request.connatix.ExtImpConnatix;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+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 ConnatixBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpConnatix>> CONNATIX_EXT_TYPE_REFERENCE =
+            new TypeReference<>() {
+            };
+
+    private static final int MAX_IMPS_PER_REQUEST = 1;
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    private static final String BIDDER_CURRENCY = "USD";
+
+    private final CurrencyConversionService currencyConversionService;
+
+    public ConnatixBidder(String endpointUrl,
+                          CurrencyConversionService currencyConversionService,
+                          JacksonMapper mapper) {
+        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
+        this.currencyConversionService = currencyConversionService;
+        this.mapper = Objects.requireNonNull(mapper);
+    }
+
+    @Override
+    public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest request) {
+        // Device IP required - bounce if not available
+        if (request.getDevice() == null
+                || (request.getDevice().getIp() == null && request.getDevice().getIpv6() == null)) {
+            return Result.withError(BidderError.badInput("Device IP is required"));
+        }
+
+        final String displayManagerVer = buildDisplayManagerVersion(request);
+        final MultiMap headers = resolveHeaders(request.getDevice());
+
+        final List<Imp> modifiedImps = new ArrayList<>();
+        final List<BidderError> errors = new ArrayList<>();
+
+        for (Imp imp : request.getImp()) {
+            final ExtImpConnatix extImpConnatix;
+            final Price bidFloorPrice;
+            try {
+                extImpConnatix = parseExtImp(imp);
+                bidFloorPrice = convertBidFloor(imp, request);
+                final Imp modifiedImp = modifyImp(imp, extImpConnatix, displayManagerVer, bidFloorPrice);
+
+                modifiedImps.add(modifiedImp);
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        if (modifiedImps.isEmpty()) {
+            return Result.withErrors(errors);
+        }
+
+        final List<HttpRequest<BidRequest>> httpRequests = splitHttpRequests(request, modifiedImps, headers);
+
+        return Result.withValues(httpRequests);
+    }
+
+    private Imp modifyImp(Imp imp, ExtImpConnatix extImpConnatix, String displayManagerVer, Price bidFloorPrice) {
+        final ConnatixImpExtBidder impExtBidder = resolveImpExt(extImpConnatix);
+
+        final ObjectNode impExtBidderNode = mapper.mapper().valueToTree(impExtBidder);
+
+        final ObjectNode modifiedImpExtBidder = imp.getExt() != null ? imp.getExt().deepCopy()
+                : mapper.mapper().createObjectNode();
+
+        modifiedImpExtBidder.setAll(impExtBidderNode);
+
+        return imp.toBuilder()
+                .ext(modifiedImpExtBidder)
+                .banner(modifyImpBanner(imp.getBanner()))
+                .displaymanagerver(!StringUtils.isEmpty(imp.getDisplaymanagerver())
+                        ? imp.getDisplaymanagerver() : displayManagerVer)
+                .bidfloor(bidFloorPrice.getValue())
+                .bidfloorcur(bidFloorPrice.getCurrency())
+                .build();
+    }
+
+    private Banner modifyImpBanner(Banner banner) {
+        if (banner == null) {
+            return null;
+        }
+
+        if (banner.getW() == null && banner.getH() == null && !CollectionUtils.isEmpty(banner.getFormat())) {
+            final Format firstFormat = banner.getFormat().getFirst();
+            return banner.toBuilder()
+                    .w(firstFormat.getW())
+                    .h(firstFormat.getH())
+                    .build();
+        }
+        return banner;
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            final List<BidderBid> bids = extractBids(httpCall.getRequest().getPayload(), bidResponse);
+
+            return Result.withValues(bids);
+        } catch (DecodeException | PreBidException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private Price convertBidFloor(Imp imp, BidRequest bidRequest) {
+        final Price initialBidFloorPrice = Price.of(imp.getBidfloorcur(), imp.getBidfloor());
+        if (BidderUtil.isValidPrice(initialBidFloorPrice)) {
+            try {
+                final BigDecimal convertedPrice = currencyConversionService
+                        .convertCurrency(imp.getBidfloor(), bidRequest, imp.getBidfloorcur(), BIDDER_CURRENCY);
+                return Price.of(BIDDER_CURRENCY, convertedPrice);
+            } catch (PreBidException e) {
+                throw new PreBidException("Unable to convert provided bid floor currency from %s to %s for imp `%s`"
+                        .formatted(imp.getBidfloorcur(), BIDDER_CURRENCY, imp.getId()));
+            }
+        }
+        return initialBidFloorPrice;
+    }
+
+    // extract bids
+    private static List<BidderBid> extractBids(BidRequest bidRequest, BidResponse bidResponse) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(Collection::stream)
+                .filter(Objects::nonNull)
+                .map(bid -> BidderBid.of(bid, getBidType(bid), bidResponse.getCur()))
+                .toList();
+    }
+
+    // parseExtImp
+    private ExtImpConnatix parseExtImp(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), CONNATIX_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException(e.getMessage());
+        }
+    }
+
+    private ConnatixImpExtBidder resolveImpExt(ExtImpConnatix extImpConnatix) {
+        final ConnatixImpExtBidder.ConnatixImpExtBidderBuilder builder = ConnatixImpExtBidder.builder();
+        if (StringUtils.isNotEmpty(extImpConnatix.getPlacementId())) {
+            builder.placementId(extImpConnatix.getPlacementId());
+        }
+        if (extImpConnatix.getViewabilityPercentage() != null) {
+            builder.viewabilityPercentage(extImpConnatix.getViewabilityPercentage());
+        }
+
+        return builder.build();
+    }
+
+    private HttpRequest<BidRequest> makeHttpRequest(BidRequest request, List<Imp> impsChunk, MultiMap headers) {
+        final BidRequest outgoingRequest = request.toBuilder()
+                .imp(impsChunk)
+                .cur(List.of(BIDDER_CURRENCY))
+                .build();
+
+        return BidderUtil.defaultRequest(outgoingRequest, headers, endpointUrl, mapper);
+    }
+
+    private List<HttpRequest<BidRequest>> splitHttpRequests(BidRequest bidRequest,
+                                                            List<Imp> imps,
+                                                            MultiMap headers) {
+        return ListUtils.partition(imps, MAX_IMPS_PER_REQUEST)
+                .stream()
+                .map(impsChunk -> makeHttpRequest(bidRequest, impsChunk, headers))
+                .toList();
+    }
+
+    private MultiMap resolveHeaders(Device device) {
+        final MultiMap headers = HttpUtil.headers();
+        if (device != null) {
+            HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.USER_AGENT_HEADER, device.getUa());
+            HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.X_FORWARDED_FOR_HEADER, device.getIpv6());
+            HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.X_FORWARDED_FOR_HEADER, device.getIp());
+        }
+        return headers;
+    }
+
+    // check display manager version
+    private String buildDisplayManagerVersion(BidRequest request) {
+        final Optional<ExtAppPrebid> prebid = Optional.ofNullable(request.getApp())
+                .map(App::getExt)
+                .map(ExtApp::getPrebid);
+
+        final String source = prebid.map(ExtAppPrebid::getSource).orElse(null);
+        final String version = prebid.map(ExtAppPrebid::getVersion).orElse(null);
+
+        return ObjectUtils.allNotNull(source, version)
+                ? "%s-%s".formatted(source, version)
+                : "";
+    }
+
+    private static BidType getBidType(Bid bid) {
+        if (bid == null) {
+            return null;
+        }
+        final Optional<String> bidType = Optional.ofNullable(bid.getExt())
+                .map(ext -> ext.get("connatix"))
+                .map(cnx -> cnx.get("mediaType"))
+                .map(JsonNode::asText);
+        if (bidType.isPresent() && bidType.get().equals("video")) {
+            return BidType.video;
+        }
+        return BidType.banner;
+    }
+}

src/main/java/org/prebid/server/bidder/connatix/proto/ConnatixImpExtBidder.java

@@ -0,0 +1,19 @@
+package org.prebid.server.bidder.connatix.proto;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Builder;
+import lombok.Value;
+
+@Builder
+@Value
+public class ConnatixImpExtBidder {
+
+    String type;
+
+    @JsonProperty(value = "placementId")
+    String placementId;
+
+    @JsonProperty(value = "viewabilityPercentage")
+    Float viewabilityPercentage;
+
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/connatix/ExtImpConnatix.java

@@ -0,0 +1,17 @@
+package org.prebid.server.proto.openrtb.ext.request.connatix;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Builder;
+import lombok.Value;
+
+@Builder(toBuilder = true)
+@Value(staticConstructor = "of")
+public class ExtImpConnatix {
+
+    @JsonProperty("placementId")
+    String placementId;
+
+    @JsonProperty("viewabilityPercentage")
+    Float viewabilityPercentage;
+
+}

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

@@ -0,0 +1,43 @@
+package org.prebid.server.spring.config.bidder;
+
+import org.prebid.server.bidder.BidderDeps;
+import org.prebid.server.bidder.connatix.ConnatixBidder;
+import org.prebid.server.currency.CurrencyConversionService;
+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/connatix.yaml", factory = YamlPropertySourceFactory.class)
+public class ConnatixConfiguration {
+
+    private static final String BIDDER_NAME = "connatix";
+
+    @Bean("connatixConfigurationProperties")
+    @ConfigurationProperties("adapters.connatix")
+    BidderConfigurationProperties configurationProperties() {
+        return new BidderConfigurationProperties();
+    }
+
+    @Bean
+    BidderDeps connatixBidderDeps(BidderConfigurationProperties connatixConfigurationProperties,
+                                  @NotBlank @Value("${external-url}") String externalUrl,
+                                  JacksonMapper mapper,
+                                  CurrencyConversionService currencyConversionService) {
+
+        return BidderDepsAssembler.forBidder(BIDDER_NAME)
+                .withConfig(connatixConfigurationProperties)
+                .usersyncerCreator(UsersyncerCreator.create(externalUrl))
+                .bidderCreator(config -> new ConnatixBidder(config.getEndpoint(), currencyConversionService, mapper))
+                .assemble();
+    }
+}

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

@@ -0,0 +1,25 @@
+adapters:
+  connatix:
+    endpoint: "https://capi.connatix.com/rtb/ortb"
+    ortb:
+      multiformat-supported: false
+    meta-info:
+      maintainer-email: "[email protected]"
+      vendor-id: 143
+      app-media-types:
+        - banner
+        - video
+      site-media-types:
+        - banner
+        - video
+    usersync:
+      cookie-family-name: connatix
+      iframe:
+        url: "https://capi.connatix.com/us/pixel?pId=53&gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&callback={{redirect_url}}"
+        uid-macro: '$UID'
+        supportCors: false
+      redirect:
+        url: "https://capi.connatix.com/us/pixel?pId=52&gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&callback={{redirect_url}}"
+        uid-macro: '$UID'
+        supportCors: false
+

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

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Connatix Adapter Params",
+  "description": "A schema which validates params accepted by the Connatix adapter",
+  "type": "object",
+  "properties": {
+    "placementId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Placement ID"
+    },
+    "viewabilityPercentage": {
+      "type": "number",
+      "description": "Declared viewability percentage (values from 0 to 1, where 1 = 100%)",
+      "minimum": 0,
+      "maximum": 1
+    }
+  },
+    "required": ["placementId"]
+}
+