New Flatads Adapter

src/main/java/org/prebid/server/bidder/flatads/FlatadsBidder.java

@@ -0,0 +1,164 @@
+package org.prebid.server.bidder.flatads;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Device;
+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.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.flatads.ExtImpFlatads;
+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.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+public class FlatadsBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpFlatads>> FLATADS_EXT_TYPE_REFERENCE = new TypeReference<>() {
+    };
+
+    private static final String PUBLISHER_ID_MACRO = "{{PublisherID}}";
+    private static final String TOKEN_ID_MACRO = "{{TokenID}}";
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public FlatadsBidder(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<HttpRequest<BidRequest>> httpRequests = new ArrayList<>();
+        final List<BidderError> errors = new ArrayList<>();
+
+        for (Imp imp : request.getImp()) {
+            try {
+                final ExtImpFlatads extImpFlatads = parseImpExt(imp);
+                final String resolvedEndpoint = resolveEndpoint(extImpFlatads);
+                final BidRequest outgoingRequest = request.toBuilder()
+                        .imp(Collections.singletonList(imp))
+                        .build();
+                httpRequests.add(makeHttpRequest(outgoingRequest, resolvedEndpoint));
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        return Result.of(httpRequests, errors);
+    }
+
+    private ExtImpFlatads parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), FLATADS_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("Failed to deserialize Flatads extension: " + e.getMessage());
+        }
+    }
+
+    private String resolveEndpoint(ExtImpFlatads extImp) {
+        return endpointUrl
+                .replace(PUBLISHER_ID_MACRO, HttpUtil.encodeUrl(StringUtils.defaultString(extImp.getPublisherId())))
+                .replace(TOKEN_ID_MACRO, HttpUtil.encodeUrl(StringUtils.defaultString(extImp.getToken())));
+    }
+
+    private HttpRequest<BidRequest> makeHttpRequest(BidRequest request, String endpoint) {
+        return BidderUtil.defaultRequest(request, makeHeaders(request.getDevice()), endpoint, mapper);
+    }
+
+    private static MultiMap makeHeaders(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.getIp());
+            HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.X_FORWARDED_FOR_HEADER, device.getIpv6());
+        }
+
+        return headers;
+    }
+
+    @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<>();
+            return Result.of(extractBids(bidRequest, bidResponse, errors), errors);
+        } catch (DecodeException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private static List<BidderBid> extractBids(BidRequest bidRequest,
+                                               BidResponse bidResponse,
+                                               List<BidderError> errors) {
+
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+        return bidsFromResponse(bidRequest, bidResponse, errors);
+    }
+
+    private static List<BidderBid> bidsFromResponse(BidRequest bidRequest,
+                                                    BidResponse bidResponse,
+                                                    List<BidderError> errors) {
+
+        final Map<String, Imp> imps = bidRequest.getImp().stream()
+                .collect(Collectors.toMap(Imp::getId, Function.identity()));
+
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(Collection::stream)
+                .filter(Objects::nonNull)
+                .map(bid -> makeBid(bid, imps, bidResponse.getCur(), errors))
+                .filter(Objects::nonNull)
+                .collect(Collectors.toList());
+    }
+
+    private static BidderBid makeBid(Bid bid, Map<String, Imp> imps, String currency, List<BidderError> errors) {
+        final BidType bidType = getBidType(bid.getImpid(), imps, errors);
+        return bidType == null ? null : BidderBid.of(bid, bidType, currency);
+    }
+
+    private static BidType getBidType(String impId, Map<String, Imp> imps, List<BidderError> errors) {
+        final Imp imp = imps.get(impId);
+        if (imp != null) {
+            if (imp.getBanner() != null) {
+                return BidType.banner;
+            } else if (imp.getVideo() != null) {
+                return BidType.video;
+            } else if (imp.getXNative() != null) {
+                return BidType.xNative;
+            }
+        }
+
+        errors.add(BidderError.badServerResponse("The impression with ID %s is not present into the request"
+                .formatted(impId)));
+        return null;
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/flatads/ExtImpFlatads.java

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

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

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

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

@@ -0,0 +1,17 @@
+adapters:
+  flatads:
+    endpoint: https://bid.rtbshark.com/api/rtbs/adx/rtb?x-net-id={{PublisherID}}&x-net-token={{TokenID}}
+    ortb-version: "2.6"
+    endpoint-compression: gzip
+    meta-info:
+      maintainer-email: adxbusiness@flat-ads.com
+      app-media-types:
+        - banner
+        - video
+        - native
+      site-media-types:
+        - banner
+        - video
+        - native
+      supported-vendors:
+      vendor-id: 0

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

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Flatads Adapter Params",
+  "description": "A schema which validates params accepted by the Flatads adapter",
+  "type": "object",
+  "properties": {
+    "token": {
+      "type": "string",
+      "description": "Token of the publisher",
+      "minLength": 1
+    },
+    "publisherId": {
+      "type": "string",
+      "description": "Flatads Publisher Id",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "token",
+    "publisherId"
+  ]
+}