New Alvads Adapter

src/main/java/org/prebid/server/bidder/alvads/AlvadsBidder.java

@@ -0,0 +1,216 @@
+package org.prebid.server.bidder.alvads;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.iab.openrtb.request.Banner;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.request.Video;
+import com.iab.openrtb.response.Bid;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+import io.vertx.core.http.HttpMethod;
+import org.apache.commons.collections4.CollectionUtils;
+import org.prebid.server.bidder.Bidder;
+import org.prebid.server.bidder.alvads.model.AlvaAdsImp;
+import org.prebid.server.bidder.alvads.model.AlvaAdsSite;
+import org.prebid.server.bidder.alvads.model.AlvadsRequestOrtb;
+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.JacksonMapper;
+import org.prebid.server.proto.openrtb.ext.ExtPrebid;
+import org.prebid.server.proto.openrtb.ext.request.alvads.AlvadsImpExt;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.HttpUtil;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
+public class AlvadsBidder implements Bidder<AlvadsRequestOrtb> {
+
+    private static final TypeReference<ExtPrebid<?, AlvadsImpExt>>
+            ALVADS_EXT_TYPE_REFERENCE = new TypeReference<>() { };
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public AlvadsBidder(String endpointUrl, JacksonMapper mapper) {
+        this.endpointUrl = HttpUtil.validateUrlSyntax(Objects.requireNonNull(endpointUrl));
+        this.mapper = Objects.requireNonNull(mapper);
+    }
+
+    @Override
+    public final Result<List<HttpRequest<AlvadsRequestOrtb>>> makeHttpRequests(BidRequest bidRequest) {
+        final List<BidderError> errors = new ArrayList<>();
+        final List<HttpRequest<AlvadsRequestOrtb>> httpRequests = new ArrayList<>();
+
+        for (Imp imp : bidRequest.getImp()) {
+            try {
+                final AlvadsImpExt impExt = parseImpExt(imp);
+                final HttpRequest<AlvadsRequestOrtb> request = makeHttpRequest(bidRequest, imp, impExt);
+                httpRequests.add(request);
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        if (httpRequests.isEmpty()) {
+            errors.add(BidderError.badInput("found no valid impressions"));
+            return Result.withErrors(errors);
+        }
+
+        return Result.of(httpRequests, errors);
+    }
+
+    private HttpRequest<AlvadsRequestOrtb> makeHttpRequest(BidRequest request, Imp imp, AlvadsImpExt impExt) {
+        final String resolvedUrl = makeUrl(impExt);
+        final AlvaAdsImp impObj = makeImp(imp);
+        final AlvaAdsSite siteObj = makeSite(request, impExt);
+        final AlvadsRequestOrtb alvadsRequest = AlvadsRequestOrtb.builder()
+                .id(request.getId())
+                .imp(List.of(impObj))
+                .device(request.getDevice())
+                .user(request.getUser())
+                .regs(request.getRegs())
+                .site(siteObj)
+                .build();
+
+        return HttpRequest.<AlvadsRequestOrtb>builder()
+                .method(HttpMethod.POST)
+                .uri(resolvedUrl)
+                .headers(HttpUtil.headers())
+                .payload(alvadsRequest)
+                .body(mapper.encodeToBytes(alvadsRequest))
+                .impIds(alvadsRequest.getImp().stream().map(AlvaAdsImp::getId).collect(Collectors.toSet()))
+                .build();
+    }
+
+    private AlvadsImpExt parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), ALVADS_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("Missing or invalid bidder ext in impression with id: " + imp.getId());
+        }
+    }
+
+    private String makeUrl(AlvadsImpExt impExt) {
+        final String resolvedUrl = impExt.getEndpointUrl() != null ? impExt.getEndpointUrl() : endpointUrl;
+        try {
+            URI.create(resolvedUrl);
+            return resolvedUrl;
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("Invalid endpoint URL: " + resolvedUrl, e);
+        }
+    }
+
+    private AlvaAdsImp makeImp(Imp imp) {
+        final Banner banner = imp.getBanner();
+        Map<String, Object> bannerMap = null;
+        if (banner != null) {
+            bannerMap = new HashMap<>();
+            if (banner.getW() != null) {
+                bannerMap.put("w", banner.getW());
+            }
+            if (banner.getH() != null) {
+                bannerMap.put("h", banner.getH());
+            }
+        }
+
+        final Video video = imp.getVideo();
+        Map<String, Object> videoMap = null;
+        if (video != null) {
+            videoMap = new HashMap<>();
+            if (video.getW() != null) {
+                videoMap.put("w", video.getW());
+            }
+            if (video.getH() != null) {
+                videoMap.put("h", video.getH());
+            }
+        }
+
+        return AlvaAdsImp.builder()
+                .id(imp.getId())
+                .tagid(imp.getTagid())
+                .bidfloor(imp.getBidfloor())
+                .banner(bannerMap)
+                .video(videoMap)
+                .build();
+    }
+
+    private AlvaAdsSite makeSite(BidRequest request, AlvadsImpExt impExt) {
+        final String page = request.getSite() != null ? request.getSite().getPage() : null;
+        return AlvaAdsSite.builder()
+                .page(page)
+                .ref(page)
+                .publisher(Map.of("id", impExt.getPublisherUniqueId()))
+                .build();
+    }
+
+    @Override
+    public final Result<List<BidderBid>> makeBids(BidderCall<AlvadsRequestOrtb> httpCall, BidRequest bidRequest) {
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            return Result.withValues(extractBids(bidResponse, httpCall.getRequest().getPayload()));
+        } catch (org.prebid.server.json.DecodeException e) {
+            return Result.withError(BidderError.badServerResponse("Failed to decode BidResponse: " + e.getMessage()));
+        }
+    }
+
+    private List<BidderBid> extractBids(BidResponse bidResponse, AlvadsRequestOrtb request) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+        return bidsFromResponse(bidResponse, request);
+    }
+
+    private List<BidderBid> bidsFromResponse(BidResponse bidResponse, AlvadsRequestOrtb request) {
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(Collection::stream)
+                .filter(Objects::nonNull)
+                .map(bid -> {
+                    final AlvaAdsImp imp = request.getImp().stream()
+                            .filter(i -> i.getId().equals(bid.getImpid()))
+                            .findFirst()
+                            .orElse(null);
+
+                    return BidderBid.of(bid, getBidType(bid, imp), bidResponse.getCur());
+                })
+                .filter(Objects::nonNull)
+                .toList();
+    }
+
+    private BidType getBidType(Bid bid, AlvaAdsImp imp) {
+        if (imp != null && imp.getVideo() != null) {
+            return BidType.video;
+        }
+
+        final ExtBidAlvads bidExt = getBidExt(bid);
+        if (bidExt == null) {
+            return BidType.banner;
+        }
+
+        final BidType crtype = bidExt.getCrtype();
+        return crtype != null ? crtype : BidType.banner;
+    }
+
+    private ExtBidAlvads getBidExt(Bid bid) {
+        try {
+            return mapper.mapper().convertValue(bid.getExt(), ExtBidAlvads.class);
+        } catch (IllegalArgumentException e) {
+            return null;
+        }
+    }
+}

src/main/java/org/prebid/server/bidder/alvads/ExtBidAlvads.java

@@ -0,0 +1,10 @@
+package org.prebid.server.bidder.alvads;
+
+import lombok.Data;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+
+@Data
+public class ExtBidAlvads {
+
+    private BidType crtype;
+}

src/main/java/org/prebid/server/bidder/alvads/model/AlvaAdsImp.java

@@ -0,0 +1,18 @@
+package org.prebid.server.bidder.alvads.model;
+
+import lombok.Builder;
+import lombok.Data;
+
+import java.math.BigDecimal;
+import java.util.Map;
+
+@Data
+@Builder
+public class AlvaAdsImp {
+
+    private String id;
+    private Map<String, Object> banner;
+    private Map<String, Object> video;
+    private String tagid;
+    private BigDecimal bidfloor;
+}

src/main/java/org/prebid/server/bidder/alvads/model/AlvaAdsSite.java

@@ -0,0 +1,15 @@
+package org.prebid.server.bidder.alvads.model;
+
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.Map;
+
+@Data
+@Builder
+public class AlvaAdsSite {
+
+    private String page;
+    private String ref;
+    private Map<String, Object> publisher;
+}

src/main/java/org/prebid/server/bidder/alvads/model/AlvadsRequestOrtb.java

@@ -0,0 +1,21 @@
+package org.prebid.server.bidder.alvads.model;
+
+import com.iab.openrtb.request.Device;
+import com.iab.openrtb.request.Regs;
+import com.iab.openrtb.request.User;
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+@Builder(toBuilder = true)
+public class AlvadsRequestOrtb {
+
+    private String id;
+    private List<AlvaAdsImp> imp;
+    private Device device;
+    private User user;
+    private Regs regs;
+    private AlvaAdsSite site;
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/alvads/AlvadsImpExt.java

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

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

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

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

@@ -0,0 +1,14 @@
+adapters:
+  alvads:
+    endpoint: https://helios-ads-qa-core.ssidevops.com/decision/openrtb
+    meta-info:
+      maintainer-email: [email protected]
+      app-media-types:
+        - banner
+        - video
+      site-media-types:
+        - banner
+        - video
+      supported-vendors:
+      vendor-id: 0
+

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

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Alvads Adapter Params",
+  "description": "A schema which validates params accepted by the Alvads adapter",
+  "type": "object",
+
+  "properties": {
+    "publisherUniqueId": {
+      "type": "string",
+      "description": "Publisher Unique Id"
+    },
+    "endPointUrl": {
+      "type": "string",
+      "description": "Url ads openrtb"
+    }
+  },
+
+  "required": ["publisherUniqueId"]
+}