New Adapter: MadSense #4169
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| package madsense | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/url" | ||
|
|
||
| "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 MadSense 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, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) { | ||
| reqs := make([]*adapters.RequestData, 0, len(request.Imp)) | ||
| var errs []error | ||
|
|
||
| appendReq := func(imps []openrtb2.Imp) { | ||
| req, err := a.makeRequest(request, imps) | ||
| if err != nil { | ||
| errs = append(errs, err) | ||
| return | ||
| } | ||
| if req != nil { | ||
| reqs = append(reqs, req) | ||
| } | ||
| } | ||
|
|
||
| var videoImps, bannerImps []openrtb2.Imp | ||
| for _, imp := range request.Imp { | ||
| if imp.Banner != nil { | ||
| bannerImps = append(bannerImps, imp) | ||
| } else if imp.Video != nil { | ||
| videoImps = append(videoImps, imp) | ||
| } | ||
| } | ||
|
|
||
| // we support video podding, so we want to send all video impressions in a single request | ||
| appendReq(videoImps) | ||
| for _, bannerImp := range bannerImps { | ||
| appendReq([]openrtb2.Imp{bannerImp}) | ||
| } | ||
|
|
||
| return reqs, errs | ||
| } | ||
|
|
||
| func (a *adapter) makeRequest(request *openrtb2.BidRequest, imps []openrtb2.Imp) (*adapters.RequestData, error) { | ||
| if len(imps) == 0 { | ||
| return nil, nil | ||
| } | ||
| ext, err := parseImpExt(&imps[0]) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| request.Imp = imps | ||
| body, err := json.Marshal(request) | ||
|
There was a problem hiding this comment. Please use jsonutil for marshaling |
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if request.Test == 1 { | ||
| ext.CompanyId = "test" | ||
|
There was a problem hiding this comment. Please add test coverage for this line. There was a problem hiding this comment. tested in new supplemental test |
||
| } | ||
|
Comment on lines
+76
to
+78
There was a problem hiding this comment. When |
||
|
|
||
| return &adapters.RequestData{ | ||
| Method: http.MethodPost, | ||
| Uri: a.getEndpointURL(ext), | ||
| Body: body, | ||
| Headers: getHeaders(request), | ||
| ImpIDs: openrtb_ext.GetImpIDs(request.Imp), | ||
| }, nil | ||
| } | ||
|
|
||
| func (a *adapter) getEndpointURL(ext *openrtb_ext.ExtImpMadSense) string { | ||
| params := url.Values{} | ||
| params.Add("company_id", ext.CompanyId) | ||
| return a.endpoint + "?" + params.Encode() | ||
| } | ||
|
|
||
| func (a *adapter) MakeBids(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error) { | ||
| if adapters.IsResponseStatusCodeNoContent(response) { | ||
| return nil, nil | ||
| } | ||
|
|
||
| if err := adapters.CheckResponseStatusCodeForErrors(response); err != nil { | ||
| return nil, []error{err} | ||
| } | ||
|
|
||
| var resp openrtb2.BidResponse | ||
| if err := jsonutil.Unmarshal(response.Body, &resp); err != nil { | ||
| return nil, []error{&errortypes.BadServerResponse{ | ||
| Message: "Bad Server Response", | ||
| }} | ||
|
Comment on lines
+106
to
+108
There was a problem hiding this comment. Please add a supplemental test case where the There was a problem hiding this comment. tested in new supplemental test |
||
| } | ||
|
|
||
| var bidErrors []error | ||
| bidderResponse := adapters.NewBidderResponseWithBidsCapacity(1) | ||
| for _, seatBid := range resp.SeatBid { | ||
| for i := range seatBid.Bid { | ||
| bid := &seatBid.Bid[i] | ||
| typedBid, err := getTypedBidFromBid(bid) | ||
| if err != nil { | ||
| bidErrors = append(bidErrors, err) | ||
| continue | ||
| } | ||
| bidderResponse.Bids = append(bidderResponse.Bids, typedBid) | ||
| } | ||
| } | ||
|
|
||
| return bidderResponse, bidErrors | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package madsense | ||
|
|
||
| import ( | ||
| "github.com/prebid/prebid-server/v3/adapters/adapterstest" | ||
| "github.com/prebid/prebid-server/v3/config" | ||
| "github.com/prebid/prebid-server/v3/openrtb_ext" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestJsonSamples(t *testing.T) { | ||
| bidder, buildErr := Builder(openrtb_ext.BidderMadSense, config.Adapter{ | ||
| Endpoint: "https://test.localhost.com"}, config.Server{ExternalUrl: "http://hosturl.com", GvlID: 1, DataCenter: "2"}) | ||
|
|
||
| if buildErr != nil { | ||
| t.Fatalf("Builder returned unexpected error %v", buildErr) | ||
| } | ||
| adapterstest.RunJSONBidderTest(t, "madsensetest", bidder) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| { | ||
| "mockBidRequest": { | ||
| "id": "test-request-id", | ||
| "imp": [ | ||
| { | ||
| "id": "test-imp-id", | ||
| "banner": { | ||
| "w": 300, | ||
| "h": 250 | ||
| }, | ||
| "ext": { | ||
| "bidder": { | ||
| "company_id": "9876543" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "device": { | ||
| "ua": "user-agent", | ||
| "ip": "1.2.3.4" | ||
| }, | ||
| "app": { | ||
| "bundle": "54321" | ||
| } | ||
| }, | ||
| "httpCalls": [ | ||
| { | ||
| "expectedRequest": { | ||
| "method": "POST", | ||
| "headers": { | ||
| "Accept": [ | ||
| "application/json" | ||
| ], | ||
| "Content-Type": [ | ||
| "application/json;charset=utf-8" | ||
| ], | ||
| "X-Openrtb-Version": [ | ||
| "2.6" | ||
| ], | ||
| "User-Agent": [ | ||
| "user-agent" | ||
| ], | ||
| "X-Forwarded-For": [ | ||
| "1.2.3.4" | ||
| ] | ||
| }, | ||
| "uri": "https://test.localhost.com?company_id=9876543", | ||
| "body": { | ||
| "id": "test-request-id", | ||
| "imp": [ | ||
| { | ||
| "id": "test-imp-id", | ||
| "banner": { | ||
| "w": 300, | ||
| "h": 250 | ||
| }, | ||
| "ext": { | ||
| "bidder": { | ||
| "company_id": "9876543" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "device": { | ||
| "ua": "user-agent", | ||
| "ip": "1.2.3.4" | ||
| }, | ||
| "app": { | ||
| "bundle": "54321" | ||
| } | ||
| }, | ||
| "impIDs":["test-imp-id"] | ||
| }, | ||
| "mockResponse": { | ||
| "status": 200, | ||
| "body": { | ||
| "cur": "USD", | ||
| "seatbid": [ | ||
| { | ||
| "bid": [ | ||
| { | ||
| "id": "884f46aa-25ab-488a-bd7e-90e3a31a03e0", | ||
| "crid": "b83e6e58-9342-4e8c-bf6a-4ad09b231547", | ||
| "price": 10, | ||
| "impid": "test-imp-id", | ||
| "adm": "<img src=\"demo ad\" width=\"300\" height=\"250\">", | ||
| "mtype": 1 | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "seat": "madsense" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "expectedBidResponses": [ | ||
| { | ||
| "currency": "USD", | ||
| "bids": [ | ||
| { | ||
| "bid": { | ||
| "id": "884f46aa-25ab-488a-bd7e-90e3a31a03e0", | ||
| "crid": "b83e6e58-9342-4e8c-bf6a-4ad09b231547", | ||
| "price": 10, | ||
| "impid": "test-imp-id", | ||
| "adm": "<img src=\"demo ad\" width=\"300\" height=\"250\">", | ||
| "mtype": 1 | ||
| }, | ||
| "type": "banner" | ||
| } | ||
| ], | ||
| "seat": "madsense" | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| { | ||
| "mockBidRequest": { | ||
| "id": "test-request-id", | ||
| "imp": [ | ||
| { | ||
| "id": "test-imp-id", | ||
| "banner": { | ||
| "w": 300, | ||
| "h": 250 | ||
| }, | ||
| "ext": { | ||
| "bidder": { | ||
| "company_id": "9876543" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "device": { | ||
| "ua": "user-agent", | ||
| "ipv6": "2001:db8:3333:4444:5555:6666:7777:8888" | ||
| }, | ||
| "site": { | ||
| "domain": "domain.com", | ||
| "page": "http://domain.com/page", | ||
| "ref": "https://example.com/page" | ||
| } | ||
| }, | ||
| "httpCalls": [ | ||
| { | ||
| "expectedRequest": { | ||
| "method": "POST", | ||
| "headers": { | ||
| "Accept": [ | ||
| "application/json" | ||
| ], | ||
| "Content-Type": [ | ||
| "application/json;charset=utf-8" | ||
| ], | ||
| "Origin": [ | ||
| "domain.com" | ||
| ], | ||
| "X-Openrtb-Version": [ | ||
| "2.6" | ||
| ], | ||
| "User-Agent": [ | ||
| "user-agent" | ||
| ], | ||
| "X-Forwarded-For": [ | ||
| "2001:db8:3333:4444:5555:6666:7777:8888" | ||
| ], | ||
| "Referer": [ | ||
| "https://example.com/page" | ||
| ] | ||
| }, | ||
| "uri": "https://test.localhost.com?company_id=9876543", | ||
| "body": { | ||
| "id": "test-request-id", | ||
| "imp": [ | ||
| { | ||
| "id": "test-imp-id", | ||
| "banner": { | ||
| "w": 300, | ||
| "h": 250 | ||
| }, | ||
| "ext": { | ||
| "bidder": { | ||
| "company_id": "9876543" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "device": { | ||
| "ua": "user-agent", | ||
| "ipv6": "2001:db8:3333:4444:5555:6666:7777:8888" | ||
| }, | ||
| "site": { | ||
| "domain": "domain.com", | ||
| "page": "http://domain.com/page", | ||
| "ref": "https://example.com/page" | ||
| } | ||
| }, | ||
| "impIDs":["test-imp-id"] | ||
| }, | ||
| "mockResponse": { | ||
| "status": 200, | ||
| "body": { | ||
| "cur": "USD", | ||
| "seatbid": [ | ||
| { | ||
| "bid": [ | ||
| { | ||
| "id": "884f46aa-25ab-488a-bd7e-90e3a31a03e0", | ||
| "crid": "b83e6e58-9342-4e8c-bf6a-4ad09b231547", | ||
| "price": 10, | ||
| "impid": "test-imp-id", | ||
| "adm": "<iframe width=\"300\" height=\"250\"></iframe>", | ||
| "mtype": 1 | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "seat": "madsense" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "expectedBidResponses": [ | ||
| { | ||
| "currency": "USD", | ||
| "bids": [ | ||
| { | ||
| "bid": { | ||
| "id": "884f46aa-25ab-488a-bd7e-90e3a31a03e0", | ||
| "crid": "b83e6e58-9342-4e8c-bf6a-4ad09b231547", | ||
| "price": 10, | ||
| "impid": "test-imp-id", | ||
| "adm": "<iframe width=\"300\" height=\"250\"></iframe>", | ||
| "mtype": 1 | ||
| }, | ||
| "type": "banner" | ||
| } | ||
| ], | ||
| "seat": "madsense" | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
There's an issue here because you're mixing named returns with local variable declarations. I suggest deleting the named returns
requestsanderrorsand always using the local variablesreqsanderrs.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.
agreed, I switched to only using local variables