/
adkernel.go
275 lines (247 loc) · 8.08 KB
/
adkernel.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
264
265
266
267
268
269
270
271
272
273
274
275
package adkernel
import (
"encoding/json"
"fmt"
"net/http"
"strconv"
"text/template"
"github.com/mxmCherry/openrtb/v16/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 adkernelAdapter struct {
EndpointTemplate *template.Template
}
//MakeRequests prepares request information for prebid-server core
func (adapter *adkernelAdapter) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
errs := make([]error, 0, len(request.Imp))
if len(request.Imp) == 0 {
errs = append(errs, newBadInputError("No impression in the bid request"))
return nil, errs
}
imps, impExts, err := getImpressionsInfo(request.Imp)
if len(imps) == 0 {
return nil, err
}
errs = append(errs, err...)
pub2impressions, dispErrors := dispatchImpressions(imps, impExts)
if len(dispErrors) > 0 {
errs = append(errs, dispErrors...)
}
if len(pub2impressions) == 0 {
return nil, errs
}
result := make([]*adapters.RequestData, 0, len(pub2impressions))
for k, imps := range pub2impressions {
bidRequest, err := adapter.buildAdapterRequest(request, &k, imps)
if err != nil {
errs = append(errs, err)
} else {
result = append(result, bidRequest)
}
}
return result, errs
}
// getImpressionsInfo checks each impression for validity and returns impressions copy with corresponding exts
func getImpressionsInfo(imps []openrtb2.Imp) ([]openrtb2.Imp, []openrtb_ext.ExtImpAdkernel, []error) {
impsCount := len(imps)
errors := make([]error, 0, impsCount)
resImps := make([]openrtb2.Imp, 0, impsCount)
resImpExts := make([]openrtb_ext.ExtImpAdkernel, 0, impsCount)
for _, imp := range imps {
impExt, err := getImpressionExt(&imp)
if err != nil {
errors = append(errors, err)
continue
}
if err := validateImpression(&imp, impExt); err != nil {
errors = append(errors, err)
continue
}
resImps = append(resImps, imp)
resImpExts = append(resImpExts, *impExt)
}
return resImps, resImpExts, errors
}
func validateImpression(imp *openrtb2.Imp, impExt *openrtb_ext.ExtImpAdkernel) error {
if impExt.ZoneId < 1 {
return newBadInputError(fmt.Sprintf("Invalid zoneId value: %d. Ignoring imp id=%s", impExt.ZoneId, imp.ID))
}
if imp.Video == nil && imp.Banner == nil && imp.Native == nil {
return newBadInputError(fmt.Sprintf("Invalid imp id=%s. Expected imp.banner / imp.video / imp.native", imp.ID))
}
return nil
}
//Group impressions by AdKernel-specific parameter `zoneId`
func dispatchImpressions(imps []openrtb2.Imp, impsExt []openrtb_ext.ExtImpAdkernel) (map[openrtb_ext.ExtImpAdkernel][]openrtb2.Imp, []error) {
res := make(map[openrtb_ext.ExtImpAdkernel][]openrtb2.Imp)
errors := make([]error, 0)
for idx := range imps {
imp := imps[idx]
err := compatImpression(&imp)
if err != nil {
errors = append(errors, err)
continue
}
impExt := impsExt[idx]
if res[impExt] == nil {
res[impExt] = make([]openrtb2.Imp, 0)
}
res[impExt] = append(res[impExt], imp)
}
return res, errors
}
//Alter impression info to comply with adkernel platform requirements
func compatImpression(imp *openrtb2.Imp) error {
imp.Ext = nil //do not forward ext to adkernel platform
if imp.Banner != nil {
return compatBannerImpression(imp)
}
if imp.Video != nil {
return compatVideoImpression(imp)
}
if imp.Native != nil {
return compatNativeImpression(imp)
}
return newBadInputError("Invalid impression")
}
func compatBannerImpression(imp *openrtb2.Imp) error {
imp.Audio = nil
imp.Video = nil
imp.Native = nil
return nil
}
func compatVideoImpression(imp *openrtb2.Imp) error {
imp.Banner = nil
imp.Audio = nil
imp.Native = nil
return nil
}
func compatNativeImpression(imp *openrtb2.Imp) error {
imp.Banner = nil
imp.Audio = nil
imp.Video = nil
return nil
}
func getImpressionExt(imp *openrtb2.Imp) (*openrtb_ext.ExtImpAdkernel, error) {
var bidderExt adapters.ExtImpBidder
if err := json.Unmarshal(imp.Ext, &bidderExt); err != nil {
return nil, &errortypes.BadInput{
Message: err.Error(),
}
}
var adkernelExt openrtb_ext.ExtImpAdkernel
if err := json.Unmarshal(bidderExt.Bidder, &adkernelExt); err != nil {
return nil, &errortypes.BadInput{
Message: err.Error(),
}
}
return &adkernelExt, nil
}
func (adapter *adkernelAdapter) buildAdapterRequest(prebidBidRequest *openrtb2.BidRequest, params *openrtb_ext.ExtImpAdkernel, imps []openrtb2.Imp) (*adapters.RequestData, error) {
newBidRequest := createBidRequest(prebidBidRequest, params, imps)
reqJSON, err := json.Marshal(newBidRequest)
if err != nil {
return nil, err
}
headers := http.Header{}
headers.Add("Content-Type", "application/json;charset=utf-8")
headers.Add("Accept", "application/json")
headers.Add("x-openrtb-version", "2.5")
url, err := adapter.buildEndpointURL(params)
if err != nil {
return nil, err
}
return &adapters.RequestData{
Method: "POST",
Uri: url,
Body: reqJSON,
Headers: headers}, nil
}
func createBidRequest(prebidBidRequest *openrtb2.BidRequest, params *openrtb_ext.ExtImpAdkernel, imps []openrtb2.Imp) *openrtb2.BidRequest {
bidRequest := *prebidBidRequest
bidRequest.Imp = imps
if bidRequest.Site != nil {
// Need to copy Site as Request is a shallow copy
siteCopy := *bidRequest.Site
bidRequest.Site = &siteCopy
bidRequest.Site.Publisher = nil
}
if bidRequest.App != nil {
// Need to copy App as Request is a shallow copy
appCopy := *bidRequest.App
bidRequest.App = &appCopy
bidRequest.App.Publisher = nil
}
return &bidRequest
}
// Builds endpoint url based on adapter-specific pub settings from imp.ext
func (adapter *adkernelAdapter) buildEndpointURL(params *openrtb_ext.ExtImpAdkernel) (string, error) {
endpointParams := macros.EndpointTemplateParams{ZoneID: strconv.Itoa(params.ZoneId)}
return macros.ResolveMacros(adapter.EndpointTemplate, endpointParams)
}
//MakeBids translates adkernel bid response to prebid-server specific format
func (adapter *adkernelAdapter) 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.StatusOK {
return nil, []error{
newBadServerResponseError(fmt.Sprintf("Unexpected http status code: %d", response.StatusCode)),
}
}
var bidResp openrtb2.BidResponse
if err := json.Unmarshal(response.Body, &bidResp); err != nil {
return nil, []error{
newBadServerResponseError(fmt.Sprintf("Bad server response: %d", err)),
}
}
if len(bidResp.SeatBid) != 1 {
return nil, []error{
newBadServerResponseError(fmt.Sprintf("Invalid SeatBids count: %d", len(bidResp.SeatBid))),
}
}
seatBid := bidResp.SeatBid[0]
bidResponse := adapters.NewBidderResponseWithBidsCapacity(len(bidResp.SeatBid[0].Bid))
for i := 0; i < len(seatBid.Bid); i++ {
bid := seatBid.Bid[i]
bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{
Bid: &bid,
BidType: getMediaTypeForImpID(bid.ImpID, internalRequest.Imp),
})
}
return bidResponse, nil
}
// getMediaTypeForImp figures out which media type this bid is for
func getMediaTypeForImpID(impID string, imps []openrtb2.Imp) openrtb_ext.BidType {
for _, imp := range imps {
if imp.ID == impID && imp.Banner != nil {
return openrtb_ext.BidTypeBanner
}
}
return openrtb_ext.BidTypeVideo
}
func newBadInputError(message string) error {
return &errortypes.BadInput{
Message: message,
}
}
func newBadServerResponseError(message string) error {
return &errortypes.BadServerResponse{
Message: message,
}
}
// Builder builds a new instance of the Adkernel adapter for the given bidder with the given config.
func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error) {
urlTemplate, err := template.New("endpointTemplate").Parse(config.Endpoint)
if err != nil {
return nil, fmt.Errorf("unable to parse endpoint url template: %v", err)
}
bidder := &adkernelAdapter{
EndpointTemplate: urlTemplate,
}
return bidder, nil
}