diff --git a/adapters/optidigital/optidigital.go b/adapters/optidigital/optidigital.go new file mode 100644 index 00000000000..89e2474d977 --- /dev/null +++ b/adapters/optidigital/optidigital.go @@ -0,0 +1,71 @@ +package optidigital + +import ( + "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 +} + +// Builder builds a new instance of the optidigital adapter for the given bidder with the given config. +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: http.MethodPost, + 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} + } + + var response openrtb2.BidResponse + if err := jsonutil.Unmarshal(responseData.Body, &response); err != nil { + return nil, []error{&errortypes.BadServerResponse{ + Message: "Bad Server Response", + }} + } + + bidResponse := adapters.NewBidderResponseWithBidsCapacity(len(request.Imp)) + bidResponse.Currency = response.Cur + + for _, seatBid := range response.SeatBid { + for i := range seatBid.Bid { + bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{ + Bid: &seatBid.Bid[i], + BidType: openrtb_ext.BidTypeBanner, + }) + } + } + return bidResponse, nil +} diff --git a/adapters/optidigital/optidigital_test.go b/adapters/optidigital/optidigital_test.go new file mode 100644 index 00000000000..dda8b09b549 --- /dev/null +++ b/adapters/optidigital/optidigital_test.go @@ -0,0 +1,21 @@ +package optidigital + +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.BidderOptidigital, config.Adapter{ + Endpoint: "https://pbs.optidigital.com/bidder/openrtb2", + }, config.Server{}) + + if buildErr != nil { + t.Fatalf("Builder returned unexpected error %v", buildErr) + } + + adapterstest.RunJSONBidderTest(t, "optidigitaltest", bidder) +} diff --git a/adapters/optidigital/optidigitaltest/exemplary/banner.json b/adapters/optidigital/optidigitaltest/exemplary/banner.json new file mode 100644 index 00000000000..fa6c90fe378 --- /dev/null +++ b/adapters/optidigital/optidigitaltest/exemplary/banner.json @@ -0,0 +1,107 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "httpCalls": [ + { + "expectedRequest": { + "uri": "https://pbs.optidigital.com/bidder/openrtb2", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "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" + } + ] + } + ], + "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", + "w": 300, + "h": 250, + "dealid": "test deal" + }, + "type": "banner" + } + ] + } + ] +} \ No newline at end of file diff --git a/adapters/optidigital/optidigitaltest/supplemental/bad_request.json b/adapters/optidigital/optidigitaltest/supplemental/bad_request.json new file mode 100644 index 00000000000..9ac0c5f4f7e --- /dev/null +++ b/adapters/optidigital/optidigitaltest/supplemental/bad_request.json @@ -0,0 +1,63 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "httpCalls": [ + { + "expectedRequest": { + "uri": "https://pbs.optidigital.com/bidder/openrtb2", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "impIDs": ["imp-id"] + }, + "mockResponse": { + "status": 400 + } + } + ], + "expectedMakeBidsErrors": [ + { + "value": "Unexpected status code: 400", + "comparison": "startswith" + } + ] +} \ No newline at end of file diff --git a/adapters/optidigital/optidigitaltest/supplemental/bad_response.json b/adapters/optidigital/optidigitaltest/supplemental/bad_response.json new file mode 100644 index 00000000000..c60d0e3b00d --- /dev/null +++ b/adapters/optidigital/optidigitaltest/supplemental/bad_response.json @@ -0,0 +1,65 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "httpCalls": [ + { + "expectedRequest": { + "uri": "https://pbs.optidigital.com/bidder/openrtb2", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "impIDs": ["imp-id"] + }, + "mockResponse": { + "status": 200, + "body": "invalid response" + } + } + ], + + "expectedMakeBidsErrors": [ + { + "value": "Bad Server Response", + "comparison": "literal" + } + ] +} \ No newline at end of file diff --git a/adapters/optidigital/optidigitaltest/supplemental/no_response.json b/adapters/optidigital/optidigitaltest/supplemental/no_response.json new file mode 100644 index 00000000000..84de5fb48ce --- /dev/null +++ b/adapters/optidigital/optidigitaltest/supplemental/no_response.json @@ -0,0 +1,57 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "httpCalls": [ + { + "expectedRequest": { + "uri": "https://pbs.optidigital.com/bidder/openrtb2", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "impIDs": ["imp-id"] + }, + "mockResponse": { + "status": 204 + } + } + ] +} \ No newline at end of file diff --git a/adapters/optidigital/optidigitaltest/supplemental/other_error.json b/adapters/optidigital/optidigitaltest/supplemental/other_error.json new file mode 100644 index 00000000000..3cc17d63d36 --- /dev/null +++ b/adapters/optidigital/optidigitaltest/supplemental/other_error.json @@ -0,0 +1,63 @@ +{ + "mockBidRequest": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "httpCalls": [ + { + "expectedRequest": { + "uri": "https://pbs.optidigital.com/bidder/openrtb2", + "body": { + "id": "request-id", + "imp": [ + { + "id": "imp-id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "publisherId": "p123", + "placementId": "my-placement-id" + } + } + } + ] + }, + "impIDs": ["imp-id"] + }, + "mockResponse": { + "status": 500 + } + } + ], + "expectedMakeBidsErrors": [ + { + "value": "Unexpected status code: 500", + "comparison": "startswith" + } + ] +} \ No newline at end of file diff --git a/adapters/optidigital/params_test.go b/adapters/optidigital/params_test.go new file mode 100644 index 00000000000..5c29d9796dd --- /dev/null +++ b/adapters/optidigital/params_test.go @@ -0,0 +1,62 @@ +package optidigital + +import ( + "encoding/json" + "testing" + + "github.com/prebid/prebid-server/v3/openrtb_ext" +) + +// This file actually intends to test static/bidder-params/optidigital.json +// +// These also validate the format of the external API: request.imp[i].ext.prebid.bidder.optidigital + +// TestValidParams makes sure that the optidigital schema accepts all imp.ext fields which we intend to support. +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.BidderOptidigital, json.RawMessage(validParam)); err != nil { + t.Errorf("Schema rejected optidigital params: %s \n Error: %s", validParam, err) + } + } +} + +// TestInvalidParams makes sure that the optidigital schema rejects all the imp.ext fields we don't support. +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.BidderOptidigital, json.RawMessage(invalidParam)); err == nil { + t.Errorf("Schema allowed unexpected params: %s", invalidParam) + } + } +} + +var validParams = []string{ + `{"publisherId":"p123","placementId":"foo-placement"}`, + `{"publisherId":"p123","placementId":"foo-placement","divId":""}`, + `{"publisherId":"p123","placementId":"foo-placement","divId":"foo-div"}`, + `{"publisherId":"p123","placementId":"foo-placement","divId":"foo-div","pageTemplate":""}`, + `{"publisherId":"p123","placementId":"foo-placement","divId":"foo-div","pageTemplate":"foo-page-template"}`, +} + +var invalidParams = []string{ + ``, + `null`, + `true`, + `5`, + `4.2`, + `[]`, + `{}`, + `{"publisherId":""}`, + `{"publisherId":"p123","placementId":""}`, + `{"publisherId":"","placementId":"foo-placement"}`, + `{"publisherId":"p","placementId":"foo-placement"}`, +} diff --git a/exchange/adapter_builders.go b/exchange/adapter_builders.go index 7647de71786..b1a40cb3726 100755 --- a/exchange/adapter_builders.go +++ b/exchange/adapter_builders.go @@ -163,6 +163,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/optidigital" "github.com/prebid/prebid-server/v3/adapters/oraki" "github.com/prebid/prebid-server/v3/adapters/orbidder" "github.com/prebid/prebid-server/v3/adapters/outbrain" @@ -413,6 +414,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.BidderOptidigital: optidigital.Builder, openrtb_ext.BidderOraki: oraki.Builder, openrtb_ext.BidderOrbidder: orbidder.Builder, openrtb_ext.BidderOutbrain: outbrain.Builder, diff --git a/openrtb_ext/bidders.go b/openrtb_ext/bidders.go index 10755dfd7fd..1c30c22b486 100644 --- a/openrtb_ext/bidders.go +++ b/openrtb_ext/bidders.go @@ -181,6 +181,7 @@ var coreBidderNames []BidderName = []BidderName{ BidderOpenWeb, BidderOpenx, BidderOperaads, + BidderOptidigital, BidderOraki, BidderOrbidder, BidderOutbrain, @@ -535,6 +536,7 @@ const ( BidderOpenWeb BidderName = "openweb" BidderOpenx BidderName = "openx" BidderOperaads BidderName = "operaads" + BidderOptidigital BidderName = "optidigital" BidderOraki BidderName = "oraki" BidderOrbidder BidderName = "orbidder" BidderOutbrain BidderName = "outbrain" diff --git a/openrtb_ext/imp_optidigital.go b/openrtb_ext/imp_optidigital.go new file mode 100644 index 00000000000..e34280c588b --- /dev/null +++ b/openrtb_ext/imp_optidigital.go @@ -0,0 +1,8 @@ +package openrtb_ext + +type ImpExtOptidigital struct { + PublisherID string `json:"publisherId"` + PlacementID string `json:"placementId"` + PageTemplate string `json:"pageTemplate,omitempty"` + DivID string `json:"divId,omitempty"` +} diff --git a/static/bidder-info/optidigital.yaml b/static/bidder-info/optidigital.yaml new file mode 100644 index 00000000000..b0df8a5ef85 --- /dev/null +++ b/static/bidder-info/optidigital.yaml @@ -0,0 +1,23 @@ +endpoint: "https://pbs.optidigital.com/bidder/openrtb2" +endpointCompression: gzip +maintainer: + email: "prebid@optidigital.com" +gvlVendorID: 915 +openrtb: + version: 2.6 +capabilities: + app: + mediaTypes: + - banner + site: + mediaTypes: + - banner + dooh: + mediaTypes: + - banner +userSync: + supports: + - iframe + iframe: + url: "https://scripts.opti-digital.com/js/presyncs2s.html?endpoint=optidigital&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&redir={{.RedirectURL}}" + userMacro: "$UID" \ No newline at end of file diff --git a/static/bidder-params/optidigital.json b/static/bidder-params/optidigital.json new file mode 100644 index 00000000000..6d4a04b3502 --- /dev/null +++ b/static/bidder-params/optidigital.json @@ -0,0 +1,32 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Optidigital Adapter Params", + "description": "A schema which validates params accepted by the Optidigital adapter", + "type": "object", + + "properties": { + "publisherId": { + "type": "string", + "minLength": 2, + "description": "Publisher ID" + }, + "placementId": { + "type": "string", + "minLength": 1, + "description": "Placement ID" + }, + "divId": { + "type": "string", + "description": "Div ID" + }, + "pageTemplate": { + "type": "string", + "description": "Page Template" + } + }, + + "required":[ + "publisherId", + "placementId" + ] + } \ No newline at end of file