-
Notifications
You must be signed in to change notification settings - Fork 693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Adapter: VideoByte #2058
New Adapter: VideoByte #2058
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
package videobyte | ||
|
||
import ( | ||
"encoding/json" | ||
"testing" | ||
|
||
"github.com/prebid/prebid-server/openrtb_ext" | ||
) | ||
|
||
// This file actually intends to test static/bidder-params/videobyte.json | ||
// | ||
// These also validate the format of the external API: request.imp[i].ext.videobyte | ||
|
||
// TestValidParams makes sure that the videobyte 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.BidderVideoByte, json.RawMessage(validParam)); err != nil { | ||
t.Errorf("Schema rejected videobyte params: %s", validParam) | ||
} | ||
} | ||
} | ||
|
||
// TestInvalidParams makes sure that the videobyte 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.BidderVideoByte, json.RawMessage(invalidParam)); err == nil { | ||
t.Errorf("Schema allowed unexpected params: %s", invalidParam) | ||
} | ||
} | ||
} | ||
|
||
var validParams = []string{ | ||
`{"pubId": "123"}`, | ||
`{"pubId": "123", "placementId": "4"}`, | ||
`{"pubId": "123", "nid": "5"}`, | ||
`{"pubId": "123", "placementId": "4", "nid": "5"}`, | ||
} | ||
|
||
var invalidParams = []string{ | ||
`{"invalidParam" : "a"}`, | ||
`{}`, | ||
`{"placementId": "4"}`, | ||
`{"nid": "5"}`, | ||
`{"placementId": "4", "nid": "5"}`, | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
package videobyte | ||
|
||
import ( | ||
"encoding/json" | ||
"fmt" | ||
"net/http" | ||
"net/url" | ||
|
||
"github.com/prebid/prebid-server/adapters" | ||
"github.com/prebid/prebid-server/config" | ||
"github.com/prebid/prebid-server/errortypes" | ||
"github.com/prebid/prebid-server/openrtb_ext" | ||
|
||
"github.com/mxmCherry/openrtb/v15/openrtb2" | ||
) | ||
|
||
type adapter struct { | ||
endpoint string | ||
} | ||
|
||
func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error) { | ||
bidder := &adapter{ | ||
endpoint: config.Endpoint, | ||
} | ||
return bidder, nil | ||
} | ||
|
||
func (a *adapter) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) { | ||
impressions := request.Imp | ||
adapterRequests := make([]*adapters.RequestData, 0, len(impressions)) | ||
var errs []error | ||
|
||
for _, impression := range impressions { | ||
impExt, err := parseExt(&impression) | ||
if err != nil { | ||
errs = append(errs, err) | ||
continue | ||
} | ||
|
||
request.Imp = []openrtb2.Imp{impression} | ||
body, err := json.Marshal(request) | ||
if err != nil { | ||
errs = append(errs, err) | ||
continue | ||
} | ||
|
||
adapterRequests = append(adapterRequests, &adapters.RequestData{ | ||
Method: http.MethodPost, | ||
Uri: a.endpoint + "?" + getParams(impExt).Encode(), | ||
Body: body, | ||
Headers: getHeaders(request), | ||
}) | ||
} | ||
|
||
request.Imp = impressions | ||
return adapterRequests, errs | ||
} | ||
|
||
func (a *adapter) MakeBids(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error) { | ||
if response.StatusCode == http.StatusNoContent { | ||
return nil, nil | ||
} | ||
|
||
if response.StatusCode == http.StatusBadRequest { | ||
return nil, []error{&errortypes.BadInput{ | ||
Message: fmt.Sprintf("Bad user input: HTTP status %d. Run with request.debug = 1 for more info", response.StatusCode), | ||
}} | ||
} | ||
|
||
if response.StatusCode != http.StatusOK { | ||
return nil, []error{&errortypes.BadServerResponse{ | ||
Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info", response.StatusCode), | ||
}} | ||
} | ||
|
||
var ortbResponse openrtb2.BidResponse | ||
err := json.Unmarshal(response.Body, &ortbResponse) | ||
if err != nil { | ||
return nil, []error{&errortypes.BadServerResponse{ | ||
Message: "Bad Server Response", | ||
}} | ||
} | ||
|
||
impIdToImp := make(map[string]*openrtb2.Imp) | ||
for i := range internalRequest.Imp { | ||
imp := internalRequest.Imp[i] | ||
impIdToImp[imp.ID] = &imp | ||
} | ||
|
||
bidderResponse := adapters.NewBidderResponseWithBidsCapacity(1) | ||
for _, seatBid := range ortbResponse.SeatBid { | ||
for i := range seatBid.Bid { | ||
bid := seatBid.Bid[i] | ||
bidderResponse.Bids = append(bidderResponse.Bids, &adapters.TypedBid{ | ||
Bid: &bid, | ||
BidType: getMediaTypeForImp(impIdToImp[bid.ImpID]), | ||
}) | ||
} | ||
} | ||
|
||
return bidderResponse, nil | ||
} | ||
|
||
func getMediaTypeForImp(imp *openrtb2.Imp) openrtb_ext.BidType { | ||
if imp != nil && imp.Banner != nil { | ||
return openrtb_ext.BidTypeBanner | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is your bid server always guaranteed to respond with a banner bid for multi-format imps that may have both banner and video configured? If not, is there any indication in the bid returned about the media type? If so, I'd recommend using that to determine the media type of the bid There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, it is guaranteed to respond with a banner bid for multi-format imps that have both video and banner. |
||
} | ||
return openrtb_ext.BidTypeVideo | ||
} | ||
|
||
func getParams(impExt *openrtb_ext.ExtImpVideoByte) url.Values { | ||
params := url.Values{} | ||
params.Add("source", "pbs") | ||
params.Add("pid", impExt.PublisherId) | ||
if impExt.PlacementId != "" { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please consider including empty placement ID and network ID in one of your JSON test cases There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added a test case. |
||
params.Add("placementId", impExt.PlacementId) | ||
} | ||
if impExt.NetworkId != "" { | ||
params.Add("nid", impExt.NetworkId) | ||
} | ||
return params | ||
} | ||
|
||
func getHeaders(request *openrtb2.BidRequest) http.Header { | ||
headers := http.Header{} | ||
headers.Add("Content-Type", "application/json;charset=utf-8") | ||
headers.Add("Accept", "application/json") | ||
|
||
if request.Site != nil { | ||
if request.Site.Domain != "" { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please consider including empty Site.Domain and site.Ref in one of your JSON test cases There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added a test case. |
||
headers.Add("Origin", request.Site.Domain) | ||
} | ||
if request.Site.Ref != "" { | ||
headers.Set("Referer", request.Site.Ref) | ||
} | ||
} | ||
return headers | ||
} | ||
|
||
func parseExt(imp *openrtb2.Imp) (*openrtb_ext.ExtImpVideoByte, error) { | ||
var bidderExt adapters.ExtImpBidder | ||
|
||
if err := json.Unmarshal(imp.Ext, &bidderExt); err != nil { | ||
return nil, &errortypes.BadInput{ | ||
Message: fmt.Sprintf("Ignoring imp id=%s, error while decoding extImpBidder, err: %s", imp.ID, err), | ||
} | ||
} | ||
|
||
impExt := openrtb_ext.ExtImpVideoByte{} | ||
err := json.Unmarshal(bidderExt.Bidder, &impExt) | ||
if err != nil { | ||
return nil, &errortypes.BadInput{ | ||
Message: fmt.Sprintf("Ignoring imp id=%s, error while decoding impExt, err: %s", imp.ID, err), | ||
} | ||
} | ||
|
||
return &impExt, nil | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
package videobyte | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/prebid/prebid-server/config" | ||
|
||
"github.com/prebid/prebid-server/adapters/adapterstest" | ||
) | ||
|
||
func TestJsonSamples(t *testing.T) { | ||
bidder, buildErr := Builder("videobyte", config.Adapter{Endpoint: "https://mock.videobyte.com"}) | ||
if buildErr != nil { | ||
t.Fatalf("Builder returned unexpected error %v", buildErr) | ||
} | ||
adapterstest.RunJSONBidderTest(t, "videobytetest", bidder) | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,145 @@ | ||
{ | ||
"mockBidRequest": { | ||
"id": "test-request-id", | ||
"bcat": [ | ||
"IAB25", | ||
"IAB7-39", | ||
"IAB8-18" | ||
], | ||
"user": { | ||
"buyeruid": "user-101", | ||
"yob": 1973 | ||
}, | ||
"device": { | ||
"ua": "my-user-agent", | ||
"ip": "1.2.3.4" | ||
}, | ||
"imp": [ | ||
{ | ||
"id": "test-imp-id", | ||
"banner": { | ||
"w": 300, | ||
"h": 250 | ||
}, | ||
"ext": { | ||
"bidder": { | ||
"pubId": "examplePublisherId", | ||
"placementId": "examplePlacementId", | ||
"nid": "exampleNetworkId" | ||
} | ||
} | ||
} | ||
], | ||
"site": { | ||
"domain": "example.com", | ||
"page": "http://example.com/page-1", | ||
"ref": "http://referer.com/page-2" | ||
} | ||
}, | ||
"httpCalls": [ | ||
{ | ||
"expectedRequest": { | ||
"method": "GET", | ||
"headers": { | ||
"Referer": [ | ||
"http://referer.com/page-2" | ||
], | ||
"Origin": [ | ||
"example.com" | ||
], | ||
"Accept": [ | ||
"application/json" | ||
], | ||
"Content-Type": [ | ||
"application/json;charset=utf-8" | ||
] | ||
}, | ||
"uri": "https://mock.videobyte.com?nid=exampleNetworkId&pid=examplePublisherId&placementId=examplePlacementId&source=pbs", | ||
"body": { | ||
"id": "test-request-id", | ||
"bcat": [ | ||
"IAB25", | ||
"IAB7-39", | ||
"IAB8-18" | ||
], | ||
"user": { | ||
"buyeruid": "user-101", | ||
"yob": 1973 | ||
}, | ||
"device": { | ||
"ua": "my-user-agent", | ||
"ip": "1.2.3.4" | ||
}, | ||
"imp": [ | ||
{ | ||
"id": "test-imp-id", | ||
"banner": { | ||
"w": 300, | ||
"h": 250 | ||
}, | ||
"ext": { | ||
"bidder": { | ||
"pubId": "examplePublisherId", | ||
"placementId": "examplePlacementId", | ||
"nid": "exampleNetworkId" | ||
} | ||
} | ||
} | ||
], | ||
"site": { | ||
"domain": "example.com", | ||
"page": "http://example.com/page-1", | ||
"ref": "http://referer.com/page-2" | ||
} | ||
} | ||
}, | ||
"mockResponse": { | ||
"status": 200, | ||
"body": { | ||
"cur": "USD", | ||
"seatbid": [ | ||
{ | ||
"bid": [ | ||
{ | ||
"id": "fe69dd6d-e85c-4186-80a7-605b530bc23b", | ||
"crid": "72745", | ||
"adomain": [ | ||
"ad-domain.com" | ||
], | ||
"price": 3, | ||
"impid": "test-imp-id", | ||
"adid": "564", | ||
"adm": "<iframe bordercolor=\"#000000\" frameborder=\"0\" height=\"250\" hspace=\"0\" marginheight=\"0\" marginwidth=\"0\" scrolling=\"no\" srcdoc=\"contents\" vspace=\"0\" width=\"300\"></iframe>" | ||
} | ||
], | ||
"seat": "videobyte" | ||
} | ||
], | ||
"bidid": "test-request-id", | ||
"id": "test-request-id" | ||
} | ||
} | ||
} | ||
], | ||
"expectedBidResponses": [ | ||
{ | ||
"currency": "USD", | ||
"bids": [ | ||
{ | ||
"bid": { | ||
"id": "fe69dd6d-e85c-4186-80a7-605b530bc23b", | ||
"crid": "72745", | ||
"adomain": [ | ||
"ad-domain.com" | ||
], | ||
"price": 3, | ||
"impid": "test-imp-id", | ||
"adid": "564", | ||
"adm": "<iframe bordercolor=\"#000000\" frameborder=\"0\" height=\"250\" hspace=\"0\" marginheight=\"0\" marginwidth=\"0\" scrolling=\"no\" srcdoc=\"contents\" vspace=\"0\" width=\"300\"></iframe>" | ||
}, | ||
"type": "banner" | ||
} | ||
] | ||
} | ||
] | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please consider adding a JSON test with multiple imps and also a JSON test with a multi-format imp.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.