-
Notifications
You must be signed in to change notification settings - Fork 730
/
openx.go
263 lines (224 loc) · 7.11 KB
/
openx.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
package openx
import (
"encoding/json"
"fmt"
"net/http"
"github.com/prebid/openrtb/v20/openrtb2"
"github.com/prebid/prebid-server/v2/adapters"
"github.com/prebid/prebid-server/v2/config"
"github.com/prebid/prebid-server/v2/errortypes"
"github.com/prebid/prebid-server/v2/openrtb_ext"
)
const hbconfig = "hb_pbs_1.0.0"
type OpenxAdapter struct {
bidderName string
endpoint string
}
type openxImpExt map[string]json.RawMessage
type openxReqExt struct {
DelDomain string `json:"delDomain,omitempty"`
Platform string `json:"platform,omitempty"`
BidderConfig string `json:"bc"`
}
type openxRespExt struct {
FledgeAuctionConfigs map[string]json.RawMessage `json:"fledge_auction_configs,omitempty"`
}
func (a *OpenxAdapter) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
var errs []error
var bannerImps []openrtb2.Imp
var videoImps []openrtb2.Imp
for _, imp := range request.Imp {
// OpenX doesn't allow multi-type imp. Banner takes priority over video.
if imp.Banner != nil {
bannerImps = append(bannerImps, imp)
} else if imp.Video != nil {
videoImps = append(videoImps, imp)
}
}
var adapterRequests []*adapters.RequestData
// Make a copy as we don't want to change the original request
reqCopy := *request
reqCopy.Imp = bannerImps
adapterReq, errors := a.makeRequest(&reqCopy)
if adapterReq != nil {
adapterRequests = append(adapterRequests, adapterReq)
}
errs = append(errs, errors...)
// OpenX only supports single imp video request
for _, videoImp := range videoImps {
reqCopy.Imp = []openrtb2.Imp{videoImp}
adapterReq, errors := a.makeRequest(&reqCopy)
if adapterReq != nil {
adapterRequests = append(adapterRequests, adapterReq)
}
errs = append(errs, errors...)
}
return adapterRequests, errs
}
func (a *OpenxAdapter) makeRequest(request *openrtb2.BidRequest) (*adapters.RequestData, []error) {
var errs []error
var validImps []openrtb2.Imp
reqExt := openxReqExt{BidderConfig: hbconfig}
for _, imp := range request.Imp {
if err := preprocess(&imp, &reqExt); err != nil {
errs = append(errs, err)
continue
}
validImps = append(validImps, imp)
}
// If all the imps were malformed, don't bother making a server call with no impressions.
if len(validImps) == 0 {
return nil, errs
}
request.Imp = validImps
var err error
request.Ext, err = json.Marshal(reqExt)
if err != nil {
errs = append(errs, err)
return nil, errs
}
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: a.endpoint,
Body: reqJSON,
Headers: headers,
ImpIDs: openrtb_ext.GetImpIDs(request.Imp),
}, errs
}
// Mutate the imp to get it ready to send to openx.
func preprocess(imp *openrtb2.Imp, reqExt *openxReqExt) error {
var bidderExt adapters.ExtImpBidder
if err := json.Unmarshal(imp.Ext, &bidderExt); err != nil {
return &errortypes.BadInput{
Message: err.Error(),
}
}
var openxExt openrtb_ext.ExtImpOpenx
if err := json.Unmarshal(bidderExt.Bidder, &openxExt); err != nil {
return &errortypes.BadInput{
Message: err.Error(),
}
}
reqExt.DelDomain = openxExt.DelDomain
reqExt.Platform = openxExt.Platform
imp.TagID = openxExt.Unit
if imp.BidFloor == 0 && openxExt.CustomFloor > 0 {
imp.BidFloor = openxExt.CustomFloor
}
// outgoing imp.ext should be same as incoming imp.ext minus prebid and bidder
impExt := openxImpExt{}
if err := json.Unmarshal(imp.Ext, &impExt); err != nil {
return &errortypes.BadInput{
Message: err.Error(),
}
}
delete(impExt, openrtb_ext.PrebidExtKey)
delete(impExt, openrtb_ext.PrebidExtBidderKey)
if openxExt.CustomParams != nil {
var err error
if impExt["customParams"], err = json.Marshal(openxExt.CustomParams); err != nil {
return &errortypes.BadInput{
Message: err.Error(),
}
}
}
if len(impExt) > 0 {
var err error
if imp.Ext, err = json.Marshal(impExt); err != nil {
return &errortypes.BadInput{
Message: err.Error(),
}
}
} else {
imp.Ext = nil
}
if imp.Video != nil {
videoCopy := *imp.Video
if bidderExt.Prebid != nil && bidderExt.Prebid.IsRewardedInventory != nil && *bidderExt.Prebid.IsRewardedInventory == 1 {
videoCopy.Ext = json.RawMessage(`{"rewarded":1}`)
} else {
videoCopy.Ext = nil
}
imp.Video = &videoCopy
}
return nil
}
func (a *OpenxAdapter) 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("Unexpected status code: %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 bidResp openrtb2.BidResponse
if err := json.Unmarshal(response.Body, &bidResp); err != nil {
return nil, []error{err}
}
bidResponse := adapters.NewBidderResponseWithBidsCapacity(5)
// overrride default currency
if bidResp.Cur != "" {
bidResponse.Currency = bidResp.Cur
}
if bidResp.Ext != nil {
var bidRespExt openxRespExt
if err := json.Unmarshal(bidResp.Ext, &bidRespExt); err == nil && bidRespExt.FledgeAuctionConfigs != nil {
bidResponse.FledgeAuctionConfigs = make([]*openrtb_ext.FledgeAuctionConfig, 0, len(bidRespExt.FledgeAuctionConfigs))
for impId, config := range bidRespExt.FledgeAuctionConfigs {
fledgeAuctionConfig := &openrtb_ext.FledgeAuctionConfig{
ImpId: impId,
Bidder: a.bidderName,
Config: config,
}
bidResponse.FledgeAuctionConfigs = append(bidResponse.FledgeAuctionConfigs, fledgeAuctionConfig)
}
}
}
for _, sb := range bidResp.SeatBid {
for i := range sb.Bid {
bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{
Bid: &sb.Bid[i],
BidType: getMediaTypeForImp(sb.Bid[i].ImpID, internalRequest.Imp),
})
}
}
return bidResponse, nil
}
// getMediaTypeForImp figures out which media type this bid is for.
//
// OpenX doesn't support multi-type impressions.
// If both banner and video exist, take banner as we do not want in-banner video.
func getMediaTypeForImp(impId string, imps []openrtb2.Imp) openrtb_ext.BidType {
mediaType := openrtb_ext.BidTypeBanner
for _, imp := range imps {
if imp.ID == impId {
if imp.Banner == nil && imp.Video != nil {
mediaType = openrtb_ext.BidTypeVideo
}
return mediaType
}
}
return mediaType
}
// Builder builds a new instance of the Openx 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 := &OpenxAdapter{
endpoint: config.Endpoint,
bidderName: string(bidderName),
}
return bidder, nil
}