diff --git a/adapters/oprx/oprx.go b/adapters/oprx/oprx.go new file mode 100644 index 00000000000..cfcf657b6fd --- /dev/null +++ b/adapters/oprx/oprx.go @@ -0,0 +1,94 @@ +package oprx + +import ( + "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 +} + +func Builder(bidderName openrtb_ext.BidderName, config config.Adapter, server config.Server) (adapters.Bidder, error) { + bidder := &adapter{ + endpoint: config.Endpoint, + } + return bidder, nil +} + +func (a *adapter) MakeRequests(request *openrtb2.BidRequest, requestInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) { + requestJSON, err := jsonutil.Marshal(request) + if err != nil { + return nil, []error{err} + } + + requestData := &adapters.RequestData{ + Method: "POST", + Uri: a.endpoint, + Body: requestJSON, + ImpIDs: openrtb_ext.GetImpIDs(request.Imp), + } + + return []*adapters.RequestData{requestData}, nil +} + +func (a *adapter) MakeBids(request *openrtb2.BidRequest, requestData *adapters.RequestData, responseData *adapters.ResponseData) (*adapters.BidderResponse, []error) { + if adapters.IsResponseStatusCodeNoContent(responseData) { + return nil, nil + } + + if err := adapters.CheckResponseStatusCodeForErrors(responseData); err != nil { + return nil, []error{err} + } + + if responseData.StatusCode != http.StatusOK { + err := &errortypes.BadServerResponse{ + Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info.", responseData.StatusCode), + } + return nil, []error{err} + } + + var response openrtb2.BidResponse + if err := jsonutil.Unmarshal(responseData.Body, &response); err != nil { + return nil, []error{err} + } + + bidResponse := adapters.NewBidderResponseWithBidsCapacity(len(request.Imp)) + bidResponse.Currency = response.Cur + var errors []error + for _, seatBid := range response.SeatBid { + for i, bid := range seatBid.Bid { + bidType, err := getMediaTypeForBid(bid) + if err != nil { + errors = append(errors, err) + continue + } + bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{ + Bid: &seatBid.Bid[i], + BidType: bidType, + }) + } + } + return bidResponse, nil +} + +func getMediaTypeForBid(bid openrtb2.Bid) (openrtb_ext.BidType, error) { + if bid.Ext != nil { + var bidExt openrtb_ext.ExtBid + err := jsonutil.Unmarshal(bid.Ext, &bidExt) + if err == nil && bidExt.Prebid != nil { + return openrtb_ext.ParseBidType(string(bidExt.Prebid.Type)) + } + } + + return "", &errortypes.BadServerResponse{ + Message: fmt.Sprintf("Failed to parse impression \"%s\" mediatype", bid.ImpID), + } +} diff --git a/adapters/oprx/oprx_test.go b/adapters/oprx/oprx_test.go new file mode 100644 index 00000000000..392672215dc --- /dev/null +++ b/adapters/oprx/oprx_test.go @@ -0,0 +1,21 @@ +package oprx + +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.BidderOprx, config.Adapter{ + Endpoint: "http://localhost:8080"}, + config.Server{ExternalUrl: "http://hosturl.com", GvlID: 1, DataCenter: "2"}) + + if buildErr != nil { + t.Fatalf("Builder returned unexpected error %v", buildErr) + } + + adapterstest.RunJSONBidderTest(t, "oprxtest", bidder) +} diff --git a/adapters/oprx/oprxtest/exemplary/banner.json b/adapters/oprx/oprxtest/exemplary/banner.json new file mode 100644 index 00000000000..b24649e199a --- /dev/null +++ b/adapters/oprx/oprxtest/exemplary/banner.json @@ -0,0 +1,121 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "httpCalls": [{ + "expectedRequest": { + "uri": "http://localhost:8080", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "impIDs": ["imp-id"] + }, + "mockResponse": { + "status": 200, + "body": { + "id": "request-id", + "seatbid": [ + { + "seat": "958", + "bid": [ + { + "id": "bid-id", + "impid": "imp-id", + "price": 0.5, + "adid": "29681110", + "adm": "some-test-ad", + "adomain": [ + "foo.com" + ], + "crid": "29681110", + "h": 250, + "w": 300, + "dealid": "test deal", + "ext": { + "prebid": { + "type": "banner" + } + } + } + ] + } + ], + "bidid": "request-id", + "cur": "USD" + } + } + }], + "expectedBidResponses": [ + { + "currency": "USD", + "bids": [ + { + "bid": { + "id": "bid-id", + "impid": "imp-id", + "price": 0.5, + "adid": "29681110", + "adm": "some-test-ad", + "adomain": [ + "foo.com" + ], + "crid": "29681110", + "h": 250, + "w": 300, + "dealid": "test deal", + "ext": { + "prebid": { + "type": "banner" + } + } + }, + "type": "banner" + } + ] + } + ] +} \ No newline at end of file diff --git a/adapters/oprx/oprxtest/exemplary/multi-imp.json b/adapters/oprx/oprxtest/exemplary/multi-imp.json new file mode 100644 index 00000000000..9cb6bd4d9ec --- /dev/null +++ b/adapters/oprx/oprxtest/exemplary/multi-imp.json @@ -0,0 +1,202 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id-1", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id-1", + "bid-floor": 0.5, + "npi": "my-npi-1", + "ndc": "my-ndc-1" + } + } + }, + { + "id": "imp-id-2", + "banner": { + "format": [ + { + "w": 350, + "h": 200 + } + ] + }, + "ext": { + "bidder": { + "key": "p567", + "placement_id": "my-placement-id-2", + "bid-floor": 0.5, + "npi": "my-npi-2", + "ndc": "my-ndc-2" + } + } + } + ] + }, + "httpCalls": [{ + "expectedRequest": { + "uri": "http://localhost:8080", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id-1", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id-1", + "bid-floor": 0.5, + "npi": "my-npi-1", + "ndc": "my-ndc-1" + } + } + }, + { + "id": "imp-id-2", + "banner": { + "format": [ + { + "w": 350, + "h": 200 + } + ] + }, + "ext": { + "bidder": { + "key": "p567", + "placement_id": "my-placement-id-2", + "bid-floor": 0.5, + "npi": "my-npi-2", + "ndc": "my-ndc-2" + } + } + } + ] + }, + "impIDs": ["imp-id-1", "imp-id-2"] + }, + "mockResponse": { + "status": 200, + "body": { + "id": "request-id", + "seatbid": [ + { + "seat": "958", + "bid": [ + { + "id": "bid-id-1", + "impid": "imp-id-1", + "price": 0.5, + "adid": "29681111", + "adm": "some-test-ad", + "adomain": [ + "foo.com" + ], + "crid": "29681111", + "h": 250, + "w": 300, + "dealid": "test deal 1", + "ext": { + "prebid": { + "type": "banner" + } + } + }, + { + "id": "bid-id-2", + "impid": "imp-id-2", + "price": 0.5, + "adid": "29681112", + "adm": "some-test-ad", + "adomain": [ + "foo.com" + ], + "crid": "29681112", + "h": 200, + "w": 350, + "dealid": "test deal 2", + "ext": { + "prebid": { + "type": "banner" + } + } + } + ] + } + ], + "bidid": "request-id", + "cur": "USD" + } + } + }], + "expectedBidResponses": [ + { + "currency": "USD", + "bids": [ + { + "bid": { + "id": "bid-id-1", + "impid": "imp-id-1", + "price": 0.5, + "adid": "29681111", + "adm": "some-test-ad", + "adomain": [ + "foo.com" + ], + "crid": "29681111", + "h": 250, + "w": 300, + "dealid": "test deal 1", + "ext": { + "prebid": { + "type": "banner" + } + } + }, + "type": "banner" + }, + { + "bid": { + "id": "bid-id-2", + "impid": "imp-id-2", + "price": 0.5, + "adid": "29681112", + "adm": "some-test-ad", + "adomain": [ + "foo.com" + ], + "crid": "29681112", + "h": 200, + "w": 350, + "dealid": "test deal 2", + "ext": { + "prebid": { + "type": "banner" + } + } + }, + "type": "banner" + } + ] + } + ] +} \ No newline at end of file diff --git a/adapters/oprx/oprxtest/supplemental/bad-media-type.json b/adapters/oprx/oprxtest/supplemental/bad-media-type.json new file mode 100644 index 00000000000..d523aa72fb7 --- /dev/null +++ b/adapters/oprx/oprxtest/supplemental/bad-media-type.json @@ -0,0 +1,95 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "httpCalls": [{ + "expectedRequest": { + "uri": "http://localhost:8080", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "impIDs": ["imp-id"] + },"mockResponse": { + "status": 200, + "body": { + "id": "request-id", + "seatbid": [ + { + "seat": "958", + "bid": [ + { + "id": "bid-id", + "impid": "imp-id", + "price": 0.5, + "adid": "29681110", + "adm": "some-test-ad", + "adomain": [ + "foo.com" + ], + "crid": "29681110", + "h": 250, + "w": 300, + "dealid": "test deal", + "ext": { + "prebid": { + "type": "bamer" + } + } + } + ] + } + ], + "bidid": "request-id", + "cur": "USD" + } + } + }], + "expectedBidResponses": [{ + "currency": "USD", + "bids": [] +}] +} \ No newline at end of file diff --git a/adapters/oprx/oprxtest/supplemental/bad-request.json b/adapters/oprx/oprxtest/supplemental/bad-request.json new file mode 100644 index 00000000000..18100fa3afc --- /dev/null +++ b/adapters/oprx/oprxtest/supplemental/bad-request.json @@ -0,0 +1,68 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "httpCalls": [{ + "expectedRequest": { + "uri": "http://localhost:8080", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "impIDs": ["imp-id"] + }, + "mockResponse": { + "status": 400 + } + }], + "expectedBidResponses": [], + "expectedMakeBidsErrors": [ + { + "value": "Unexpected status code: 400. Run with request.debug = 1 for more info", + "comparison": "literal" + } + ] +} \ No newline at end of file diff --git a/adapters/oprx/oprxtest/supplemental/no-bid.json b/adapters/oprx/oprxtest/supplemental/no-bid.json new file mode 100644 index 00000000000..1e049f63f72 --- /dev/null +++ b/adapters/oprx/oprxtest/supplemental/no-bid.json @@ -0,0 +1,62 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "httpCalls": [{ + "expectedRequest": { + "uri": "http://localhost:8080", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "key": "p123", + "placement_id": "my-placement-id", + "bid-floor": 0.5, + "npi": "my-npi", + "ndc": "my-ndc" + } + } + } + ] + }, + "impIDs": ["imp-id"] + }, + "mockResponse": { + "status": 204 + } + }], + "expectedBidResponses": [] +} \ No newline at end of file diff --git a/adapters/oprx/params_test.go b/adapters/oprx/params_test.go new file mode 100644 index 00000000000..b5afdf864c4 --- /dev/null +++ b/adapters/oprx/params_test.go @@ -0,0 +1,56 @@ +package oprx + +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 schema. %v", err) + } + + for _, p := range validParams { + if err := validator.Validate(openrtb_ext.BidderOprx, json.RawMessage(p)); err != nil { + t.Errorf("Schema rejected valid params: %s", p) + } + } +} + +func TestInvalidParams(t *testing.T) { + validator, err := openrtb_ext.NewBidderParamsValidator("../../static/bidder-params") + if err != nil { + t.Fatalf("Failed to fetch the json schema. %v", err) + } + + for _, p := range invalidParams { + if err := validator.Validate(openrtb_ext.BidderOprx, json.RawMessage(p)); err == nil { + t.Errorf("Schema allowed invalid params: %s", p) + } + } +} + +var validParams = []string{ + `{"key": "some key", "placement_id": 1234567890, "type": "banner"}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "width": 1234}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "height": 5678}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "bid_floor": 1.23}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "npi": "some npi"}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "ndc": "some ndc"}`, +} + +var invalidParams = []string{ + `{"key": 1234567, "placement_id": 1234567890, "type": "banner"}`, + `{"placement_id": "1234567890", "key": "some key", "type": "banner"}`, + `{"key": "some key", "placement_id": 1234567890, "type": 12}`, + `{"key": "some key"}`, + `{"placement_id": 1234567890, "type": 12}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "width": "1234"}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "height": "5678"}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "bid_floor": "1.23"}`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "npi": 1223456`, + `{"key": "some key", "placement_id": 1234567890, "type": "banner", "ndc": 876543}`, +} diff --git a/exchange/adapter_builders.go b/exchange/adapter_builders.go index 751934ac9bb..04247c67872 100755 --- a/exchange/adapter_builders.go +++ b/exchange/adapter_builders.go @@ -169,6 +169,7 @@ import ( "github.com/prebid/prebid-server/v3/adapters/openweb" "github.com/prebid/prebid-server/v3/adapters/openx" "github.com/prebid/prebid-server/v3/adapters/operaads" + "github.com/prebid/prebid-server/v3/adapters/oprx" "github.com/prebid/prebid-server/v3/adapters/optidigital" "github.com/prebid/prebid-server/v3/adapters/oraki" "github.com/prebid/prebid-server/v3/adapters/orbidder" @@ -427,6 +428,7 @@ func newAdapterBuilders() map[openrtb_ext.BidderName]adapters.Builder { openrtb_ext.BidderOpenWeb: openweb.Builder, openrtb_ext.BidderOpenx: openx.Builder, openrtb_ext.BidderOperaads: operaads.Builder, + openrtb_ext.BidderOprx: oprx.Builder, openrtb_ext.BidderOptidigital: optidigital.Builder, openrtb_ext.BidderOraki: oraki.Builder, openrtb_ext.BidderOrbidder: orbidder.Builder, diff --git a/openrtb_ext/bidders.go b/openrtb_ext/bidders.go index 102c9094c32..47004b3abb8 100644 --- a/openrtb_ext/bidders.go +++ b/openrtb_ext/bidders.go @@ -187,6 +187,7 @@ var coreBidderNames []BidderName = []BidderName{ BidderOpenWeb, BidderOpenx, BidderOperaads, + BidderOprx, BidderOptidigital, BidderOraki, BidderOrbidder, @@ -549,6 +550,7 @@ const ( BidderOpenWeb BidderName = "openweb" BidderOpenx BidderName = "openx" BidderOperaads BidderName = "operaads" + BidderOprx BidderName = "oprx" BidderOptidigital BidderName = "optidigital" BidderOraki BidderName = "oraki" BidderOrbidder BidderName = "orbidder" diff --git a/openrtb_ext/imp_oprx.go b/openrtb_ext/imp_oprx.go new file mode 100644 index 00000000000..96ce59c0b2e --- /dev/null +++ b/openrtb_ext/imp_oprx.go @@ -0,0 +1,12 @@ +package openrtb_ext + +type ImpExtOprx struct { + Key string `json:"key"` + PlacementID int `json:"placement_id"` + Width int `json:"width"` + Height int `json:"height"` + BidFloor float64 `json:"bid_floor"` + Npi string `json:"npi"` + Ndc string `json:"ndc"` + Type string `json:"type"` +} diff --git a/static/bidder-info/oprx.yaml b/static/bidder-info/oprx.yaml new file mode 100644 index 00000000000..346fca8b5c1 --- /dev/null +++ b/static/bidder-info/oprx.yaml @@ -0,0 +1,20 @@ +endpoint: "https://pb.optimizerx.com/pb" +endpointCompression: gzip +geoscope: + - USA + - CAN +maintainer: + email: adsupport@optimizerx.com +modifyingVastXmlAllowed: true +openrtb: + version: 2.6 +capabilities: + app: + mediaTypes: + - banner + site: + mediaTypes: + - banner + dooh: + mediaTypes: + - banner \ No newline at end of file diff --git a/static/bidder-params/oprx.json b/static/bidder-params/oprx.json new file mode 100644 index 00000000000..1b59efc5f38 --- /dev/null +++ b/static/bidder-params/oprx.json @@ -0,0 +1,43 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "OptimizeRx Adapter Params", + "description": "A schema which validates params accepted by the OptimizeRx adapter", + "type": "object", + + "properties": { + "key": { + "type": "string", + "description": "Key" + }, + "placement_id": { + "type": "integer", + "description": "Placement ID" + }, + "width": { + "type": "integer", + "description": "Banner Width" + }, + "height": { + "type": "integer", + "description": "Banner Height" + }, + "bid_floor": { + "type": "number", + "description": "Bidding Price Floor" + }, + "npi": { + "type": "string", + "description": "NPI" + }, + "ndc": { + "type": "string", + "description": "NDC" + }, + "type": { + "type": "string", + "description": "Type of Bid/Impression" + } + }, + + "required": ["key", "placement_id", "type"] +} \ No newline at end of file