New Adapter: Matterfull RTB (#4647)

src/main/java/org/prebid/server/bidder/matterfull/MatterfullrtbBidder.java

@@ -0,0 +1,196 @@
+package org.prebid.server.bidder.matterfull;
+
+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.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.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.matterfull.ExtImpMatterfullrtb;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.BidderUtil;
+import org.prebid.server.util.Uri;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+
+public class MatterfullrtbBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpMatterfullrtb>> TYPE_REFERENCE = new TypeReference<>() {
+    };
+    private static final String PUBLISHER_ID_MACRO = "PublisherID";
+
+    private final Uri endpointUrl;
+    private final JacksonMapper mapper;
+
+    public MatterfullrtbBidder(String endpointUrl, JacksonMapper mapper) {
+        this.endpointUrl = Uri.of(endpointUrl);
+        this.mapper = Objects.requireNonNull(mapper);
+    }
+
+    @Override
+    public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest bidRequest) {
+        final List<BidderError> errors = new ArrayList<>();
+        final List<HttpRequest<BidRequest>> httpRequests = new ArrayList<>();
+        final Map<String, List<Imp>> publisherIdToImps = new HashMap<>();
+
+        for (Imp imp : bidRequest.getImp()) {
+            try {
+                final ExtImpMatterfullrtb extImp = parseImpExt(imp);
+                publisherIdToImps.computeIfAbsent(extImp.getPublisherId(), _ -> new ArrayList<>())
+                        .add(imp);
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        if (publisherIdToImps.isEmpty()) {
+            return Result.withErrors(errors);
+        }
+
+        for (Map.Entry<String, List<Imp>> publisherIdImps : publisherIdToImps.entrySet()) {
+            final BidRequest modifiedBidRequest = modifyRequest(publisherIdImps.getValue(), bidRequest);
+            httpRequests.add(BidderUtil.defaultRequest(
+                    modifiedBidRequest,
+                    getResolvedUrl(publisherIdImps.getKey()),
+                    mapper
+            ));
+        }
+
+        return Result.of(httpRequests, errors);
+    }
+
+    private ExtImpMatterfullrtb parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException(
+                    String.format("invalid imp.ext for impression %s. %s", imp.getId(), e.getMessage()));
+        }
+    }
+
+    private BidRequest modifyRequest(List<Imp> imps, BidRequest request) {
+        final Site site = request.getSite();
+        final App app = request.getApp();
+
+        return request.toBuilder()
+                .imp(imps)
+                .site(site != null ? modifySite(site) : null)
+                .app(app != null ? modifyApp(app) : null)
+                .build();
+    }
+
+    private static Site modifySite(Site site) {
+        return site.toBuilder().publisher(null).build();
+    }
+
+    private static App modifyApp(App app) {
+        return app.toBuilder().publisher(null).domain("").build();
+    }
+
+    private String getResolvedUrl(String publisherId) {
+        return endpointUrl.replaceMacro(PUBLISHER_ID_MACRO, publisherId).expand();
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            final List<BidderError> errors = new ArrayList<>();
+            final List<BidderBid> bidderBids = extractBids(bidResponse, bidRequest, errors);
+
+            return Result.of(bidderBids, errors);
+        } catch (DecodeException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private static List<BidderBid> extractBids(BidResponse bidResponse,
+                                               BidRequest bidRequest,
+                                               List<BidderError> errors) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+
+        final List<BidderBid> bidderBids = new ArrayList<>();
+        for (SeatBid seatBid : bidResponse.getSeatbid()) {
+            for (Bid bid : seatBid.getBid()) {
+                try {
+                    final BidType bidType = getBidMediaType(bid, bidRequest.getImp());
+                    bidderBids.add(BidderBid.of(bid, bidType, bidResponse.getCur()));
+                } catch (PreBidException e) {
+                    errors.add(BidderError.badServerResponse(e.getMessage()));
+                }
+            }
+        }
+        return bidderBids;
+    }
+
+    private static BidType getBidMediaType(Bid bid, List<Imp> imps) {
+        final Integer mType = bid.getMtype();
+        return switch (mType) {
+            case 1 -> BidType.banner;
+            case 2 -> BidType.video;
+            case 3 -> BidType.audio;
+            case 4 -> BidType.xNative;
+            case 0 -> getMediaTypeForImpId(bid.getImpid(), imps);
+            case null, default -> throw new PreBidException(
+                    String.format("Unsupported mtype %d for impression with ID: %s", mType, bid.getImpid()));
+        };
+    }
+
+    private static BidType getMediaTypeForImpId(String impId, List<Imp> imps) {
+        for (Imp imp : imps) {
+            if (imp.getId().equals(impId)) {
+                return getMediaTypeForImp(imp);
+            }
+        }
+        throw new PreBidException(String.format("Failed to find impression for ID: %s", impId));
+    }
+
+    private static BidType getMediaTypeForImp(Imp imp) {
+        int counter = 0;
+        BidType bidType = null;
+        if (imp.getBanner() != null) {
+            counter++;
+            bidType = BidType.banner;
+        }
+        if (imp.getVideo() != null) {
+            counter++;
+            bidType = BidType.video;
+        }
+        if (imp.getAudio() != null) {
+            counter++;
+            bidType = BidType.audio;
+        }
+        if (imp.getXNative() != null) {
+            counter++;
+            bidType = BidType.xNative;
+        }
+        if (counter == 0) {
+            throw new PreBidException(
+                    String.format("Could not determine media type for impression with ID: %s", imp.getId()));
+        } else if (counter != 1) {
+            throw new PreBidException(String.format(
+                    "Bid must have non-zero mtype for multi-format impression with ID: %s", imp.getId()));
+        }
+        return bidType;
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/matterfull/ExtImpMatterfullrtb.java

@@ -0,0 +1,11 @@
+package org.prebid.server.proto.openrtb.ext.request.matterfull;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+@Value(staticConstructor = "of")
+public class ExtImpMatterfullrtb {
+
+    @JsonProperty("pid")
+    String publisherId;
+}

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

@@ -0,0 +1,34 @@
+package org.prebid.server.spring.config.bidder;
+
+import org.prebid.server.bidder.BidderDeps;
+import org.prebid.server.bidder.matterfull.MatterfullrtbBidder;
+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.env.YamlPropertySourceFactory;
+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;
+
+@Configuration
+@PropertySource(value = "classpath:/bidder-config/matterfullrtb.yaml", factory = YamlPropertySourceFactory.class)
+public class MatterfullrtbConfiguration {
+
+    private static final String BIDDER_NAME = "matterfullrtb";
+
+    @Bean("matterfullrtbConfigurationProperties")
+    @ConfigurationProperties("adapters.matterfullrtb")
+    BidderConfigurationProperties configurationProperties() {
+        return new BidderConfigurationProperties();
+    }
+
+    @Bean
+    BidderDeps matterfullrtbBidderDeps(BidderConfigurationProperties matterfullrtbConfigurationProperties,
+                                       JacksonMapper mapper) {
+        return BidderDepsAssembler.forBidder(BIDDER_NAME)
+                .withConfig(matterfullrtbConfigurationProperties)
+                .bidderCreator(config -> new MatterfullrtbBidder(config.getEndpoint(), mapper))
+                .assemble();
+    }
+}

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

@@ -0,0 +1,17 @@
+adapters:
+  matterfullrtb:
+    endpoint: "https://us.matterfull.co/?uqhash={PublisherID}"
+    geoscope:
+      - USA
+    ortb-version: "2.6"
+    endpoint-compression: gzip
+    meta-info:
+      maintainer-email: prebid_support@bematterfull.com
+      app-media-types:
+        - banner
+        - video
+      site-media-types:
+        - banner
+        - video
+      supported-vendors:
+      vendor-id: 0

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

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Matterfull RTB Adapter Params",
+  "description": "A schema which validates params accepted by the Matterfull RTB adapter",
+  "type": "object",
+  "properties": {
+    "pid": {
+      "type": "string",
+      "description": "Publisher token for the separately provisioned Matterfull RTB OpenRTB integration.",
+      "minLength": 20
+    }
+  },
+  "required": ["pid"]
+}