Yeahmobi: Add Bidder (#2723)

src/main/java/org/prebid/server/bidder/yeahmobi/YeahmobiBidder.java

@@ -0,0 +1,150 @@
+package org.prebid.server.bidder.yeahmobi;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.request.Native;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+import io.vertx.core.http.HttpMethod;
+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.yeahmobi.ExtImpYeahmobi;
+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.Optional;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+public class YeahmobiBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpYeahmobi>> EXT_TYPE_REFERENCE = new TypeReference<>() {
+    };
+    private static final String HOST_MACRO = "{{Host}}";
+    private static final String HOST_PATTERN = "gw-%s-bid.yeahtargeter.com";
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public YeahmobiBidder(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<Imp> modifiedImps = new ArrayList<>();
+
+        ExtImpYeahmobi extImp = null;
+        for (Imp imp : request.getImp()) {
+            try {
+                extImp = parseImpExt(imp);
+                modifiedImps.add(modifyImp(imp));
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        if (extImp == null) {
+            return Result.withError(BidderError.badInput("Invalid ExtImpYeahmobi value"));
+        }
+
+        final BidRequest modifiedRequest = request.toBuilder().imp(modifiedImps).build();
+
+        final HttpRequest<BidRequest> httpRequest = makeHttpRequest(modifiedRequest, extImp.getZoneId());
+        return Result.of(Collections.singletonList(httpRequest), errors);
+    }
+
+    private HttpRequest<BidRequest> makeHttpRequest(BidRequest request, String zoneId) {
+        final String host = HOST_PATTERN.formatted(zoneId);
+        final String uri = endpointUrl.replace(HOST_MACRO, host);
+
+        return HttpRequest.<BidRequest>builder()
+                .method(HttpMethod.POST)
+                .uri(uri)
+                .impIds(BidderUtil.impIds(request))
+                .headers(HttpUtil.headers())
+                .payload(request)
+                .body(mapper.encodeToBytes(request))
+                .build();
+    }
+
+    private ExtImpYeahmobi parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException(String.format("Impression id=%s, has invalid Ext", imp.getId()));
+        }
+    }
+
+    private Imp modifyImp(Imp imp) {
+        final Native impNative = imp.getXNative();
+        return Optional.ofNullable(impNative)
+                .map(xNative -> resolveNativeRequest(xNative.getRequest()))
+                .map(nativeRequest -> imp.toBuilder().xNative(
+                        impNative.toBuilder().request(nativeRequest).build())
+                        .build())
+                .orElse(imp);
+    }
+
+    private String resolveNativeRequest(String nativeRequest) {
+        try {
+            final JsonNode nativePayload = nativeRequest != null
+                    ? mapper.mapper().readValue(nativeRequest, JsonNode.class)
+                    : mapper.mapper().createObjectNode();
+            final ObjectNode objectNode = mapper.mapper().createObjectNode().set("native", nativePayload);
+            return mapper.mapper().writeValueAsString(objectNode);
+        } catch (JsonProcessingException e) {
+            throw new PreBidException(e.getMessage());
+        }
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(BidderCall<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 | PreBidException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private List<BidderBid> extractBids(BidRequest bidRequest, BidResponse bidResponse) {
+        if (bidResponse == null || bidResponse.getSeatbid() == null) {
+            return Collections.emptyList();
+        }
+        return bidsFromResponse(bidRequest, bidResponse);
+    }
+
+    private List<BidderBid> bidsFromResponse(BidRequest bidRequest, BidResponse bidResponse) {
+        final Map<String, Imp> impMap = 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)
+                .map(bid -> BidderBid.of(bid, BidderUtil.getBidType(bid, impMap), bidResponse.getCur()))
+                .toList();
+    }
+
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/yeahmobi/ExtImpYeahmobi.java

@@ -0,0 +1,15 @@
+package org.prebid.server.proto.openrtb.ext.request.yeahmobi;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+@Value(staticConstructor = "of")
+public class ExtImpYeahmobi {
+
+    @JsonProperty("pubId")
+    String pubId;
+
+    @JsonProperty("zoneId")
+    String zoneId;
+
+}

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

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

src/main/java/org/prebid/server/util/BidderUtil.java

@@ -11,11 +11,14 @@
 import org.prebid.server.bidder.model.Price;
 import org.prebid.server.bidder.model.PriceFloorInfo;
 import org.prebid.server.json.JacksonMapper;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
 
 import java.math.BigDecimal;
 import java.math.RoundingMode;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
 
@@ -106,4 +109,22 @@ public static BigDecimal roundFloor(BigDecimal floor) {
     public static boolean isNullOrZero(Integer value) {
         return value == null || value == 0;
     }
+
+    public static BidType getBidType(Bid bid, Map<String, Imp> impIdToImpMap) {
+        return Optional.ofNullable(impIdToImpMap.get(bid.getImpid()))
+                .map(imp -> {
+                    if (imp.getBanner() != null) {
+                        return BidType.banner;
+                    } else if (imp.getVideo() != null) {
+                        return BidType.video;
+                    } else if (imp.getXNative() != null) {
+                        return BidType.xNative;
+                    } else if (imp.getAudio() != null) {
+                        return BidType.audio;
+                    } else {
+                        return BidType.banner;
+                    }
+                })
+                .orElse(BidType.banner);
+    }
 }

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

@@ -0,0 +1,15 @@
+adapters:
+  yeahmobi:
+    endpoint: https://{{.Host}}/prebid/bid
+    meta-info:
+      maintainer-email: developer@yeahmobi.com
+      app-media-types:
+        - banner
+        - video
+        - native
+      site-media-types:
+        - banner
+        - video
+        - native
+      supported-vendors:
+      vendor-id: 0

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

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Yeahmobi Adapter Params",
+  "description": "A schema which validates params accepted by the Yeahmobi adapter",
+  "type": "object",
+  "properties": {
+    "pubId": {
+      "type": "string",
+      "description": "Publisher ID",
+      "minLength": 1
+    },
+    "zoneId": {
+      "type": "string",
+      "description": "Zone Id",
+      "minLength": 1
+    }
+  },
+  "required": ["pubId", "zoneId"]
+}