Loyal: New Adapter (#3140)

src/main/java/org/prebid/server/bidder/loyal/LoyalBidder.java

@@ -0,0 +1,142 @@
+package org.prebid.server.bidder.loyal;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.response.Bid;
+import com.iab.openrtb.response.BidResponse;
+import io.vertx.core.http.HttpMethod;
+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.loyal.ExtImpLoyal;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.HttpUtil;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+public class LoyalBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpLoyal>> LOYAL_EXT_TYPE_REFERENCE =
+            new TypeReference<>() {
+            };
+
+    private static final String PLACEMENT_ID_MACRO = "{{PlacementId}}";
+    private static final String ENDPOINT_ID_MACRO = "{{EndpointId}}";
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public LoyalBidder(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<HttpRequest<BidRequest>> requests = new ArrayList<>();
+
+        for (Imp imp : request.getImp()) {
+            try {
+                final ExtImpLoyal ext = parseImpExt(imp);
+                final HttpRequest<BidRequest> httpRequest = createHttpRequest(ext, request);
+                requests.add(httpRequest);
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        if (!errors.isEmpty()) {
+            return Result.withErrors(errors);
+        }
+
+        return Result.withValues(requests);
+    }
+
+    private ExtImpLoyal parseImpExt(Imp imp) {
+        final ExtImpLoyal extImpLoyal;
+        try {
+            extImpLoyal = mapper.mapper().convertValue(imp.getExt(), LOYAL_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("Missing bidder ext in impression with id: " + imp.getId());
+        }
+        return extImpLoyal;
+    }
+
+    private HttpRequest<BidRequest> createHttpRequest(ExtImpLoyal ext, BidRequest request) {
+        String url = endpointUrl;
+        if (StringUtils.isNotBlank(ext.getPlacementId())) {
+            url = url.replace(PLACEMENT_ID_MACRO, ext.getPlacementId());
+        } else {
+            url = url.replace("param={{PlacementId}}&", ""); // Remove the PlacementId part if not available
+        }
+        if (StringUtils.isNotBlank(ext.getEndpointId())) {
+            url = url.replace(ENDPOINT_ID_MACRO, ext.getEndpointId());
+        } else {
+            url = url.replace("&param2={{EndpointId}}", ""); // Remove the EndpointId part if not available
+        }
+        final BidRequest outgoingRequest = request.toBuilder().build();
+        return HttpRequest.<BidRequest>builder()
+                .method(HttpMethod.POST)
+                .uri(url)
+                .body(mapper.encodeToBytes(outgoingRequest))
+                .headers(HttpUtil.headers())
+                .payload(outgoingRequest)
+                .build();
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
+        if (httpCall.getResponse() == null || httpCall.getResponse().getBody() == null) {
+            return Result.withError(BidderError.badServerResponse("No response or empty body"));
+        }
+
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            return Result.withValues(extractBids(bidResponse));
+        } catch (DecodeException | PreBidException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private static List<BidderBid> extractBids(BidResponse bidResponse) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            throw new PreBidException("Empty SeatBid array");
+        }
+        return bidResponse.getSeatbid()
+                .stream()
+                .flatMap(seatBid -> Optional.ofNullable(seatBid.getBid()).orElse(List.of()).stream())
+                .map(bid -> BidderBid.of(bid, getBidMediaType(bid), bidResponse.getCur()))
+                .toList();
+    }
+
+    private static BidType getBidMediaType(Bid bid) {
+        final Integer markupType = bid.getMtype();
+        if (markupType == null) {
+            throw new PreBidException("Missing MType for bid: " + bid.getId());
+        }
+
+        return switch (markupType) {
+            case 1 -> BidType.banner;
+            case 2 -> BidType.video;
+            case 3 -> BidType.audio;
+            case 4 -> BidType.xNative;
+            default -> throw new PreBidException(
+                    "Unable to fetch mediaType " + bid.getMtype() + " in multi-format: " + bid.getImpid());
+        };
+    }
+
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/loyal/ExtImpLoyal.java

@@ -0,0 +1,14 @@
+package org.prebid.server.proto.openrtb.ext.request.loyal;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+@Value(staticConstructor = "of")
+public class ExtImpLoyal {
+
+    @JsonProperty("placementId")
+    String placementId;
+
+    @JsonProperty("endpointId")
+    String endpointId;
+}

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

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

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

@@ -0,0 +1,27 @@
+adapters:
+  loyal:
+    enabled: false
+    endpoint: "https://us-east-1.loyal.app/pserver?p={{PlacementId}}&e={{EndpointId}}"
+    pbs-enforces-gdpr: false
+    pbs-enforces-ccpa: false
+    modifying-vast-xml-allowed: false
+    geo-target:
+      - USA
+    meta-info:
+      maintainer-email: "hello@loyal.app"
+      app-media-types:
+        - banner
+        - video
+        - native
+      site-media-types:
+        - banner
+        - video
+        - native
+      supported-vendors: []
+      vendor-id: 0
+    usersync:
+      url: ""
+      redirect-url: ""
+      cookie-family-name: loyal
+      type: redirect
+      support-cors: false

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

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Loyal Adapter Params",
+  "description": "A schema which validates params accepted by the Loyal adapter",
+  "type": "object",
+  "properties": {
+    "placementId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Placement ID"
+    },
+    "endpointId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Endpoint ID"
+    }
+  },
+  "oneOf": [
+    {
+      "required": [
+        "placementId"
+      ]
+    },
+    {
+      "required": [
+        "endpointId"
+      ]
+    }
+  ]
+}