New Adapter: Adview (prebid#1471)

src/main/java/org/prebid/server/bidder/adview/AdviewBidder.java

@@ -0,0 +1,143 @@
+package org.prebid.server.bidder.adview;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.iab.openrtb.request.Banner;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Format;
+import com.iab.openrtb.request.Imp;
+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.model.BidderBid;
+import org.prebid.server.bidder.model.BidderError;
+import org.prebid.server.bidder.model.HttpCall;
+import org.prebid.server.bidder.model.HttpRequest;
+import org.prebid.server.bidder.model.Result;
+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.adview.ExtImpAdview;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+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.Objects;
+import java.util.stream.Collectors;
+
+public class AdviewBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpAdview>> ADVIEW_EXT_TYPE_REFERENCE =
+            new TypeReference<ExtPrebid<?, ExtImpAdview>>() {
+            };
+    private static final String ACCOUNT_ID_MACRO = "{{AccountId}}";
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public AdviewBidder(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 Imp firstImp = request.getImp().get(0);
+        final ExtImpAdview extImpAdview;
+
+        try {
+            extImpAdview = mapper.mapper().convertValue(firstImp.getExt(), ADVIEW_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            return Result.withError(BidderError.badInput("invalid imp.ext"));
+        }
+
+        final BidRequest modifiedRequest = modifyRequest(request, extImpAdview.getMasterTagId());
+        return Result.withValue(
+                HttpRequest.<BidRequest>builder()
+                        .method(HttpMethod.POST)
+                        .uri(resolveEndpoint(extImpAdview.getAccountId()))
+                        .headers(HttpUtil.headers())
+                        .body(mapper.encode(modifiedRequest))
+                        .payload(modifiedRequest)
+                        .build());
+    }
+
+    private static BidRequest modifyRequest(BidRequest bidRequest, String masterTagId) {
+        return bidRequest.toBuilder()
+                .imp(modifyImps(bidRequest.getImp(), masterTagId))
+                .build();
+    }
+
+    private static List<Imp> modifyImps(List<Imp> imps, String masterTagId) {
+        final List<Imp> modifiedImps = new ArrayList<>(imps);
+        modifiedImps.set(0, modifyImp(imps.get(0), masterTagId));
+        return modifiedImps;
+    }
+
+    private static Imp modifyImp(Imp imp, String masterTagId) {
+        return imp.toBuilder()
+                .tagid(masterTagId)
+                .banner(resolveBanner(imp.getBanner()))
+                .build();
+    }
+
+    private static Banner resolveBanner(Banner banner) {
+        final List<Format> formats = banner != null ? banner.getFormat() : null;
+        if (CollectionUtils.isNotEmpty(formats)) {
+            final Format firstFormat = formats.get(0);
+            return firstFormat != null
+                    ? banner.toBuilder().w(firstFormat.getW()).h(firstFormat.getH()).build()
+                    : banner;
+        }
+        return banner;
+    }
+
+    private String resolveEndpoint(String accountId) {
+        return endpointUrl.replace(ACCOUNT_ID_MACRO, HttpUtil.encodeUrl(accountId));
+    }
+
+    @Override
+    public final Result<List<BidderBid>> makeBids(HttpCall<BidRequest> httpCall, BidRequest bidRequest) {
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            return Result.withValues(extractBids(httpCall.getRequest().getPayload(), bidResponse));
+        } catch (DecodeException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private static List<BidderBid> extractBids(BidRequest bidRequest, BidResponse bidResponse) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+        return bidsFromResponse(bidRequest, bidResponse);
+    }
+
+    private static List<BidderBid> bidsFromResponse(BidRequest bidRequest, BidResponse bidResponse) {
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(Collection::stream)
+                .map(bid -> BidderBid.of(bid, getBidMediaType(bid.getImpid(), bidRequest.getImp()),
+                        bidResponse.getCur()))
+                .collect(Collectors.toList());
+    }
+
+    private static BidType getBidMediaType(String impId, List<Imp> imps) {
+        for (Imp imp : imps) {
+            if (imp.getId().equals(impId)) {
+                if (imp.getVideo() != null) {
+                    return BidType.video;
+                } else if (imp.getXNative() != null) {
+                    return BidType.xNative;
+                }
+            }
+        }
+        return BidType.banner;
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/adview/ExtImpAdview.java

@@ -0,0 +1,16 @@
+package org.prebid.server.proto.openrtb.ext.request.adview;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+@Value
+@AllArgsConstructor(staticName = "of")
+public class ExtImpAdview {
+
+    @JsonProperty("placementId")
+    String masterTagId;
+
+    @JsonProperty("accountId")
+    String accountId;
+}

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

@@ -0,0 +1,51 @@
+package org.prebid.server.spring.config.bidder;
+
+import org.prebid.server.bidder.BidderDeps;
+import org.prebid.server.bidder.adview.AdviewBidder;
+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.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+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 javax.validation.constraints.NotBlank;
+
+@Configuration
+@PropertySource(value = "classpath:/bidder-config/adview.yaml", factory = YamlPropertySourceFactory.class)
+public class AdviewConfiguration {
+
+    private static final String BIDDER_NAME = "adview";
+
+    @Value("${external-url}")
+    @NotBlank
+    private String externalUrl;
+
+    @Autowired
+    private JacksonMapper mapper;
+
+    @Autowired
+    @Qualifier("adviewConfigurationProperties")
+    private BidderConfigurationProperties configProperties;
+
+    @Bean("adviewConfigurationProperties")
+    @ConfigurationProperties("adapters.adview")
+    BidderConfigurationProperties configurationProperties() {
+        return new BidderConfigurationProperties();
+    }
+
+    @Bean
+    BidderDeps adviewBidderDeps() {
+        return BidderDepsAssembler.forBidder(BIDDER_NAME)
+                .withConfig(configProperties)
+                .usersyncerCreator(UsersyncerCreator.create(externalUrl))
+                .bidderCreator(config -> new AdviewBidder(config.getEndpoint(), mapper))
+                .assemble();
+    }
+}

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

@@ -0,0 +1,24 @@
+adapters:
+  adview:
+    enabled: false
+    endpoint: https://bid.adview.com/agent/thirdAdxService/{{AccountId}}
+    pbs-enforces-gdpr: true
+    pbs-enforces-ccpa: true
+    modifying-vast-xml-allowed: true
+    deprecated-names:
+    aliases: {}
+    meta-info:
+      maintainer-email: [email protected]
+      site-media-types:
+      app-media-types:
+        - banner
+        - video
+        - native
+      supported-vendors:
+      vendor-id: 1022
+    usersync:
+      url:
+      redirect-url:
+      cookie-family-name: adview
+      type: redirect
+      support-cors: false

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

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "AdView Adapter Params",
+  "description": "A schema which validates params accepted by the adview adapter",
+  "type": "object",
+  "properties": {
+    "placementId": {
+      "type": "string",
+      "description": "An ID which identifies the placement selling the impression",
+      "minLength": 1
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Account id",
+      "minLength": 1
+    }
+  },
+  "required": ["placementId", "accountId"]
+}