Core: Update SDK Protocol (#2707)

prebid · Oct 30, 2023 · b45b76e · b45b76e
1 parent dc7a0a9
commit b45b76e
Show file tree

Hide file tree

Showing 23 changed files with 318 additions and 18 deletions.
diff --git a/src/main/java/org/prebid/server/bidder/criteo/CriteoBidder.java b/src/main/java/org/prebid/server/bidder/criteo/CriteoBidder.java
@@ -18,6 +18,7 @@
 import org.prebid.server.json.JacksonMapper;
 import org.prebid.server.proto.openrtb.ext.response.BidType;
 import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid;
+import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebidMeta;
 import org.prebid.server.util.BidderUtil;
 import org.prebid.server.util.HttpUtil;
 
@@ -90,7 +91,7 @@ private static BidType getBidType(Bid bid) {
 
     private ObjectNode makeExt(String networkName) {
         return mapper.mapper().valueToTree(ExtBidPrebid.builder()
-                .meta(mapper.mapper().createObjectNode().put("networkName", networkName))
+                .meta(ExtBidPrebidMeta.builder().networkName(networkName).build())
                 .build());
     }
 }
diff --git a/src/main/java/org/prebid/server/bidder/grid/GridBidder.java b/src/main/java/org/prebid/server/bidder/grid/GridBidder.java
@@ -4,7 +4,6 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.MissingNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.fasterxml.jackson.databind.node.TextNode;
 import com.iab.openrtb.request.BidRequest;
 import com.iab.openrtb.request.Imp;
 import com.iab.openrtb.request.Site;
@@ -34,6 +33,7 @@
 import org.prebid.server.proto.openrtb.ext.request.grid.ExtImpGrid;
 import org.prebid.server.proto.openrtb.ext.response.BidType;
 import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid;
+import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebidMeta;
 import org.prebid.server.util.BidderUtil;
 import org.prebid.server.util.HttpUtil;
 import org.prebid.server.util.ObjectUtil;
@@ -235,7 +235,7 @@ private ObjectNode modifyBidExt(ObjectNode gridBid) {
         }
 
         final ExtBidPrebid extBidPrebid = ExtBidPrebid.builder()
-                .meta(mapper.mapper().createObjectNode().set("demandsource", TextNode.valueOf(demandSource)))
+                .meta(ExtBidPrebidMeta.builder().demandSource(demandSource).build())
                 .build();
         return mapper.mapper().valueToTree(ExtPrebid.of(extBidPrebid, null));
     }

diff --git a/src/main/java/org/prebid/server/bidder/rubicon/RubiconBidder.java b/src/main/java/org/prebid/server/bidder/rubicon/RubiconBidder.java
@@ -4,7 +4,6 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ArrayNode;
-import com.fasterxml.jackson.databind.node.IntNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.databind.node.TextNode;
 import com.iab.openrtb.request.App;
@@ -105,6 +104,7 @@
 import org.prebid.server.proto.openrtb.ext.request.rubicon.RubiconVideoParams;
 import org.prebid.server.proto.openrtb.ext.response.BidType;
 import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid;
+import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebidMeta;
 import org.prebid.server.util.BidderUtil;
 import org.prebid.server.util.HttpUtil;
 import org.prebid.server.util.ObjectUtil;
@@ -1640,10 +1640,10 @@ private RubiconBid insertNetworkIdToMeta(RubiconBid bid, int networkId, List<Bid
             return null;
         }
         final ExtBidPrebid extBidPrebid = extPrebid != null ? extPrebid.getPrebid() : null;
-        final ObjectNode meta = extBidPrebid != null ? extBidPrebid.getMeta() : null;
-
-        final ObjectNode updatedMeta = meta != null ? meta : mapper.mapper().createObjectNode();
-        updatedMeta.set("networkId", IntNode.valueOf(networkId));
+        final ExtBidPrebidMeta meta = extBidPrebid != null ? extBidPrebid.getMeta() : null;
+        final ExtBidPrebidMeta updatedMeta = meta != null
+                ? meta.toBuilder().networkId(networkId).build()
+                : ExtBidPrebidMeta.builder().networkId(networkId).build();
 
         final ExtBidPrebid modifiedExtBidPrebid = extBidPrebid != null
                 ? extBidPrebid.toBuilder().meta(updatedMeta).build()

diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/ExtRequestPrebid.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/ExtRequestPrebid.java
@@ -162,4 +162,10 @@ public class ExtRequestPrebid {
 
     @JsonProperty("createtids")
     Boolean createTids;
+
+    /**
+     * Defines the contract for bidrequest.ext.prebid.sdk
+     */
+    ExtRequestPrebidSdk sdk;
+
 }
diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/ExtRequestPrebidSdk.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/ExtRequestPrebidSdk.java
@@ -0,0 +1,17 @@
+package org.prebid.server.proto.openrtb.ext.request;
+
+import lombok.Value;
+
+import java.util.List;
+
+/**
+ * Defines the contract for bidrequest.ext.prebid.sdk
+ */
+@Value(staticConstructor = "of")
+public class ExtRequestPrebidSdk {
+
+    /**
+     * Defines the contract for bidrequest.ext.prebid.sdk.renderers
+     */
+    List<ExtRequestPrebidSdkRenderer> renderers;
+}
diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/ExtRequestPrebidSdkRenderer.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/ExtRequestPrebidSdkRenderer.java
@@ -0,0 +1,32 @@
+package org.prebid.server.proto.openrtb.ext.request;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import lombok.Value;
+
+/**
+ * Defines the contract for bidrequest.ext.prebid.sdk.renderers[i]
+ */
+@Value(staticConstructor = "of")
+public class ExtRequestPrebidSdkRenderer {
+
+    /**
+     * Defines the contract for bidrequest.ext.prebid.sdk.renderers[i].name
+     */
+    String name;
+
+    /**
+     * Defines the contract for bidrequest.ext.prebid.sdk.renderers[i].version
+     */
+    String version;
+
+    /**
+     * Defines the contract for bidrequest.ext.prebid.sdk.renderers[i].url
+     */
+    String url;
+
+    /**
+     * Defines the contract for bidrequest.ext.prebid.sdk.renderers[i].data
+     */
+    ObjectNode data;
+
+}
diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/response/ExtBidPrebid.java b/src/main/java/org/prebid/server/proto/openrtb/ext/response/ExtBidPrebid.java
@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.iab.openrtb.request.Video;
 import lombok.Builder;
 import lombok.Value;
@@ -34,7 +33,7 @@ public class ExtBidPrebid {
 
     ExtBidPrebidVideo video;
 
-    ObjectNode meta;
+    ExtBidPrebidMeta meta;
 
     @JsonProperty("dealtiersatisfied")
     Boolean dealTierSatisfied;

diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/response/ExtBidPrebidMeta.java b/src/main/java/org/prebid/server/proto/openrtb/ext/response/ExtBidPrebidMeta.java
@@ -0,0 +1,70 @@
+package org.prebid.server.proto.openrtb.ext.response;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import lombok.Builder;
+import lombok.Value;
+
+import java.util.List;
+
+@Builder(toBuilder = true)
+@Value
+public class ExtBidPrebidMeta {
+
+    @JsonProperty("adaptercode")
+    String adapterCode;
+
+    @JsonProperty("advertiserDomains")
+    List<String> advertiserDomains;
+
+    @JsonProperty("advertiserId")
+    Integer advertiserId;
+
+    @JsonProperty("advertiserName")
+    String advertiserName;
+
+    @JsonProperty("agencyId")
+    Integer agencyId;
+
+    @JsonProperty("agencyName")
+    String agencyName;
+
+    @JsonProperty("brandId")
+    Integer brandId;
+
+    @JsonProperty("brandName")
+    String brandName;
+
+    ObjectNode dchain;
+
+    @JsonProperty("demandSource")
+    String demandSource;
+
+    @JsonProperty("mediaType")
+    String mediaType;
+
+    @JsonProperty("networkId")
+    Integer networkId;
+
+    @JsonProperty("networkName")
+    String networkName;
+
+    @JsonProperty("primaryCatId")
+    String primaryCategoryId;
+
+    @JsonProperty("rendererName")
+    String rendererName;
+
+    @JsonProperty("rendererVersion")
+    String rendererVersion;
+
+    @JsonProperty("rendererUrl")
+    String rendererUrl;
+
+    @JsonProperty("rendererData")
+    ObjectNode rendererData;
+
+    @JsonProperty("secondaryCatIds")
+    List<String> secondaryCategoryIdList;
+
+}
diff --git a/src/test/groovy/org/prebid/server/functional/model/request/auction/Prebid.groovy b/src/test/groovy/org/prebid/server/functional/model/request/auction/Prebid.groovy
@@ -34,6 +34,7 @@ class Prebid {
     Map passThrough
     Events events
     Boolean createTids
+    Sdk sdk
 
     static class Channel {
 

diff --git a/src/test/groovy/org/prebid/server/functional/model/request/auction/Renderer.groovy b/src/test/groovy/org/prebid/server/functional/model/request/auction/Renderer.groovy
@@ -0,0 +1,12 @@
+package org.prebid.server.functional.model.request.auction
+
+import groovy.transform.ToString
+
+@ToString(includeNames = true, ignoreNulls = true)
+class Renderer {
+
+    String name
+    String version
+    String url
+    RendererData data
+}
diff --git a/src/test/groovy/org/prebid/server/functional/model/request/auction/RendererData.groovy b/src/test/groovy/org/prebid/server/functional/model/request/auction/RendererData.groovy
@@ -0,0 +1,9 @@
+package org.prebid.server.functional.model.request.auction
+
+import groovy.transform.ToString
+
+@ToString(includeNames = true, ignoreNulls = true)
+class RendererData {
+
+    String any
+}
diff --git a/src/test/groovy/org/prebid/server/functional/model/request/auction/Sdk.groovy b/src/test/groovy/org/prebid/server/functional/model/request/auction/Sdk.groovy
@@ -0,0 +1,9 @@
+package org.prebid.server.functional.model.request.auction
+
+import groovy.transform.ToString
+
+@ToString(includeNames = true, ignoreNulls = true)
+class Sdk {
+
+    List<Renderer> renderers
+}
diff --git a/src/test/groovy/org/prebid/server/functional/model/response/auction/Meta.groovy b/src/test/groovy/org/prebid/server/functional/model/response/auction/Meta.groovy
@@ -0,0 +1,27 @@
+package org.prebid.server.functional.model.response.auction
+
+import groovy.transform.ToString
+import org.prebid.server.functional.model.request.auction.RendererData
+
+@ToString(includeNames = true, ignoreNulls = true)
+class Meta {
+
+    String adapterCode
+    List<String> advertiserDomains
+    Integer advertiserId
+    String advertiserName
+    Integer agencyId
+    String agencyName
+    Integer brandId
+    String brandName
+    String demandSource
+    String mediaType
+    Integer networkId
+    String networkName
+    String primaryCategoryId
+    String rendererName
+    String rendererVersion
+    String rendererUrl
+    RendererData rendererData
+    List<String> secondaryCategoryIdList
+}
diff --git a/src/test/groovy/org/prebid/server/functional/model/response/auction/Prebid.groovy b/src/test/groovy/org/prebid/server/functional/model/response/auction/Prebid.groovy
@@ -11,5 +11,6 @@ class Prebid {
     String targetBidderCode
     Cache cache
     Events events
+    Meta meta
     Map passThrough
 }
diff --git a/src/test/groovy/org/prebid/server/functional/tests/AuctionSpec.groovy b/src/test/groovy/org/prebid/server/functional/tests/AuctionSpec.groovy
@@ -4,9 +4,16 @@ import org.prebid.server.functional.model.UidsCookie
 import org.prebid.server.functional.model.db.Account
 import org.prebid.server.functional.model.request.auction.BidRequest
 import org.prebid.server.functional.model.request.auction.PrebidStoredRequest
+import org.prebid.server.functional.model.request.auction.Renderer
+import org.prebid.server.functional.model.request.auction.RendererData
+import org.prebid.server.functional.model.request.auction.Sdk
 import org.prebid.server.functional.model.request.auction.User
 import org.prebid.server.functional.model.request.auction.UserExt
 import org.prebid.server.functional.model.request.auction.UserExtPrebid
+import org.prebid.server.functional.model.response.auction.BidExt
+import org.prebid.server.functional.model.response.auction.BidResponse
+import org.prebid.server.functional.model.response.auction.Meta
+import org.prebid.server.functional.model.response.auction.Prebid
 import org.prebid.server.functional.model.response.cookiesync.UserSyncInfo
 import org.prebid.server.functional.service.PrebidServerException
 import org.prebid.server.functional.service.PrebidServerService
@@ -310,4 +317,50 @@ class AuctionSpec extends BaseSpec {
         and: "BidderRequest shouldn't populate fields"
         assert !bidderRequest.ext.prebid.aliases
     }
+
+    def "PBS auction should pass ext.prebid.sdk requested to bidder request when sdk specified"() {
+        given: "Default bid request with aliases"
+        def bidRequest = BidRequest.defaultBidRequest.tap {
+            ext.prebid.sdk = new Sdk(renderers: [new Renderer(
+                    name: PBSUtils.randomString,
+                    version: PBSUtils.randomString,
+                    data: new RendererData(any: PBSUtils.randomString))])
+        }
+
+        when: "Requesting PBS auction"
+        defaultPbsService.sendAuctionRequest(bidRequest)
+
+        then: "Bidder request should contain sdk value same in request"
+        def bidderRequest = bidder.getBidderRequest(bidRequest.id)
+        assert bidderRequest.ext.prebid.sdk.renderers.name == bidRequest.ext.prebid.sdk.renderers.name
+        assert bidderRequest.ext.prebid.sdk.renderers.version == bidRequest.ext.prebid.sdk.renderers.version
+        assert bidderRequest.ext.prebid.sdk.renderers.data.any == bidRequest.ext.prebid.sdk.renderers.data.any
+    }
+
+    def "PBS auction should pass meta object to bid response when meta specified "() {
+        given: "Default bid request with aliases"
+        def bidRequest = BidRequest.defaultBidRequest
+
+        and: "Default bidder response without bid"
+        def bidResponse = BidResponse.getDefaultBidResponse(bidRequest).tap {
+            seatbid[0].bid[0].ext = new BidExt(prebid: new Prebid(meta: new Meta(
+                    rendererName: PBSUtils.randomString,
+                    rendererUrl: PBSUtils.randomString,
+                    rendererVersion: PBSUtils.getRandomString())))
+        }
+
+        and: "Set bidder response"
+        bidder.setResponse(bidRequest.id, bidResponse)
+
+        when: "Requesting PBS auction"
+        def response = defaultPbsService.sendAuctionRequest(bidRequest)
+
+        then: "Bid response should contain meta value same in request"
+        assert response.seatbid[0].bid[0].ext.prebid.meta.rendererName ==
+                bidResponse.seatbid[0].bid[0].ext.prebid.meta.rendererName
+        assert response.seatbid[0].bid[0].ext.prebid.meta.rendererUrl ==
+                bidResponse.seatbid[0].bid[0].ext.prebid.meta.rendererUrl
+        assert response.seatbid[0].bid[0].ext.prebid.meta.rendererVersion ==
+                bidResponse.seatbid[0].bid[0].ext.prebid.meta.rendererVersion
+    }
 }
diff --git a/src/test/java/org/prebid/server/bidder/grid/GridBidderTest.java b/src/test/java/org/prebid/server/bidder/grid/GridBidderTest.java
@@ -30,6 +30,7 @@
 import org.prebid.server.proto.openrtb.ext.request.ExtRequest;
 import org.prebid.server.proto.openrtb.ext.request.grid.ExtImpGrid;
 import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid;
+import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebidMeta;
 
 import java.io.IOException;
 import java.util.List;
@@ -370,8 +371,7 @@ public void makeBidsShouldModifyBidExtWithMetaIfDemandSourceIsPresentInBidExt()
         // then
         assertThat(result.getErrors()).isEmpty();
 
-        final ObjectNode expectedBidMeta = mapper.createObjectNode()
-                .set("demandsource", TextNode.valueOf("demandSource"));
+        final ExtBidPrebidMeta expectedBidMeta = ExtBidPrebidMeta.builder().demandSource("demandSource").build();
         final ObjectNode expectedBidExt = mapper.valueToTree(
                 ExtPrebid.of(ExtBidPrebid.builder().meta(expectedBidMeta).build(), null));