New Adapter: targetVideo

adapters/targetVideo/params_test.go

@@ -0,0 +1,48 @@
+package targetVideo
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/prebid/prebid-server/v3/openrtb_ext"
+)
+
+func TestValidParams(t *testing.T) {
+	validator, err := openrtb_ext.NewBidderParamsValidator("../../static/bidder-params")
+	if err != nil {
+		t.Fatalf("Failed to fetch the json-schemas. %v", err)
+	}
+
+	for _, validParam := range validParams {
+		if err := validator.Validate(openrtb_ext.BidderTargetVideo, json.RawMessage(validParam)); err != nil {
+			t.Errorf("Schema rejected targetVideo params: %s", validParam)
+		}
+	}
+}
+
+func TestInvalidParams(t *testing.T) {
+	validator, err := openrtb_ext.NewBidderParamsValidator("../../static/bidder-params")
+	if err != nil {
+		t.Fatalf("Failed to fetch the json-schemas. %v", err)
+	}
+
+	for _, invalidParam := range invalidParams {
+		if err := validator.Validate(openrtb_ext.BidderTargetVideo, json.RawMessage(invalidParam)); err == nil {
+			t.Errorf("Schema allowed unexpected params: %s", invalidParam)
+		}
+	}
+}
+
+var validParams = []string{
+	`{"placementId":846}`,
+	`{"placementId":"846"}`,
+}
+
+var invalidParams = []string{
+	`null`,
+	`nil`,
+	`undefined`,
+	`{"placementId": "%9"}`,
+	`{"publisherId": "as9""}`,
+	`{"placementId": true}`,
+}

adapters/targetVideo/targetvideo.go

@@ -0,0 +1,194 @@
+package targetVideo
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/prebid/openrtb/v20/openrtb2"
+	"github.com/prebid/prebid-server/v3/adapters"
+	"github.com/prebid/prebid-server/v3/config"
+	"github.com/prebid/prebid-server/v3/errortypes"
+	"github.com/prebid/prebid-server/v3/openrtb_ext"
+	"github.com/prebid/prebid-server/v3/util/jsonutil"
+)
+
+type adapter struct {
+	endpoint string
+}
+
+type impExt struct {
+	TargetVideo openrtb_ext.ExtImpTargetVideo `json:"targetVideo"`
+}
+
+func (a *adapter) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
+	totalImps := len(request.Imp)
+	errors := make([]error, 0)
+	adapterRequests := make([]*adapters.RequestData, 0, totalImps)
+
+	// Split multi-imp request into multiple ad server requests. SRA is currently not recommended.
+	for i := 0; i < totalImps; i++ {
+		if adapterReq, err := a.makeRequest(*request, request.Imp[i]); err == nil {
+			adapterRequests = append(adapterRequests, adapterReq)
+		} else {
+			errors = append(errors, err)
+		}
+	}
+
+	return adapterRequests, errors
+}
+
+func (a *adapter) makeRequest(request openrtb2.BidRequest, imp openrtb2.Imp) (*adapters.RequestData, error) {
+
+	// For now, this adapter sends one imp per request, but we still
+	// iterate over all imps in the request to perform the required
+	// imp.ext transformation.
+	request.Imp = []openrtb2.Imp{imp}
+
+	_, errImp := validateImpAndSetExt(&imp)
+	if errImp != nil {
+		return nil, errImp
+	}
+
+	for i := range request.Imp {
+		if len(request.Imp[i].Ext) == 0 {
+			continue
+		}
+		var root map[string]json.RawMessage
+		if err := json.Unmarshal(request.Imp[i].Ext, &root); err != nil {
+			// If ext cannot be parsed, skip transformation for this imp
+			continue
+		}
+
+		// Try to extract placementId from ext.bidder.targetVideo (or targetvideo)
+		placementId := ""
+		if bRaw, ok := root["bidder"]; ok && len(bRaw) > 0 {
+			var bidder map[string]json.RawMessage
+			if err := json.Unmarshal(bRaw, &bidder); err == nil {
+				if placementIdRaw, ok := bidder["placementId"]; ok && len(placementIdRaw) > 0 {
+
+					var asStr string
+					var asInt int64
+					if err := json.Unmarshal(placementIdRaw, &asStr); err == nil && asStr != "" {
+						placementId = asStr
+					} else if err := json.Unmarshal(placementIdRaw, &asInt); err == nil {
+						placementId = fmt.Sprintf("%d", asInt)
+					}
+
+				}
+			}
+			// Remove bidder node as required
+			delete(root, "bidder")
+		}
+
+		// If we obtained a placementId, set ext.prebid.storedrequest.id = placementId
+		if placementId != "" {
+			// Build prebid.storedrequest structure, preserving existing prebid if any
+			var prebid map[string]json.RawMessage
+			if pr, ok := root["prebid"]; ok && len(pr) > 0 {
+				_ = json.Unmarshal(pr, &prebid)
+			}
+			if prebid == nil {
+				prebid = make(map[string]json.RawMessage)
+			}
+			stored := map[string]string{"id": placementId}
+			storedRaw, _ := json.Marshal(stored)
+			prebid["storedrequest"] = storedRaw
+			prebidRaw, _ := json.Marshal(prebid)
+			root["prebid"] = prebidRaw
+		}
+
+		// Marshal back the transformed ext
+		if newExt, err := json.Marshal(root); err == nil {
+			request.Imp[i].Ext = newExt
+		}
+	}
+
+	reqJSON, err := json.Marshal(request)
+	if err != nil {
+		return nil, err
+	}
+
+	headers := http.Header{}
+	headers.Add("Content-Type", "application/json;charset=utf-8")
+	headers.Add("Accept", "application/json")
+
+	//fmt.Println("TARGET VIDEO reqJson: ", string(reqJSON))
+
+	return &adapters.RequestData{
+		Method:  "POST",
+		Uri:     a.endpoint,
+		Body:    reqJSON,
+		Headers: headers,
+		ImpIDs:  openrtb_ext.GetImpIDs(request.Imp),
+	}, nil
+}
+
+func (a *adapter) MakeBids(bidReq *openrtb2.BidRequest, unused *adapters.RequestData, httpRes *adapters.ResponseData) (*adapters.BidderResponse, []error) {
+	if httpRes.StatusCode == http.StatusNoContent {
+		return nil, nil
+	}
+	if httpRes.StatusCode == http.StatusBadRequest {
+		return nil, []error{&errortypes.BadInput{Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info", httpRes.StatusCode)}}
+	}
+
+	var bidResp openrtb2.BidResponse
+	if err := jsonutil.Unmarshal(httpRes.Body, &bidResp); err != nil {
+		return nil, []error{&errortypes.BadServerResponse{Message: fmt.Sprintf("error while decoding response, err: %s", err)}}
+	}
+
+	if len(bidResp.SeatBid) == 0 {
+		return nil, nil
+	}
+
+	if len(bidResp.SeatBid[0].Bid) == 0 {
+		return nil, nil
+	}
+
+	br := adapters.NewBidderResponse()
+	errs := []error{}
+
+	for _, sb := range bidResp.SeatBid {
+		for i := range sb.Bid {
+			bid := sb.Bid[i]
+			// Ensure imp exists and is video
+			mediaType := openrtb_ext.BidTypeVideo
+			for _, imp := range bidReq.Imp {
+				if imp.ID == bid.ImpID {
+					if imp.Video == nil {
+						// Not a video impression; skip
+						errs = append(errs, &errortypes.BadServerResponse{Message: fmt.Sprintf("ignoring bid id=%s for non-video imp id=%s", bid.ID, bid.ImpID)})
+						mediaType = ""
+					}
+					break
+				}
+			}
+
+			br.Bids = append(br.Bids, &adapters.TypedBid{Bid: &bid, BidType: mediaType})
+		}
+	}
+	return br, errs
+}
+
+func validateImpAndSetExt(imp *openrtb2.Imp) (int, error) {
+	if imp.Video == nil {
+		return 0, &errortypes.BadInput{Message: fmt.Sprintf("Only video impressions are supported by targetvideo. ImpID=%s", imp.ID)}
+	}
+	if len(imp.Ext) == 0 {
+		return 0, &errortypes.BadInput{Message: fmt.Sprintf("imp.ext is required and must contain bidder params for targetvideo. ImpID=%s", imp.ID)}
+	}
+	var ext impExt
+	if err := jsonutil.Unmarshal(imp.Ext, &ext); err != nil {
+		return 0, &errortypes.BadInput{Message: fmt.Sprintf("error parsing imp.ext for targetvideo, err: %s", err)}
+	}
+
+	return 0, nil
+}
+
+func Builder(bidderName openrtb_ext.BidderName, cfg config.Adapter, server config.Server) (adapters.Bidder, error) {
+
+	bidder := &adapter{
+		endpoint: cfg.Endpoint,
+	}
+	return bidder, nil
+}

adapters/targetVideo/targetvideo_test.go

@@ -0,0 +1,20 @@
+package targetVideo
+
+import (
+	"testing"
+
+	"github.com/prebid/prebid-server/v3/adapters/adapterstest"
+	"github.com/prebid/prebid-server/v3/config"
+	"github.com/prebid/prebid-server/v3/openrtb_ext"
+)
+
+func TestJsonSamples(t *testing.T) {
+	bidder, buildErr := Builder(openrtb_ext.BidderTargetVideo, config.Adapter{
+		Endpoint: "http://localhost/pbs"}, config.Server{ExternalUrl: "http://hosturl.com", GvlID: 1, DataCenter: "2"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	adapterstest.RunJSONBidderTest(t, "targetvideotest", bidder)
+}

adapters/targetVideo/targetvideotest/exemplary/app-video.json

@@ -0,0 +1,130 @@
+{
+  "mockBidRequest": {
+    "id": "test-request-id-video",
+    "app": {
+      "id": "appID",
+      "publisher": {
+        "id": "uniq_pub_id"
+      }
+    },
+    "cur": ["EUR"],
+    "imp": [
+      {
+        "id": "test-imp-id-video",
+        "video": {
+          "mimes": ["video/mp4"],
+          "w": 640,
+          "h": 360
+        },
+        "ext": {
+          "bidder": {
+            "placementId": "77777"
+          }
+        }
+      }
+    ],
+    "device": {
+      "ua": "test-user-agent"
+    },
+    "site": {
+      "domain": "www.publisher.com",
+      "page": "http://www.publisher.com/some/path",
+      "ext": {
+        "amp": 0
+      }
+    }
+  },
+  "httpCalls": [
+    {
+      "expectedRequest": {
+        "headers": {
+          "Accept": ["application/json"],
+          "Content-Type": ["application/json;charset=utf-8"]
+        },
+        "uri": "http://localhost/pbs",
+        "body": {
+          "id": "test-request-id-video",
+          "app": {
+            "id": "appID",
+            "publisher": {
+              "id": "uniq_pub_id"
+            }
+          },
+          "imp": [
+            {
+              "id": "test-imp-id-video",
+              "video": {
+                "mimes": ["video/mp4"],
+                "w": 640,
+                "h": 360
+              },
+              "ext": {
+                "prebid": {
+                  "storedrequest": {
+                    "id": "77777"
+                  }
+                }
+              }
+            }
+          ],
+          "device": {
+            "ua": "test-user-agent"
+          },
+          "site": {
+            "domain": "www.publisher.com",
+            "page": "http://www.publisher.com/some/path",
+            "ext": {
+              "amp": 0
+            }
+          },
+          "cur": ["EUR"]
+        },
+        "impIDs":["test-imp-id-video"]
+      },
+      "mockResponse": {
+        "status": 200,
+        "body": {
+          "id": "test-request-id-video",
+          "seatbid": [
+            {
+              "seat": "targetVideo",
+              "bid": [
+                {
+                  "id": "randomID",
+                  "impid": "test-imp-id-video",
+                  "price": 5.5,
+                  "adid": "12345678",
+                  "adm": "test-imp-id-video",
+                  "cid": "789",
+                  "crid": "12345678",
+                  "h": 360,
+                  "w": 640
+                }
+              ]
+            }
+          ],
+          "cur": "EUR"
+        }
+      }
+    }
+  ],
+  "expectedBidResponses": [
+    {
+      "currency": "EUR",
+      "bids" : [{
+        "bid": {
+          "id": "randomID",
+          "adid": "12345678",
+          "impid": "test-imp-id-video",
+          "price": 5.5,
+          "adm": "test-imp-id-video",
+          "crid": "12345678",
+          "cid": "789",
+          "h": 360,
+          "w": 640
+        },
+        "type": "video"
+      }]
+    }
+  ]
+}