-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
riseBidAdapter.js
494 lines (434 loc) · 13.7 KB
/
riseBidAdapter.js
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
import {
logWarn,
logInfo,
isArray,
isFn,
deepAccess,
isEmpty,
contains,
timestamp,
triggerPixel,
isInteger,
getBidIdParameter
} from '../src/utils.js';
import {registerBidder} from '../src/adapters/bidderFactory.js';
import {BANNER, VIDEO} from '../src/mediaTypes.js';
import {config} from '../src/config.js';
const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
const BIDDER_CODE = 'rise';
const ADAPTER_VERSION = '6.0.0';
const TTL = 360;
const DEFAULT_CURRENCY = 'USD';
const DEFAULT_GVLID = 1043;
const DEFAULT_SELLER_ENDPOINT = 'https://hb.yellowblue.io/';
const MODES = {
PRODUCTION: 'hb-multi',
TEST: 'hb-multi-test'
}
const SUPPORTED_SYNC_METHODS = {
IFRAME: 'iframe',
PIXEL: 'pixel'
}
export const spec = {
code: BIDDER_CODE,
aliases: [
{ code: 'risexchange', gvlid: DEFAULT_GVLID },
{ code: 'openwebxchange', gvlid: 280 }
],
gvlid: DEFAULT_GVLID,
version: ADAPTER_VERSION,
supportedMediaTypes: SUPPORTED_AD_TYPES,
isBidRequestValid: function (bidRequest) {
if (!bidRequest.params) {
logWarn('no params have been set to Rise adapter');
return false;
}
if (!bidRequest.params.org) {
logWarn('org is a mandatory param for Rise adapter');
return false;
}
return true;
},
buildRequests: function (validBidRequests, bidderRequest) {
const combinedRequestsObject = {};
// use data from the first bid, to create the general params for all bids
const generalObject = validBidRequests[0];
const testMode = generalObject.params.testMode;
const rtbDomain = generalObject.params.rtbDomain;
combinedRequestsObject.params = generateGeneralParams(generalObject, bidderRequest);
combinedRequestsObject.bids = generateBidsParams(validBidRequests, bidderRequest);
return {
method: 'POST',
url: getEndpoint(testMode, rtbDomain),
data: combinedRequestsObject
}
},
interpretResponse: function ({body}) {
const bidResponses = [];
if (body.bids) {
body.bids.forEach(adUnit => {
const bidResponse = {
requestId: adUnit.requestId,
cpm: adUnit.cpm,
currency: adUnit.currency || DEFAULT_CURRENCY,
width: adUnit.width,
height: adUnit.height,
ttl: adUnit.ttl || TTL,
creativeId: adUnit.creativeId,
netRevenue: adUnit.netRevenue || true,
nurl: adUnit.nurl,
mediaType: adUnit.mediaType,
meta: {
mediaType: adUnit.mediaType
}
};
if (adUnit.mediaType === VIDEO) {
bidResponse.vastXml = adUnit.vastXml;
} else if (adUnit.mediaType === BANNER) {
bidResponse.ad = adUnit.ad;
}
if (adUnit.adomain && adUnit.adomain.length) {
bidResponse.meta.advertiserDomains = adUnit.adomain;
}
bidResponses.push(bidResponse);
});
}
return bidResponses;
},
getUserSyncs: function (syncOptions, serverResponses) {
const syncs = [];
for (const response of serverResponses) {
if (syncOptions.iframeEnabled && response.body.params.userSyncURL) {
syncs.push({
type: 'iframe',
url: response.body.params.userSyncURL
});
}
if (syncOptions.pixelEnabled && isArray(response.body.params.userSyncPixels)) {
const pixels = response.body.params.userSyncPixels.map(pixel => {
return {
type: 'image',
url: pixel
}
})
syncs.push(...pixels)
}
}
return syncs;
},
onBidWon: function (bid) {
if (bid == null) {
return;
}
logInfo('onBidWon:', bid);
if (bid.hasOwnProperty('nurl') && bid.nurl.length > 0) {
triggerPixel(bid.nurl);
}
}
};
registerBidder(spec);
/**
* Get floor price
* @param bid {bid}
* @param mediaType {string}
* @returns {Number}
*/
function getFloor(bid, mediaType) {
if (!isFn(bid.getFloor)) {
return 0;
}
let floorResult = bid.getFloor({
currency: DEFAULT_CURRENCY,
mediaType: mediaType,
size: '*'
});
return floorResult.currency === DEFAULT_CURRENCY && floorResult.floor ? floorResult.floor : 0;
}
/**
* Get the the ad sizes array from the bid
* @param bid {bid}
* @returns {Array}
*/
function getSizesArray(bid, mediaType) {
let sizesArray = []
if (deepAccess(bid, `mediaTypes.${mediaType}.sizes`)) {
sizesArray = bid.mediaTypes[mediaType].sizes;
} else if (Array.isArray(bid.sizes) && bid.sizes.length > 0) {
sizesArray = bid.sizes;
}
return sizesArray;
}
/**
* Get schain string value
* @param schainObject {Object}
* @returns {string}
*/
function getSupplyChain(schainObject) {
if (isEmpty(schainObject)) {
return '';
}
let scStr = `${schainObject.ver},${schainObject.complete}`;
schainObject.nodes.forEach((node) => {
scStr += '!';
scStr += `${getEncodedValIfNotEmpty(node.asi)},`;
scStr += `${getEncodedValIfNotEmpty(node.sid)},`;
scStr += `${node.hp ? encodeURIComponent(node.hp) : ''},`;
scStr += `${getEncodedValIfNotEmpty(node.rid)},`;
scStr += `${getEncodedValIfNotEmpty(node.name)},`;
scStr += `${getEncodedValIfNotEmpty(node.domain)}`;
});
return scStr;
}
/**
* Get encoded node value
* @param val {string}
* @returns {string}
*/
function getEncodedValIfNotEmpty(val) {
return !isEmpty(val) ? encodeURIComponent(val) : '';
}
/**
* Get preferred user-sync method based on publisher configuration
* @param bidderCode {string}
* @returns {string}
*/
function getAllowedSyncMethod(filterSettings, bidderCode) {
const iframeConfigsToCheck = ['all', 'iframe'];
const pixelConfigToCheck = 'image';
if (filterSettings && iframeConfigsToCheck.some(config => isSyncMethodAllowed(filterSettings[config], bidderCode))) {
return SUPPORTED_SYNC_METHODS.IFRAME;
}
if (!filterSettings || !filterSettings[pixelConfigToCheck] || isSyncMethodAllowed(filterSettings[pixelConfigToCheck], bidderCode)) {
return SUPPORTED_SYNC_METHODS.PIXEL;
}
}
/**
* Check if sync rule is supported
* @param syncRule {Object}
* @param bidderCode {string}
* @returns {boolean}
*/
function isSyncMethodAllowed(syncRule, bidderCode) {
if (!syncRule) {
return false;
}
const isInclude = syncRule.filter === 'include';
const bidders = isArray(syncRule.bidders) ? syncRule.bidders : [bidderCode];
return isInclude && contains(bidders, bidderCode);
}
/**
* Get the seller endpoint
* @param testMode {boolean}
* @param rtbDomain {string}
* @returns {string}
*/
function getEndpoint(testMode, rtbDomain) {
const SELLER_ENDPOINT = rtbDomain ? `https://${rtbDomain}/` : DEFAULT_SELLER_ENDPOINT;
return testMode
? SELLER_ENDPOINT + MODES.TEST
: SELLER_ENDPOINT + MODES.PRODUCTION;
}
/**
* get device type
* @param uad {ua}
* @returns {string}
*/
function getDeviceType(ua) {
if (/ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle/i
.test(ua.toLowerCase())) {
return '5';
}
if (/iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i
.test(ua.toLowerCase())) {
return '4';
}
if (/smart[-_\s]?tv|hbbtv|appletv|googletv|hdmi|netcast|viera|nettv|roku|\bdtv\b|sonydtv|inettvbrowser|\btv\b/i
.test(ua.toLowerCase())) {
return '3';
}
return '1';
}
function generateBidsParams(validBidRequests, bidderRequest) {
const bidsArray = [];
if (validBidRequests.length) {
validBidRequests.forEach(bid => {
bidsArray.push(generateBidParameters(bid, bidderRequest));
});
}
return bidsArray;
}
/**
* Generate bid specific parameters
* @param {bid} bid
* @param {bidderRequest} bidderRequest
* @returns {Object} bid specific params object
*/
function generateBidParameters(bid, bidderRequest) {
const {params} = bid;
const mediaType = isBanner(bid) ? BANNER : VIDEO;
const sizesArray = getSizesArray(bid, mediaType);
// fix floor price in case of NAN
if (isNaN(params.floorPrice)) {
params.floorPrice = 0;
}
const bidObject = {
mediaType,
adUnitCode: getBidIdParameter('adUnitCode', bid),
sizes: sizesArray,
floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
bidId: getBidIdParameter('bidId', bid),
bidderRequestId: getBidIdParameter('bidderRequestId', bid),
loop: getBidIdParameter('bidderRequestsCount', bid),
transactionId: bid.ortb2Imp?.ext?.tid,
coppa: 0,
};
const pos = deepAccess(bid, `mediaTypes.${mediaType}.pos`);
if (pos) {
bidObject.pos = pos;
}
const gpid = deepAccess(bid, `ortb2Imp.ext.gpid`);
if (gpid) {
bidObject.gpid = gpid;
}
const placementId = params.placementId || deepAccess(bid, `mediaTypes.${mediaType}.name`);
if (placementId) {
bidObject.placementId = placementId;
}
const mimes = deepAccess(bid, `mediaTypes.${mediaType}.mimes`);
if (mimes) {
bidObject.mimes = mimes;
}
const api = deepAccess(bid, `mediaTypes.${mediaType}.api`);
if (api) {
bidObject.api = api;
}
const sua = deepAccess(bid, `ortb2.device.sua`);
if (sua) {
bidObject.sua = sua;
}
const coppa = deepAccess(bid, `ortb2.regs.coppa`)
if (coppa) {
bidObject.coppa = 1;
}
if (mediaType === VIDEO) {
const playbackMethod = deepAccess(bid, `mediaTypes.video.playbackmethod`);
let playbackMethodValue;
// verify playbackMethod is of type integer array, or integer only.
if (Array.isArray(playbackMethod) && isInteger(playbackMethod[0])) {
// only the first playbackMethod in the array will be used, according to OpenRTB 2.5 recommendation
playbackMethodValue = playbackMethod[0];
} else if (isInteger(playbackMethod)) {
playbackMethodValue = playbackMethod;
}
if (playbackMethodValue) {
bidObject.playbackMethod = playbackMethodValue;
}
const placement = deepAccess(bid, `mediaTypes.video.placement`);
if (placement) {
bidObject.placement = placement;
}
const minDuration = deepAccess(bid, `mediaTypes.video.minduration`);
if (minDuration) {
bidObject.minDuration = minDuration;
}
const maxDuration = deepAccess(bid, `mediaTypes.video.maxduration`);
if (maxDuration) {
bidObject.maxDuration = maxDuration;
}
const skip = deepAccess(bid, `mediaTypes.video.skip`);
if (skip) {
bidObject.skip = skip;
}
const linearity = deepAccess(bid, `mediaTypes.video.linearity`);
if (linearity) {
bidObject.linearity = linearity;
}
const protocols = deepAccess(bid, `mediaTypes.video.protocols`);
if (protocols) {
bidObject.protocols = protocols;
}
const plcmt = deepAccess(bid, `mediaTypes.video.plcmt`);
if (plcmt) {
bidObject.plcmt = plcmt;
}
}
return bidObject;
}
function isBanner(bid) {
return bid.mediaTypes && bid.mediaTypes.banner;
}
/**
* Generate params that are common between all bids
* @param {single bid object} generalObject
* @param {bidderRequest} bidderRequest
* @returns {object} the common params object
*/
function generateGeneralParams(generalObject, bidderRequest) {
const domain = window.location.hostname;
const {syncEnabled, filterSettings} = config.getConfig('userSync') || {};
const {bidderCode} = bidderRequest;
const generalBidParams = generalObject.params;
const timeout = bidderRequest.timeout;
// these params are snake_case instead of camelCase to allow backwards compatability on the server.
// in the future, these will be converted to camelCase to match our convention.
const generalParams = {
wrapper_type: 'prebidjs',
wrapper_vendor: '$$PREBID_GLOBAL$$',
wrapper_version: '$prebid.version$',
adapter_version: ADAPTER_VERSION,
auction_start: timestamp(),
publisher_id: generalBidParams.org,
publisher_name: domain,
site_domain: domain,
dnt: (navigator.doNotTrack == 'yes' || navigator.doNotTrack == '1' || navigator.msDoNotTrack == '1') ? 1 : 0,
device_type: getDeviceType(navigator.userAgent),
ua: navigator.userAgent,
is_wrapper: !!generalBidParams.isWrapper,
session_id: generalBidParams.sessionId || getBidIdParameter('bidderRequestId', generalObject),
tmax: timeout
};
const userIdsParam = getBidIdParameter('userId', generalObject);
if (userIdsParam) {
generalParams.userIds = JSON.stringify(userIdsParam);
}
const ortb2Metadata = bidderRequest.ortb2 || {};
if (ortb2Metadata.site) {
generalParams.site_metadata = JSON.stringify(ortb2Metadata.site);
}
if (ortb2Metadata.user) {
generalParams.user_metadata = JSON.stringify(ortb2Metadata.user);
}
if (syncEnabled) {
const allowedSyncMethod = getAllowedSyncMethod(filterSettings, bidderCode);
if (allowedSyncMethod) {
generalParams.cs_method = allowedSyncMethod;
}
}
if (bidderRequest.uspConsent) {
generalParams.us_privacy = bidderRequest.uspConsent;
}
if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
generalParams.gdpr = bidderRequest.gdprConsent.gdprApplies;
generalParams.gdpr_consent = bidderRequest.gdprConsent.consentString;
}
if (bidderRequest && bidderRequest.gppConsent) {
generalParams.gpp = bidderRequest.gppConsent.gppString;
generalParams.gpp_sid = bidderRequest.gppConsent.applicableSections;
} else if (bidderRequest.ortb2?.regs?.gpp) {
generalParams.gpp = bidderRequest.ortb2.regs.gpp;
generalParams.gpp_sid = bidderRequest.ortb2.regs.gpp_sid;
}
if (generalBidParams.ifa) {
generalParams.ifa = generalBidParams.ifa;
}
if (generalObject.schain) {
generalParams.schain = getSupplyChain(generalObject.schain);
}
if (bidderRequest && bidderRequest.refererInfo) {
// TODO: is 'ref' the right value here?
generalParams.referrer = deepAccess(bidderRequest, 'refererInfo.ref');
// TODO: does the fallback make sense here?
generalParams.page_url = deepAccess(bidderRequest, 'refererInfo.page') || deepAccess(window, 'location.href');
}
return generalParams;
}