Skip to content

Commit

Permalink
New Adapter: Axis (#2655)
Browse files Browse the repository at this point in the history 
Co-authored-by: Maksym Pavliv <makspavliv@MacBook-Air-Maksym.local>
  • Loading branch information
@PyjamaWarrior
PyjamaWarrior and Maksym Pavliv committed Apr 24, 2023
1 parent eb338b6 commit d210e3e
Show file tree
Hide file tree
Showing 16 changed files with 1,140 additions and 0 deletions.
162 changes: 162 additions & 0 deletions adapters/axis/axis.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
package axis

import (
"encoding/json"
"fmt"
"net/http"
"text/template"

"github.com/prebid/openrtb/v17/openrtb2"
"github.com/prebid/prebid-server/adapters"
"github.com/prebid/prebid-server/config"
"github.com/prebid/prebid-server/errortypes"
"github.com/prebid/prebid-server/macros"
"github.com/prebid/prebid-server/openrtb_ext"
)

type adapter struct {
endpoint *template.Template
}

type reqBodyExt struct {
AxisBidderExt openrtb_ext.ImpExtAxis `json:"bidder"`
}

func Builder(bidderName openrtb_ext.BidderName, config config.Adapter, server config.Server) (adapters.Bidder, error) {
template, err := template.New("endpointTemplate").Parse(config.Endpoint)
if err != nil {
return nil, fmt.Errorf("unable to parse endpoint url template: %v", err)
}

bidder := &adapter{
endpoint: template,
}

return bidder, nil
}

func (a *adapter) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
var adapterRequests []*adapters.RequestData

originalImpSlice := request.Imp

for i := range request.Imp {
currImp := originalImpSlice[i]
request.Imp = []openrtb2.Imp{currImp}

var bidderExt reqBodyExt
if err := json.Unmarshal(currImp.Ext, &bidderExt); err != nil {
continue
}

url, err := a.buildEndpointURL(&bidderExt)
if err != nil {
return nil, []error{err}
}

extJson, err := json.Marshal(bidderExt)
if err != nil {
return nil, []error{err}
}

request.Imp[0].Ext = extJson

adapterReq, err := buildRequest(request, url)
if err != nil {
return nil, []error{err}
}

if adapterReq != nil {
adapterRequests = append(adapterRequests, adapterReq)
}
}
request.Imp = originalImpSlice
return adapterRequests, nil
}

func (a *adapter) buildEndpointURL(bidderExt *reqBodyExt) (string, error) {
endpointParams := macros.EndpointTemplateParams{
AccountID: bidderExt.AxisBidderExt.Integration,
SourceId: bidderExt.AxisBidderExt.Token,
}

return macros.ResolveMacros(a.endpoint, endpointParams)
}

func buildRequest(request *openrtb2.BidRequest, url string) (*adapters.RequestData, error) {
reqJSON, err := json.Marshal(request)
if err != nil {
return nil, err
}

headers := http.Header{}
headers.Add("Content-Type", "application/json;charset=utf-8")
headers.Add("Accept", "application/json")

return &adapters.RequestData{
Method: "POST",
Uri: url,
Body: reqJSON,
Headers: headers,
}, nil
}

func (a *adapter) MakeBids(request *openrtb2.BidRequest, requestData *adapters.RequestData, responseData *adapters.ResponseData) (*adapters.BidderResponse, []error) {
if responseData.StatusCode == http.StatusNoContent {
return nil, nil
}

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 := json.Unmarshal(responseData.Body, &response); err != nil {
return nil, []error{err}
}

bidResponse := adapters.NewBidderResponseWithBidsCapacity(len(request.Imp))
bidResponse.Currency = response.Cur

impsMappedByID := make(map[string]openrtb2.Imp, len(request.Imp))
for i, imp := range request.Imp {
impsMappedByID[request.Imp[i].ID] = imp
}

for _, seatBid := range response.SeatBid {
for i := range seatBid.Bid {
bidType, err := getMediaTypeForImp(seatBid.Bid[i].ImpID, impsMappedByID)
if err != nil {
return nil, []error{err}
}

b := &adapters.TypedBid{
Bid: &seatBid.Bid[i],
BidType: bidType,
}
bidResponse.Bids = append(bidResponse.Bids, b)
}
}
return bidResponse, nil
}

func getMediaTypeForImp(impID string, impMap map[string]openrtb2.Imp) (openrtb_ext.BidType, error) {
if index, found := impMap[impID]; found {
if index.Banner != nil {
return openrtb_ext.BidTypeBanner, nil
}
if index.Video != nil {
return openrtb_ext.BidTypeVideo, nil
}
if index.Native != nil {
return openrtb_ext.BidTypeNative, nil
}
}

return "", &errortypes.BadInput{
Message: fmt.Sprintf("Failed to find impression \"%s\"", impID),
}
}
20 changes: 20 additions & 0 deletions adapters/axis/axis_test.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package axis

import (
"testing"

"github.com/prebid/prebid-server/adapters/adapterstest"
"github.com/prebid/prebid-server/config"
"github.com/prebid/prebid-server/openrtb_ext"
)

func TestJsonSamples(t *testing.T) {
bidder, buildErr := Builder(openrtb_ext.BidderAxis, config.Adapter{
Endpoint: "http://prebid.axis-marketplace.com/{{.AccountID}}?token={{.SourceId}}"}, config.Server{ExternalUrl: "http://hosturl.com", GvlID: 1, DataCenter: "2"})

if buildErr != nil {
t.Fatalf("Builder returned unexpected error %v", buildErr)
}

adapterstest.RunJSONBidderTest(t, "axistest", bidder)
}
134 changes: 134 additions & 0 deletions adapters/axis/axistest/exemplary/simple-banner.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
{
"mockBidRequest": {
"id": "test-request-id",
"device": {
"ip": "123.123.123.123",
"ua": "iPad"
},
"app": {
"id": "1",
"bundle": "com.test.testapplication"
},
"imp": [
{
"id": "test-imp-id",
"tagid": "test",
"banner": {
"format": [
{
"w": 300,
"h": 250
},
{
"w": 300,
"h": 600
}
]
},
"ext": {
"bidder": {
"integration": "000000",
"token": "000000"
}
}
}
]
},
"httpCalls": [
{
"expectedRequest": {
"uri": "http://prebid.axis-marketplace.com/000000?token=000000",
"body": {
"id": "test-request-id",
"imp": [
{
"id": "test-imp-id",
"tagid": "test",
"banner": {
"format": [
{
"w": 300,
"h": 250
},
{
"w": 300,
"h": 600
}
]
},
"ext": {
"bidder": {
"integration": "000000",
"token": "000000"
}
}
}
],
"app": {
"id": "1",
"bundle": "com.test.testapplication"
},
"device": {
"ip": "123.123.123.123",
"ua": "iPad"
}
}
},
"mockResponse": {
"status": 200,
"body": {
"id": "test-request-id",
"seatbid": [
{
"bid": [
{
"id": "test_bid_id",
"impid": "test-imp-id",
"price": 0.27543,
"adm": "<span>Test</span>",
"cid": "test_cid",
"crid": "test_crid",
"dealid": "test_dealid",
"w": 300,
"h": 250,
"ext": {
"prebid": {
"type": "banner"
}
}
}
],
"seat": "seat"
}
],
"cur": "USD"
}
}
}
],
"expectedBidResponses": [
{
"bids": [
{
"bid": {
"id": "test_bid_id",
"impid": "test-imp-id",
"price": 0.27543,
"adm": "<span>Test</span>",
"cid": "test_cid",
"crid": "test_crid",
"dealid": "test_dealid",
"w": 300,
"h": 250,
"ext": {
"prebid": {
"type": "banner"
}
}
},
"type": "banner"
}
]
}
]
}
Loading

0 comments on commit d210e3e

Please sign in to comment.