Adding GumGum server adapter #748
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,145 @@ | ||
| package gumgum | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "github.com/mxmCherry/openrtb" | ||
| "github.com/prebid/prebid-server/adapters" | ||
| "github.com/prebid/prebid-server/errortypes" | ||
| "github.com/prebid/prebid-server/openrtb_ext" | ||
| "net/http" | ||
| ) | ||
|
|
||
| type GumGumAdapter struct { | ||
| URI string | ||
| } | ||
|
|
||
| func (g *GumGumAdapter) MakeRequests(request *openrtb.BidRequest) ([]*adapters.RequestData, []error) { | ||
| var validImps []openrtb.Imp | ||
| var trackingId string | ||
| var deviceHeight uint64 | ||
| var deviceWidth uint64 | ||
|
|
||
| numRequests := len(request.Imp) | ||
| errs := make([]error, 0, numRequests) | ||
|
|
||
| for i := 0; i < numRequests; i++ { | ||
| imp := request.Imp[i] | ||
| zone, devH, devW, err := preprocess(&imp) | ||
| if err != nil { | ||
| errs = append(errs, err) | ||
| } else { | ||
| if request.Imp[i].Banner != nil { | ||
| bannerCopy := *request.Imp[i].Banner | ||
| if bannerCopy.W == nil && bannerCopy.H == nil && len(bannerCopy.Format) > 0 { | ||
| format := bannerCopy.Format[0] | ||
| bannerCopy.W = &(format.W) | ||
| bannerCopy.H = &(format.H) | ||
| } | ||
| request.Imp[i].Banner = &bannerCopy | ||
| validImps = append(validImps, request.Imp[i]) | ||
| trackingId = zone | ||
| deviceHeight = devH | ||
| deviceWidth = devW | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if len(validImps) == 0 { | ||
| return nil, errs | ||
| } | ||
|
|
||
| request.Imp = validImps | ||
| request.Device = &openrtb.Device{ | ||
| H: deviceHeight, | ||
| W: deviceWidth, | ||
| } | ||
|
|
||
| if request.Site != nil { | ||
|
There was a problem hiding this comment. I notice in your It seems a bit weird that the There was a problem hiding this comment. Sorry that's an oversight on my end. GumGum will only support site for now so I'll correct our bidder-info file. Thanks for catching that! If I modify that file will you have to reapprove? There was a problem hiding this comment. yeah, but it's fine. We're active :) |
||
| siteCopy := *request.Site | ||
| siteCopy.ID = trackingId | ||
| request.Site = &siteCopy | ||
| } | ||
|
|
||
| reqJSON, err := json.Marshal(request) | ||
| if err != nil { | ||
| errs = append(errs, err) | ||
| return nil, errs | ||
| } | ||
|
|
||
| headers := http.Header{} | ||
| headers.Add("Content-Type", "application/json;charset=utf-8") | ||
| headers.Add("Accept", "application/json") | ||
| return []*adapters.RequestData{{ | ||
| Method: "POST", | ||
| Uri: g.URI, | ||
| Body: reqJSON, | ||
| Headers: headers, | ||
| }}, errs | ||
| } | ||
|
|
||
| func (g *GumGumAdapter) MakeBids(internalRequest *openrtb.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", response.StatusCode), | ||
| }} | ||
| } | ||
|
|
||
| if response.StatusCode != http.StatusOK { | ||
| return nil, []error{&errortypes.BadServerResponse{ | ||
| Message: fmt.Sprintf("Bad server response: HTTP status %d", response.StatusCode), | ||
| }} | ||
| } | ||
| var bidResp openrtb.BidResponse | ||
| if err := json.Unmarshal(response.Body, &bidResp); err != nil { | ||
| return nil, []error{&errortypes.BadServerResponse{ | ||
| Message: fmt.Sprintf("Bad server response: %d. ", err), | ||
| }} | ||
| } | ||
|
|
||
| var errs []error | ||
| bidResponse := adapters.NewBidderResponseWithBidsCapacity(5) | ||
|
|
||
| for _, sb := range bidResp.SeatBid { | ||
| for i := range sb.Bid { | ||
| bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{ | ||
| Bid: &sb.Bid[i], | ||
| BidType: openrtb_ext.BidTypeBanner, | ||
| }) | ||
| } | ||
| } | ||
| return bidResponse, errs | ||
| } | ||
|
|
||
| func preprocess(imp *openrtb.Imp) (string, uint64, uint64, error) { | ||
| var bidderExt adapters.ExtImpBidder | ||
| if err := json.Unmarshal(imp.Ext, &bidderExt); err != nil { | ||
| err = &errortypes.BadInput{ | ||
| Message: err.Error(), | ||
| } | ||
| return "", 0, 0, err | ||
| } | ||
|
|
||
| var gumgumExt openrtb_ext.ExtImpGumGum | ||
| if err := json.Unmarshal(bidderExt.Bidder, &gumgumExt); err != nil { | ||
| err = &errortypes.BadInput{ | ||
| Message: err.Error(), | ||
| } | ||
| return "", 0, 0, err | ||
| } | ||
|
|
||
| zone := gumgumExt.Zone | ||
| deviceHeight := gumgumExt.DeviceHeight | ||
| deviceWidth := gumgumExt.DeviceWidth | ||
| return zone, deviceHeight, deviceWidth, nil | ||
| } | ||
|
|
||
| func NewGumGumBidder(endpoint string) *GumGumAdapter { | ||
| return &GumGumAdapter{ | ||
| URI: endpoint, | ||
| } | ||
| } | ||
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,10 @@ | ||
| package gumgum | ||
|
|
||
| import ( | ||
| "github.com/prebid/prebid-server/adapters/adapterstest" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestJsonSamples(t *testing.T) { | ||
| adapterstest.RunJSONBidderTest(t, "gumgumtest", NewGumGumBidder("https://g2.gumgum.com/providers/prbds2s/bid")) | ||
| } |
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,111 @@ | ||
| { | ||
| "mockBidRequest": { | ||
| "device": { | ||
| "h": 300, | ||
| "w": 400 | ||
| }, | ||
| "id": "test-request-id", | ||
| "imp": [ | ||
| { | ||
| "id": "test-imp-id", | ||
| "banner": { | ||
| "format": [ | ||
| { | ||
| "w": 300, | ||
| "h": 250 | ||
| }, | ||
| { | ||
| "w": 300, | ||
| "h": 300 | ||
| } | ||
| ], | ||
| "w": 300, | ||
| "h": 250 | ||
| }, | ||
| "ext": { | ||
| "bidder": { | ||
| "zone": "dc9d6be1", | ||
| "deviceHeight": 300, | ||
| "deviceWidth": 400 | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
|
|
||
| "httpCalls": [ | ||
| { | ||
| "expectedRequest": { | ||
| "uri": "https://g2.gumgum.com/providers/prbds2s/bid", | ||
| "body":{ | ||
| "device": { | ||
| "h": 300, | ||
| "w": 400 | ||
| }, | ||
| "id": "test-request-id", | ||
| "imp": [{ | ||
| "id": "test-imp-id", | ||
| "banner": { | ||
| "format": [{ | ||
| "w": 300, | ||
| "h": 250 | ||
| }, { | ||
| "w": 300, | ||
| "h": 300 | ||
| }], | ||
| "w": 300, | ||
| "h": 250 | ||
| }, | ||
| "ext": { | ||
| "bidder": { | ||
| "zone": "dc9d6be1", | ||
| "deviceHeight": 300, | ||
| "deviceWidth": 400 | ||
| } | ||
| } | ||
| }] | ||
| } | ||
| }, | ||
| "mockResponse": { | ||
| "status": 200, | ||
| "body": { | ||
| "seatbid": [ | ||
| { | ||
| "bid": [ | ||
| { | ||
| "crid": "2068416", | ||
| "adm": "some-test-ad", | ||
| "adid": "2068416", | ||
| "price": 5, | ||
| "id": "5736a50b-6b05-42a8-aa6d-b0a4649dcd05", | ||
| "impid": "test-imp-id", | ||
| "cid": "4747" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ], | ||
|
|
||
| "expectedBidResponses": [ | ||
| { | ||
| "currency": "USD", | ||
| "bids": [ | ||
| { | ||
| "bid": { | ||
| "crid": "2068416", | ||
| "adm": "some-test-ad", | ||
| "adid": "2068416", | ||
| "price": 5, | ||
| "id": "5736a50b-6b05-42a8-aa6d-b0a4649dcd05", | ||
| "impid": "test-imp-id", | ||
| "cid": "4747" | ||
| }, | ||
| "type": "banner" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
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,5 @@ | ||
| { | ||
| "zone": "dc9d6be1", | ||
| "deviceHeight": 240, | ||
| "deviceWidth": 400 | ||
| } |
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,54 @@ | ||
| package gumgum | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "github.com/prebid/prebid-server/openrtb_ext" | ||
| "testing" | ||
| ) | ||
|
|
||
| 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.BidderGumGum, json.RawMessage(validParam)); err != nil { | ||
| t.Errorf("Schema rejected gumgum 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.BidderGumGum, json.RawMessage(invalidParam)); err == nil { | ||
| t.Errorf("Schema allowed unexpected params: %s", invalidParam) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| var validParams = []string{ | ||
| `{"zone":"dc9d6be1", "deviceHeight":240, "deviceWidth":400}`, | ||
| } | ||
|
|
||
| var invalidParams = []string{ | ||
| `null`, | ||
| `nil`, | ||
| ``, | ||
| `{}`, | ||
| `[]`, | ||
| `true`, | ||
| `2`, | ||
| `{"zone":"12345678", "deviceHeight":100}`, | ||
| `{"zone":12345678}`, | ||
| `{"zone":""}`, | ||
| `{"placementId": 1}`, | ||
| `{"zone": true}`, | ||
| `{"placementId": 1, "zone":"1234567"}`, | ||
| `{"zone":"12345678", "deviceHeight":"200", "deviceWidth":"400"}`, | ||
| } |
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 gumgum | ||
|
|
||
| import ( | ||
| "github.com/prebid/prebid-server/adapters" | ||
| "github.com/prebid/prebid-server/config" | ||
| "github.com/prebid/prebid-server/openrtb_ext" | ||
| "github.com/prebid/prebid-server/usersync" | ||
|
|
||
| "net/url" | ||
| "strings" | ||
| ) | ||
|
|
||
| func NewGumGumSyncer(cfg *config.Configuration) usersync.Usersyncer { | ||
| externalURL := strings.TrimRight(cfg.ExternalURL, "/") | ||
| redirectURI := url.QueryEscape(externalURL) + "%2Fsetuid%3Fbidder%3Dgumgum%26gdpr%3D{{gdpr}}%26gdpr_consent%3D{{gdpr_consent}}%26uid%3D" | ||
| usersyncURL := cfg.Adapters[string(openrtb_ext.BidderGumGum)].UserSyncURL | ||
| return adapters.NewSyncer("gumgum", 61, adapters.ResolveMacros(usersyncURL+redirectURI), adapters.SyncTypeIframe) | ||
| } |
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,22 @@ | ||
| package gumgum | ||
|
|
||
| import ( | ||
| "github.com/prebid/prebid-server/config" | ||
| "github.com/prebid/prebid-server/openrtb_ext" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "testing" | ||
| ) | ||
|
|
||
| func TestGumGumSyncer(t *testing.T) { | ||
| syncer := NewGumGumSyncer(&config.Configuration{ExternalURL: "localhost", Adapters: map[string]config.Adapter{ | ||
| string(openrtb_ext.BidderGumGum): { | ||
| UserSyncURL: "https://rtb.gumgum.com/usync/prbds2s?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&r=", | ||
| }, | ||
| }}) | ||
| u := syncer.GetUsersyncInfo("1", "BOPVK28OVJoTBABABAENBs-AAAAhuAKAANAAoACwAGgAPAAxAB0AHgAQAAiABOADkA") | ||
| assert.Equal(t, "https://rtb.gumgum.com/usync/prbds2s?gdpr=1&gdpr_consent=BOPVK28OVJoTBABABAENBs-AAAAhuAKAANAAoACwAGgAPAAxAB0AHgAQAAiABOADkA&r=localhost%2Fsetuid%3Fbidder%3Dgumgum%26gdpr%3D1%26gdpr_consent%3DBOPVK28OVJoTBABABAENBs-AAAAhuAKAANAAoACwAGgAPAAxAB0AHgAQAAiABOADkA%26uid%3D", u.URL) | ||
| assert.Equal(t, "iframe", u.Type) | ||
| assert.Equal(t, uint16(61), syncer.GDPRVendorID()) | ||
| assert.Equal(t, false, u.SupportCORS) | ||
| } |
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
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
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.
You might want to do some checks if people are passing inconsistent values across the imps. Shouldn't happen in theory, but users can end up doing all sorts of crazy things.
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.
Is it possible for the user to send different values (unless they decide to randomly generate this value in which case none of these values would be valid on GumGum's end)? Since whatever is in the imp.ext object is hard coded when the user sets up the client for the site right?
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 is one
imp.extfor each imp, so technically it could be possible to send inconsistent values. It would be a strong indication that there is something seriously wrong with their prebid implementation to generate a mess like that. I am not going to deny this PR if there is no check, just wanted to offer it as an idea to consider.