/
auction.js
976 lines (858 loc) · 33.6 KB
/
auction.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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
/**
* Module for auction instances.
*
* In Prebid 0.x, $$PREBID_GLOBAL$$ had _bidsRequested and _bidsReceived as public properties.
* Starting 1.0, Prebid will support concurrent auctions. Each auction instance will store private properties, bidsRequested and bidsReceived.
*
* AuctionManager will create an instance of auction and will store all the auctions.
*
*/
/**
* @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
* @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
* @typedef {import('../src/config.js').MediaTypePriceGranularity} MediaTypePriceGranularity
* @typedef {import('../src/mediaTypes.js').MediaType} MediaType
*/
/**
* @typedef {Object} AdUnit An object containing the adUnit configuration.
*
* @property {string} code A code which will be used to uniquely identify this bidder. This should be the same
* one as is used in the call to registerBidAdapter
* @property {Array.<size>} sizes A list of size for adUnit.
* @property {object} params Any bidder-specific params which the publisher used in their bid request.
* This is guaranteed to have passed the spec.areParamsValid() test.
*/
/**
* @typedef {Array.<number>} size
*/
/**
* @typedef {Array.<string>} AdUnitCode
*/
/**
* @typedef {Object} BidderRequest
*
* @property {string} bidderCode - adUnit bidder
* @property {number} auctionId - random UUID
* @property {string} bidderRequestId - random string, unique key set on all bidRequest.bids[]
* @property {Array.<Bid>} bids
* @property {number} auctionStart - Date.now() at auction start
* @property {number} timeout - callback timeout
* @property {refererInfo} refererInfo - referer info object
* @property {string} [tid] - random UUID (used for s2s)
* @property {string} [src] - s2s or client (used for s2s)
* @property {import('./types/ortb2.js').Ortb2.BidRequest} [ortb2] Global (not specific to any adUnit) first party data to use for all requests in this auction.
*/
/**
* @typedef {Object} BidReceived
* //TODO add all properties
*/
/**
* @typedef {Object} Auction
*
* @property {function(): string} getAuctionStatus - returns the auction status which can be any one of 'started', 'in progress' or 'completed'
* @property {function(): AdUnit[]} getAdUnits - return the adUnits for this auction instance
* @property {function(): AdUnitCode[]} getAdUnitCodes - return the adUnitCodes for this auction instance
* @property {function(): BidRequest[]} getBidRequests - get all bid requests for this auction instance
* @property {function(): BidReceived[]} getBidsReceived - get all bid received for this auction instance
* @property {function(): void} startAuctionTimer - sets the bidsBackHandler callback and starts the timer for auction
* @property {function(): void} callBids - sends requests to all adapters for bids
*/
import {
callBurl,
deepAccess,
generateUUID,
getValue,
isEmpty,
isEmptyStr,
isFn,
logError,
logInfo,
logMessage,
logWarn,
parseUrl,
timestamp
} from './utils.js';
import {getPriceBucketString} from './cpmBucketManager.js';
import {getNativeTargeting, isNativeResponse, setNativeResponseProperties} from './native.js';
import {getCacheUrl, store} from './videoCache.js';
import {Renderer} from './Renderer.js';
import {config} from './config.js';
import {userSync} from './userSync.js';
import {hook} from './hook.js';
import {find, includes} from './polyfill.js';
import {OUTSTREAM} from './video.js';
import {VIDEO} from './mediaTypes.js';
import {auctionManager} from './auctionManager.js';
import {bidderSettings} from './bidderSettings.js';
import * as events from './events.js';
import adapterManager from './adapterManager.js';
import { EVENTS, GRANULARITY_OPTIONS, JSON_MAPPING, S2S, TARGETING_KEYS } from './constants.js';
import {defer, GreedyPromise} from './utils/promise.js';
import {useMetrics} from './utils/perfMetrics.js';
import {adjustCpm} from './utils/cpm.js';
import {getGlobal} from './prebidGlobal.js';
const { syncUsers } = userSync;
export const AUCTION_STARTED = 'started';
export const AUCTION_IN_PROGRESS = 'inProgress';
export const AUCTION_COMPLETED = 'completed';
// register event for bid adjustment
events.on(EVENTS.BID_ADJUSTMENT, function (bid) {
adjustBids(bid);
});
const MAX_REQUESTS_PER_ORIGIN = 4;
const outstandingRequests = {};
const sourceInfo = {};
const queuedCalls = [];
const pbjsInstance = getGlobal();
/**
* Clear global state for tests
*/
export function resetAuctionState() {
queuedCalls.length = 0;
[outstandingRequests, sourceInfo].forEach((ob) => Object.keys(ob).forEach((k) => { delete ob[k] }));
}
/**
* Creates new auction instance
*
* @param {Object} requestConfig
* @param {AdUnit} requestConfig.adUnits
* @param {AdUnitCode} requestConfig.adUnitCodes
* @param {function():void} requestConfig.callback
* @param {number} requestConfig.cbTimeout
* @param {Array.<string>} requestConfig.labels
* @param {string} requestConfig.auctionId
* @param {{global: {}, bidder: {}}} requestConfig.ortb2Fragments first party data, separated into global
* (from getConfig('ortb2') + requestBids({ortb2})) and bidder (a map from bidderCode to ortb2)
* @param {Object} requestConfig.metrics
* @returns {Auction} auction instance
*/
export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels, auctionId, ortb2Fragments, metrics}) {
metrics = useMetrics(metrics);
const _adUnits = adUnits;
const _labels = labels;
const _adUnitCodes = adUnitCodes;
const _auctionId = auctionId || generateUUID();
const _timeout = cbTimeout;
const _timelyRequests = new Set();
const done = defer();
let _bidsRejected = [];
let _callback = callback;
let _bidderRequests = [];
let _bidsReceived = [];
let _noBids = [];
let _winningBids = [];
let _auctionStart;
let _auctionEnd;
let _timeoutTimer;
let _auctionStatus;
let _nonBids = [];
function addBidRequests(bidderRequests) { _bidderRequests = _bidderRequests.concat(bidderRequests); }
function addBidReceived(bidsReceived) { _bidsReceived = _bidsReceived.concat(bidsReceived); }
function addBidRejected(bidsRejected) { _bidsRejected = _bidsRejected.concat(bidsRejected); }
function addNoBid(noBid) { _noBids = _noBids.concat(noBid); }
function addNonBids(seatnonbids) { _nonBids = _nonBids.concat(seatnonbids); }
function getProperties() {
return {
auctionId: _auctionId,
timestamp: _auctionStart,
auctionEnd: _auctionEnd,
auctionStatus: _auctionStatus,
adUnits: _adUnits,
adUnitCodes: _adUnitCodes,
labels: _labels,
bidderRequests: _bidderRequests,
noBids: _noBids,
bidsReceived: _bidsReceived,
bidsRejected: _bidsRejected,
winningBids: _winningBids,
timeout: _timeout,
metrics: metrics,
seatNonBids: _nonBids
};
}
function startAuctionTimer() {
_timeoutTimer = setTimeout(() => executeCallback(true), _timeout);
}
function executeCallback(timedOut) {
if (!timedOut) {
clearTimeout(_timeoutTimer);
} else {
events.emit(EVENTS.AUCTION_TIMEOUT, getProperties());
}
if (_auctionEnd === undefined) {
let timedOutRequests = [];
if (timedOut) {
logMessage(`Auction ${_auctionId} timedOut`);
timedOutRequests = _bidderRequests.filter(rq => !_timelyRequests.has(rq.bidderRequestId)).flatMap(br => br.bids)
if (timedOutRequests.length) {
events.emit(EVENTS.BID_TIMEOUT, timedOutRequests);
}
}
_auctionStatus = AUCTION_COMPLETED;
_auctionEnd = Date.now();
metrics.checkpoint('auctionEnd');
metrics.timeBetween('requestBids', 'auctionEnd', 'requestBids.total');
metrics.timeBetween('callBids', 'auctionEnd', 'requestBids.callBids');
done.resolve();
events.emit(EVENTS.AUCTION_END, getProperties());
bidsBackCallback(_adUnits, function () {
try {
if (_callback != null) {
const bids = _bidsReceived
.filter(bid => _adUnitCodes.includes(bid.adUnitCode))
.reduce(groupByPlacement, {});
_callback.apply(pbjsInstance, [bids, timedOut, _auctionId]);
_callback = null;
}
} catch (e) {
logError('Error executing bidsBackHandler', null, e);
} finally {
// Calling timed out bidders
if (timedOutRequests.length) {
adapterManager.callTimedOutBidders(adUnits, timedOutRequests, _timeout);
}
// Only automatically sync if the publisher has not chosen to "enableOverride"
let userSyncConfig = config.getConfig('userSync') || {};
if (!userSyncConfig.enableOverride) {
// Delay the auto sync by the config delay
syncUsers(userSyncConfig.syncDelay);
}
}
})
}
}
function auctionDone() {
config.resetBidder();
// when all bidders have called done callback atleast once it means auction is complete
logInfo(`Bids Received for Auction with id: ${_auctionId}`, _bidsReceived);
_auctionStatus = AUCTION_COMPLETED;
executeCallback(false);
}
function onTimelyResponse(bidderRequestId) {
_timelyRequests.add(bidderRequestId);
}
function callBids() {
_auctionStatus = AUCTION_STARTED;
_auctionStart = Date.now();
let bidRequests = metrics.measureTime('requestBids.makeRequests',
() => adapterManager.makeBidRequests(_adUnits, _auctionStart, _auctionId, _timeout, _labels, ortb2Fragments, metrics));
logInfo(`Bids Requested for Auction with id: ${_auctionId}`, bidRequests);
metrics.checkpoint('callBids')
if (bidRequests.length < 1) {
logWarn('No valid bid requests returned for auction');
auctionDone();
} else {
addBidderRequests.call({
dispatch: addBidderRequestsCallback,
context: this
}, bidRequests);
}
}
/**
* callback executed after addBidderRequests completes
* @param {BidRequest[]} bidRequests
*/
function addBidderRequestsCallback(bidRequests) {
bidRequests.forEach(bidRequest => {
addBidRequests(bidRequest);
});
let requests = {};
let call = {
bidRequests,
run: () => {
startAuctionTimer();
_auctionStatus = AUCTION_IN_PROGRESS;
events.emit(EVENTS.AUCTION_INIT, getProperties());
let callbacks = auctionCallbacks(auctionDone, this);
adapterManager.callBids(_adUnits, bidRequests, callbacks.addBidResponse, callbacks.adapterDone, {
request(source, origin) {
increment(outstandingRequests, origin);
increment(requests, source);
if (!sourceInfo[source]) {
sourceInfo[source] = {
SRA: true,
origin
};
}
if (requests[source] > 1) {
sourceInfo[source].SRA = false;
}
},
done(origin) {
outstandingRequests[origin]--;
if (queuedCalls[0]) {
if (runIfOriginHasCapacity(queuedCalls[0])) {
queuedCalls.shift();
}
}
}
}, _timeout, onTimelyResponse, ortb2Fragments);
}
};
if (!runIfOriginHasCapacity(call)) {
logWarn('queueing auction due to limited endpoint capacity');
queuedCalls.push(call);
}
function runIfOriginHasCapacity(call) {
let hasCapacity = true;
let maxRequests = config.getConfig('maxRequestsPerOrigin') || MAX_REQUESTS_PER_ORIGIN;
call.bidRequests.some(bidRequest => {
let requests = 1;
let source = (typeof bidRequest.src !== 'undefined' && bidRequest.src === S2S.SRC) ? 's2s'
: bidRequest.bidderCode;
// if we have no previous info on this source just let them through
if (sourceInfo[source]) {
if (sourceInfo[source].SRA === false) {
// some bidders might use more than the MAX_REQUESTS_PER_ORIGIN in a single auction. In those cases
// set their request count to MAX_REQUESTS_PER_ORIGIN so the auction isn't permanently queued waiting
// for capacity for that bidder
requests = Math.min(bidRequest.bids.length, maxRequests);
}
if (outstandingRequests[sourceInfo[source].origin] + requests > maxRequests) {
hasCapacity = false;
}
}
// return only used for terminating this .some() iteration early if it is determined we don't have capacity
return !hasCapacity;
});
if (hasCapacity) {
call.run();
}
return hasCapacity;
}
function increment(obj, prop) {
if (typeof obj[prop] === 'undefined') {
obj[prop] = 1
} else {
obj[prop]++;
}
}
}
function addWinningBid(winningBid) {
const winningAd = adUnits.find(adUnit => adUnit.adUnitId === winningBid.adUnitId);
_winningBids = _winningBids.concat(winningBid);
callBurl(winningBid);
adapterManager.callBidWonBidder(winningBid.adapterCode || winningBid.bidder, winningBid, adUnits);
if (winningAd && !winningAd.deferBilling) adapterManager.callBidBillableBidder(winningBid);
}
function setBidTargeting(bid) {
adapterManager.callSetTargetingBidder(bid.adapterCode || bid.bidder, bid);
}
events.on(EVENTS.SEAT_NON_BID, (event) => {
if (event.auctionId === _auctionId) {
addNonBids(event.seatnonbid)
}
});
return {
addBidReceived,
addBidRejected,
addNoBid,
callBids,
addWinningBid,
setBidTargeting,
getWinningBids: () => _winningBids,
getAuctionStart: () => _auctionStart,
getAuctionEnd: () => _auctionEnd,
getTimeout: () => _timeout,
getAuctionId: () => _auctionId,
getAuctionStatus: () => _auctionStatus,
getAdUnits: () => _adUnits,
getAdUnitCodes: () => _adUnitCodes,
getBidRequests: () => _bidderRequests,
getBidsReceived: () => _bidsReceived,
getNoBids: () => _noBids,
getNonBids: () => _nonBids,
getFPD: () => ortb2Fragments,
getMetrics: () => metrics,
end: done.promise
};
}
/**
* Hook into this to intercept bids before they are added to an auction.
*
* @type {Function}
* @param adUnitCode
* @param bid
* @param {function(String): void} reject a function that, when called, rejects `bid` with the given reason.
*/
export const addBidResponse = hook('sync', function(adUnitCode, bid, reject) {
this.dispatch.call(null, adUnitCode, bid);
}, 'addBidResponse');
/**
* Delay hook for adapter responses.
*
* `ready` is a promise; auctions wait for it to resolve before closing. Modules can hook into this
* to delay the end of auctions while they perform initialization that does not need to delay their start.
*/
export const responsesReady = hook('sync', (ready) => ready, 'responsesReady');
export const addBidderRequests = hook('sync', function(bidderRequests) {
this.dispatch.call(this.context, bidderRequests);
}, 'addBidderRequests');
export const bidsBackCallback = hook('async', function (adUnits, callback) {
if (callback) {
callback();
}
}, 'bidsBackCallback');
export function auctionCallbacks(auctionDone, auctionInstance, {index = auctionManager.index} = {}) {
let outstandingBidsAdded = 0;
let allAdapterCalledDone = false;
let bidderRequestsDone = new Set();
let bidResponseMap = {};
function afterBidAdded() {
outstandingBidsAdded--;
if (allAdapterCalledDone && outstandingBidsAdded === 0) {
auctionDone()
}
}
function handleBidResponse(adUnitCode, bid, handler) {
bidResponseMap[bid.requestId] = true;
addCommonResponseProperties(bid, adUnitCode)
outstandingBidsAdded++;
return handler(afterBidAdded);
}
function acceptBidResponse(adUnitCode, bid) {
handleBidResponse(adUnitCode, bid, (done) => {
let bidResponse = getPreparedBidForAuction(bid);
events.emit(EVENTS.BID_ACCEPTED, bidResponse);
if (FEATURES.VIDEO && bidResponse.mediaType === VIDEO) {
tryAddVideoBid(auctionInstance, bidResponse, done);
} else {
if (FEATURES.NATIVE && isNativeResponse(bidResponse)) {
setNativeResponseProperties(bidResponse, index.getAdUnit(bidResponse));
}
addBidToAuction(auctionInstance, bidResponse);
done();
}
});
}
function rejectBidResponse(adUnitCode, bid, reason) {
return handleBidResponse(adUnitCode, bid, (done) => {
bid.rejectionReason = reason;
logWarn(`Bid from ${bid.bidder || 'unknown bidder'} was rejected: ${reason}`, bid)
events.emit(EVENTS.BID_REJECTED, bid);
auctionInstance.addBidRejected(bid);
done();
})
}
function adapterDone() {
let bidderRequest = this;
let bidderRequests = auctionInstance.getBidRequests();
const auctionOptionsConfig = config.getConfig('auctionOptions');
bidderRequestsDone.add(bidderRequest);
if (auctionOptionsConfig && !isEmpty(auctionOptionsConfig)) {
const secondaryBidders = auctionOptionsConfig.secondaryBidders;
if (secondaryBidders && !bidderRequests.every(bidder => includes(secondaryBidders, bidder.bidderCode))) {
bidderRequests = bidderRequests.filter(request => !includes(secondaryBidders, request.bidderCode));
}
}
allAdapterCalledDone = bidderRequests.every(bidderRequest => bidderRequestsDone.has(bidderRequest));
bidderRequest.bids.forEach(bid => {
if (!bidResponseMap[bid.bidId]) {
auctionInstance.addNoBid(bid);
events.emit(EVENTS.NO_BID, bid);
}
});
if (allAdapterCalledDone && outstandingBidsAdded === 0) {
auctionDone();
}
}
return {
addBidResponse: (function () {
function addBid(adUnitCode, bid) {
addBidResponse.call({
dispatch: acceptBidResponse,
}, adUnitCode, bid, (() => {
let rejected = false;
return (reason) => {
if (!rejected) {
rejectBidResponse(adUnitCode, bid, reason);
rejected = true;
}
}
})())
}
addBid.reject = rejectBidResponse;
return addBid;
})(),
adapterDone: function () {
responsesReady(GreedyPromise.resolve()).finally(() => adapterDone.call(this));
}
}
}
// Add a bid to the auction.
export function addBidToAuction(auctionInstance, bidResponse) {
setupBidTargeting(bidResponse);
useMetrics(bidResponse.metrics).timeSince('addBidResponse', 'addBidResponse.total');
auctionInstance.addBidReceived(bidResponse);
events.emit(EVENTS.BID_RESPONSE, bidResponse);
}
// Video bids may fail if the cache is down, or there's trouble on the network.
function tryAddVideoBid(auctionInstance, bidResponse, afterBidAdded, {index = auctionManager.index} = {}) {
let addBid = true;
const videoMediaType = deepAccess(
index.getMediaTypes({
requestId: bidResponse.originalRequestId || bidResponse.requestId,
adUnitId: bidResponse.adUnitId
}), 'video');
const context = videoMediaType && deepAccess(videoMediaType, 'context');
const useCacheKey = videoMediaType && deepAccess(videoMediaType, 'useCacheKey');
if (config.getConfig('cache.url') && (useCacheKey || context !== OUTSTREAM)) {
if (!bidResponse.videoCacheKey || config.getConfig('cache.ignoreBidderCacheKey')) {
addBid = false;
callPrebidCache(auctionInstance, bidResponse, afterBidAdded, videoMediaType);
} else if (!bidResponse.vastUrl) {
logError('videoCacheKey specified but not required vastUrl for video bid');
addBid = false;
}
}
if (addBid) {
addBidToAuction(auctionInstance, bidResponse);
afterBidAdded();
}
}
const _storeInCache = (batch) => {
store(batch.map(entry => entry.bidResponse), function (error, cacheIds) {
cacheIds.forEach((cacheId, i) => {
const { auctionInstance, bidResponse, afterBidAdded } = batch[i];
if (error) {
logWarn(`Failed to save to the video cache: ${error}. Video bid must be discarded.`);
} else {
if (cacheId.uuid === '') {
logWarn(`Supplied video cache key was already in use by Prebid Cache; caching attempt was rejected. Video bid must be discarded.`);
} else {
bidResponse.videoCacheKey = cacheId.uuid;
if (!bidResponse.vastUrl) {
bidResponse.vastUrl = getCacheUrl(bidResponse.videoCacheKey);
}
addBidToAuction(auctionInstance, bidResponse);
afterBidAdded();
}
}
});
});
};
const storeInCache = FEATURES.VIDEO ? _storeInCache : () => {};
let batchSize, batchTimeout;
config.getConfig('cache', (cacheConfig) => {
batchSize = typeof cacheConfig.cache.batchSize === 'number' && cacheConfig.cache.batchSize > 0
? cacheConfig.cache.batchSize
: 1;
batchTimeout = typeof cacheConfig.cache.batchTimeout === 'number' && cacheConfig.cache.batchTimeout > 0
? cacheConfig.cache.batchTimeout
: 0;
});
export const batchingCache = (timeout = setTimeout, cache = storeInCache) => {
let batches = [[]];
let debouncing = false;
const noTimeout = cb => cb();
return function(auctionInstance, bidResponse, afterBidAdded) {
const batchFunc = batchTimeout > 0 ? timeout : noTimeout;
if (batches[batches.length - 1].length >= batchSize) {
batches.push([]);
}
batches[batches.length - 1].push({auctionInstance, bidResponse, afterBidAdded});
if (!debouncing) {
debouncing = true;
batchFunc(() => {
batches.forEach(cache);
batches = [[]];
debouncing = false;
}, batchTimeout);
}
}
};
const batchAndStore = batchingCache();
export const callPrebidCache = hook('async', function(auctionInstance, bidResponse, afterBidAdded, videoMediaType) {
batchAndStore(auctionInstance, bidResponse, afterBidAdded);
}, 'callPrebidCache');
/**
* Augment `bidResponse` with properties that are common across all bids - including rejected bids.
*
*/
function addCommonResponseProperties(bidResponse, adUnitCode, {index = auctionManager.index} = {}) {
const bidderRequest = index.getBidderRequest(bidResponse);
const adUnit = index.getAdUnit(bidResponse);
const start = (bidderRequest && bidderRequest.start) || bidResponse.requestTimestamp;
Object.assign(bidResponse, {
responseTimestamp: bidResponse.responseTimestamp || timestamp(),
requestTimestamp: bidResponse.requestTimestamp || start,
cpm: parseFloat(bidResponse.cpm) || 0,
bidder: bidResponse.bidder || bidResponse.bidderCode,
adUnitCode
});
if (adUnit?.ttlBuffer != null) {
bidResponse.ttlBuffer = adUnit.ttlBuffer;
}
bidResponse.timeToRespond = bidResponse.responseTimestamp - bidResponse.requestTimestamp;
}
/**
* Add additional bid response properties that are universal for all _accepted_ bids.
*/
function getPreparedBidForAuction(bid, {index = auctionManager.index} = {}) {
// Let listeners know that now is the time to adjust the bid, if they want to.
//
// CAREFUL: Publishers rely on certain bid properties to be available (like cpm),
// but others to not be set yet (like priceStrings). See #1372 and #1389.
events.emit(EVENTS.BID_ADJUSTMENT, bid);
// a publisher-defined renderer can be used to render bids
const bidRenderer = index.getBidRequest(bid)?.renderer || index.getAdUnit(bid).renderer;
// a publisher can also define a renderer for a mediaType
const bidObjectMediaType = bid.mediaType;
const mediaTypes = index.getMediaTypes(bid);
const bidMediaType = mediaTypes && mediaTypes[bidObjectMediaType];
var mediaTypeRenderer = bidMediaType && bidMediaType.renderer;
var renderer = null;
// the renderer for the mediaType takes precendence
if (mediaTypeRenderer && mediaTypeRenderer.url && mediaTypeRenderer.render && !(mediaTypeRenderer.backupOnly === true && bid.renderer)) {
renderer = mediaTypeRenderer;
} else if (bidRenderer && bidRenderer.url && bidRenderer.render && !(bidRenderer.backupOnly === true && bid.renderer)) {
renderer = bidRenderer;
}
if (renderer) {
// be aware, an adapter could already have installed the bidder, in which case this overwrite's the existing adapter
bid.renderer = Renderer.install({ url: renderer.url, config: renderer.options });// rename options to config, to make it consistent?
bid.renderer.setRender(renderer.render);
}
// Use the config value 'mediaTypeGranularity' if it has been defined for mediaType, else use 'customPriceBucket'
const mediaTypeGranularity = getMediaTypeGranularity(bid.mediaType, mediaTypes, config.getConfig('mediaTypePriceGranularity'));
const priceStringsObj = getPriceBucketString(
bid.cpm,
(typeof mediaTypeGranularity === 'object') ? mediaTypeGranularity : config.getConfig('customPriceBucket'),
config.getConfig('currency.granularityMultiplier')
);
bid.pbLg = priceStringsObj.low;
bid.pbMg = priceStringsObj.med;
bid.pbHg = priceStringsObj.high;
bid.pbAg = priceStringsObj.auto;
bid.pbDg = priceStringsObj.dense;
bid.pbCg = priceStringsObj.custom;
return bid;
}
function setupBidTargeting(bidObject) {
let keyValues;
const cpmCheck = (bidderSettings.get(bidObject.bidderCode, 'allowZeroCpmBids') === true) ? bidObject.cpm >= 0 : bidObject.cpm > 0;
if (bidObject.bidderCode && (cpmCheck || bidObject.dealId)) {
keyValues = getKeyValueTargetingPairs(bidObject.bidderCode, bidObject);
}
// use any targeting provided as defaults, otherwise just set from getKeyValueTargetingPairs
bidObject.adserverTargeting = Object.assign(bidObject.adserverTargeting || {}, keyValues);
}
/**
* @param {MediaType} mediaType
* @param mediaTypes media types map from adUnit
* @param {MediaTypePriceGranularity} [mediaTypePriceGranularity]
* @returns {(Object|string|undefined)}
*/
export function getMediaTypeGranularity(mediaType, mediaTypes, mediaTypePriceGranularity) {
if (mediaType && mediaTypePriceGranularity) {
if (FEATURES.VIDEO && mediaType === VIDEO) {
const context = deepAccess(mediaTypes, `${VIDEO}.context`, 'instream');
if (mediaTypePriceGranularity[`${VIDEO}-${context}`]) {
return mediaTypePriceGranularity[`${VIDEO}-${context}`];
}
}
return mediaTypePriceGranularity[mediaType];
}
}
/**
* This function returns the price granularity defined. It can be either publisher defined or default value
* @param {Bid} bid bid response object
* @param {object} obj
* @param {object} obj.index
* @returns {string} granularity
*/
export const getPriceGranularity = (bid, {index = auctionManager.index} = {}) => {
// Use the config value 'mediaTypeGranularity' if it has been set for mediaType, else use 'priceGranularity'
const mediaTypeGranularity = getMediaTypeGranularity(bid.mediaType, index.getMediaTypes(bid), config.getConfig('mediaTypePriceGranularity'));
const granularity = (typeof bid.mediaType === 'string' && mediaTypeGranularity) ? ((typeof mediaTypeGranularity === 'string') ? mediaTypeGranularity : 'custom') : config.getConfig('priceGranularity');
return granularity;
}
/**
* This function returns a function to get bid price by price granularity
* @param {string} granularity
* @returns {function}
*/
export const getPriceByGranularity = (granularity) => {
return (bid) => {
const bidGranularity = granularity || getPriceGranularity(bid);
if (bidGranularity === GRANULARITY_OPTIONS.AUTO) {
return bid.pbAg;
} else if (bidGranularity === GRANULARITY_OPTIONS.DENSE) {
return bid.pbDg;
} else if (bidGranularity === GRANULARITY_OPTIONS.LOW) {
return bid.pbLg;
} else if (bidGranularity === GRANULARITY_OPTIONS.MEDIUM) {
return bid.pbMg;
} else if (bidGranularity === GRANULARITY_OPTIONS.HIGH) {
return bid.pbHg;
} else if (bidGranularity === GRANULARITY_OPTIONS.CUSTOM) {
return bid.pbCg;
}
}
}
/**
* This function returns a function to get crid from bid response
* @returns {function}
*/
export const getCreativeId = () => {
return (bid) => {
return (bid.creativeId) ? bid.creativeId : '';
}
}
/**
* This function returns a function to get first advertiser domain from bid response meta
* @returns {function}
*/
export const getAdvertiserDomain = () => {
return (bid) => {
return (bid.meta && bid.meta.advertiserDomains && bid.meta.advertiserDomains.length > 0) ? [bid.meta.advertiserDomains].flat()[0] : '';
}
}
/**
* This function returns a function to get dsp name or id from bid response meta
* @returns {function}
*/
export const getDSP = () => {
return (bid) => {
return (bid.meta && (bid.meta.networkId || bid.meta.networkName)) ? deepAccess(bid, 'meta.networkName') || deepAccess(bid, 'meta.networkId') : '';
}
}
/**
* This function returns a function to get the primary category id from bid response meta
* @returns {function}
*/
export const getPrimaryCatId = () => {
return (bid) => {
return (bid.meta && bid.meta.primaryCatId) ? bid.meta.primaryCatId : '';
}
}
// factory for key value objs
function createKeyVal(key, value) {
return {
key,
val: (typeof value === 'function')
? function (bidResponse, bidReq) {
return value(bidResponse, bidReq);
}
: function (bidResponse) {
return getValue(bidResponse, value);
}
};
}
function defaultAdserverTargeting() {
return [
createKeyVal(TARGETING_KEYS.BIDDER, 'bidderCode'),
createKeyVal(TARGETING_KEYS.AD_ID, 'adId'),
createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity()),
createKeyVal(TARGETING_KEYS.SIZE, 'size'),
createKeyVal(TARGETING_KEYS.DEAL, 'dealId'),
createKeyVal(TARGETING_KEYS.SOURCE, 'source'),
createKeyVal(TARGETING_KEYS.FORMAT, 'mediaType'),
createKeyVal(TARGETING_KEYS.ADOMAIN, getAdvertiserDomain()),
createKeyVal(TARGETING_KEYS.ACAT, getPrimaryCatId()),
createKeyVal(TARGETING_KEYS.DSP, getDSP()),
createKeyVal(TARGETING_KEYS.CRID, getCreativeId()),
]
}
/**
* @param {string} mediaType
* @param {string} bidderCode
* @returns {*}
*/
export function getStandardBidderSettings(mediaType, bidderCode) {
const standardSettings = Object.assign({}, bidderSettings.settingsFor(null));
if (!standardSettings[JSON_MAPPING.ADSERVER_TARGETING]) {
standardSettings[JSON_MAPPING.ADSERVER_TARGETING] = defaultAdserverTargeting();
}
if (FEATURES.VIDEO && mediaType === 'video') {
const adserverTargeting = standardSettings[JSON_MAPPING.ADSERVER_TARGETING].slice();
standardSettings[JSON_MAPPING.ADSERVER_TARGETING] = adserverTargeting;
// Adding hb_uuid + hb_cache_id
[TARGETING_KEYS.UUID, TARGETING_KEYS.CACHE_ID].forEach(targetingKeyVal => {
if (typeof find(adserverTargeting, kvPair => kvPair.key === targetingKeyVal) === 'undefined') {
adserverTargeting.push(createKeyVal(targetingKeyVal, 'videoCacheKey'));
}
});
// Adding hb_cache_host
if (config.getConfig('cache.url') && (!bidderCode || bidderSettings.get(bidderCode, 'sendStandardTargeting') !== false)) {
const urlInfo = parseUrl(config.getConfig('cache.url'));
if (typeof find(adserverTargeting, targetingKeyVal => targetingKeyVal.key === TARGETING_KEYS.CACHE_HOST) === 'undefined') {
adserverTargeting.push(createKeyVal(TARGETING_KEYS.CACHE_HOST, function(bidResponse) {
return deepAccess(bidResponse, `adserverTargeting.${TARGETING_KEYS.CACHE_HOST}`)
? bidResponse.adserverTargeting[TARGETING_KEYS.CACHE_HOST] : urlInfo.hostname;
}));
}
}
}
return standardSettings;
}
export function getKeyValueTargetingPairs(bidderCode, custBidObj, {index = auctionManager.index} = {}) {
if (!custBidObj) {
return {};
}
const bidRequest = index.getBidRequest(custBidObj);
var keyValues = {};
// 1) set the keys from "standard" setting or from prebid defaults
// initialize default if not set
const standardSettings = getStandardBidderSettings(custBidObj.mediaType, bidderCode);
setKeys(keyValues, standardSettings, custBidObj, bidRequest);
// 2) set keys from specific bidder setting override if they exist
if (bidderCode && bidderSettings.getOwn(bidderCode, JSON_MAPPING.ADSERVER_TARGETING)) {
setKeys(keyValues, bidderSettings.ownSettingsFor(bidderCode), custBidObj, bidRequest);
custBidObj.sendStandardTargeting = bidderSettings.get(bidderCode, 'sendStandardTargeting');
}
// set native key value targeting
if (FEATURES.NATIVE && custBidObj['native']) {
keyValues = Object.assign({}, keyValues, getNativeTargeting(custBidObj));
}
return keyValues;
}
function setKeys(keyValues, bidderSettings, custBidObj, bidReq) {
var targeting = bidderSettings[JSON_MAPPING.ADSERVER_TARGETING];
custBidObj.size = custBidObj.getSize();
(targeting || []).forEach(function (kvPair) {
var key = kvPair.key;
var value = kvPair.val;
if (keyValues[key]) {
logWarn('The key: ' + key + ' is being overwritten');
}
if (isFn(value)) {
try {
value = value(custBidObj, bidReq);
} catch (e) {
logError('bidmanager', 'ERROR', e);
}
}
if (
((typeof bidderSettings.suppressEmptyKeys !== 'undefined' && bidderSettings.suppressEmptyKeys === true) ||
key === TARGETING_KEYS.DEAL || key === TARGETING_KEYS.ACAT || key === TARGETING_KEYS.DSP || key === TARGETING_KEYS.CRID) && // hb_deal & hb_acat are suppressed automatically if not set
(
isEmptyStr(value) ||
value === null ||
value === undefined
)
) {
logInfo("suppressing empty key '" + key + "' from adserver targeting");
} else {
keyValues[key] = value;
}
});
return keyValues;
}
export function adjustBids(bid) {
let bidPriceAdjusted = adjustCpm(bid.cpm, bid);
if (bidPriceAdjusted >= 0) {
bid.cpm = bidPriceAdjusted;
}
}
/**
* groupByPlacement is a reduce function that converts an array of Bid objects
* to an object with placement codes as keys, with each key representing an object
* with an array of `Bid` objects for that placement
* @returns {*} as { [adUnitCode]: { bids: [Bid, Bid, Bid] } }
*/
function groupByPlacement(bidsByPlacement, bid) {
if (!bidsByPlacement[bid.adUnitCode]) { bidsByPlacement[bid.adUnitCode] = { bids: [] }; }
bidsByPlacement[bid.adUnitCode].bids.push(bid);
return bidsByPlacement;
}