forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.js
243 lines (201 loc) · 7.71 KB
/
index.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
import { config } from '../../src/config.js';
import { find } from '../../src/polyfill.js';
import * as events from '../../src/events.js';
import { mergeDeep } from '../../src/utils.js';
import { getGlobal } from '../../src/prebidGlobal.js';
import CONSTANTS from '../../src/constants.json';
import {
videoEvents, AUCTION_AD_LOAD_ATTEMPT, AD_IMPRESSION, AD_ERROR, BID_IMPRESSION, BID_ERROR, AUCTION_AD_LOAD_ABORT
} from '../../libraries/video/constants/events.js'
import { PLACEMENT } from '../../libraries/video/constants/ortb.js';
import { videoCoreFactory } from './coreVideo.js';
import { gamSubmoduleFactory } from './gamAdServerSubmodule.js';
import { videoImpressionVerifierFactory } from './videoImpressionVerifier.js';
const videoKey = 'video';
const allVideoEvents = Object.keys(videoEvents).map(eventKey => videoEvents[eventKey]);
events.addEvents(allVideoEvents.concat([AUCTION_AD_LOAD_ATTEMPT, AUCTION_AD_LOAD_ABORT, BID_IMPRESSION, BID_ERROR]).map(getExternalVideoEventName));
/**
* This module adds User Video support to prebid.js
* @module modules/videoModule
*/
export function PbVideo(videoCore_, getConfig_, pbGlobal_, pbEvents_, videoEvents_, gamAdServerFactory_, videoImpressionVerifierFactory_) {
const videoCore = videoCore_;
const getConfig = getConfig_;
const pbGlobal = pbGlobal_;
const requestBids = pbGlobal.requestBids;
const pbEvents = pbEvents_;
const videoEvents = videoEvents_;
const gamAdServerFactory = gamAdServerFactory_;
let gamSubmodule;
let mainContentDivId;
let contentEnrichmentEnabled = true;
const videoImpressionVerifierFactory = videoImpressionVerifierFactory_;
let videoImpressionVerifier;
function init() {
const cache = getConfig('cache');
videoImpressionVerifier = videoImpressionVerifierFactory(!!cache);
getConfig(videoKey, ({ video }) => {
video.providers.forEach(provider => {
videoCore.registerProvider(provider);
videoCore.onEvents(videoEvents, (type, payload) => {
pbEvents.emit(getExternalVideoEventName(type), payload);
}, provider.divId);
const adServerConfig = provider.adServer;
if (!gamSubmodule && adServerConfig) {
gamSubmodule = gamAdServerFactory();
}
});
contentEnrichmentEnabled = video.contentEnrichmentEnabled !== false;
mainContentDivId = contentEnrichmentEnabled ? video.mainContentDivId : null;
});
requestBids.before(beforeBidsRequested, 40);
pbEvents.on(CONSTANTS.EVENTS.BID_ADJUSTMENT, function (bid) {
videoImpressionVerifier.trackBid(bid);
});
pbEvents.on(getExternalVideoEventName(AD_IMPRESSION), function (payload) {
triggerVideoBidEvent(BID_IMPRESSION, payload);
});
pbEvents.on(getExternalVideoEventName(AD_ERROR), function (payload) {
triggerVideoBidEvent(BID_ERROR, payload);
});
}
function renderBid(divId, bid, options = {}) {
const adUrl = bid.vastUrl;
options.adXml = bid.vastXml;
options.winner = bid.bidder;
loadAdTag(adUrl, divId, options);
}
function getOrtbVideo(divId) {
return videoCore.getOrtbVideo(divId);
}
function getOrtbContent(divId) {
return videoCore.getOrtbContent(divId);
}
return { init, renderBid, getOrtbVideo, getOrtbContent };
function beforeBidsRequested(nextFn, bidRequest) {
enrichAuction(bidRequest);
const bidsBackHandler = bidRequest.bidsBackHandler;
if (!bidsBackHandler || typeof bidsBackHandler !== 'function') {
pbEvents.on(CONSTANTS.EVENTS.AUCTION_END, auctionEnd);
}
return nextFn.call(this, bidRequest);
}
function enrichAuction(bidRequest) {
if (mainContentDivId) {
enrichOrtb2(mainContentDivId, bidRequest);
}
const adUnits = bidRequest.adUnits || pbGlobal.adUnits || [];
adUnits.forEach(adUnit => {
const divId = getDivId(adUnit);
enrichAdUnit(adUnit, divId);
if (contentEnrichmentEnabled && !mainContentDivId) {
enrichOrtb2(divId, bidRequest);
}
});
}
function getDivId(adUnit) {
const videoConfig = adUnit.video;
if (!adUnit.mediaTypes.video || !videoConfig) {
return;
}
return videoConfig.divId;
}
function enrichAdUnit(adUnit, videoDivId) {
const ortbVideo = getOrtbVideo(videoDivId);
if (!ortbVideo) {
return;
}
const video = Object.assign({}, adUnit.mediaTypes.video, ortbVideo);
video.context = ortbVideo.placement === PLACEMENT.INSTREAM ? 'instream' : 'outstream';
const width = ortbVideo.w;
const height = ortbVideo.h;
if (width && height) {
video.playerSize = [width, height];
}
adUnit.mediaTypes.video = video;
}
function enrichOrtb2(divId, bidRequest) {
const ortbContent = getOrtbContent(divId);
if (!ortbContent) {
return;
}
bidRequest.ortb2 = mergeDeep({}, bidRequest.ortb2, { site: ortbContent });
}
function auctionEnd(auctionResult) {
auctionResult.adUnits.forEach(adUnit => {
if (adUnit.video) {
renderWinningBid(adUnit);
}
});
}
function getAdServerConfig(adUnitVideoConfig) {
const globalVideoConfig = getConfig(videoKey);
const globalProviderConfig = globalVideoConfig.providers.find(provider => provider.divId === adUnitVideoConfig.divId) || {};
if (!globalVideoConfig.adServer && !globalProviderConfig.adServer && !adUnitVideoConfig.adServer) {
return;
}
return mergeDeep({}, globalVideoConfig.adServer, globalProviderConfig.adServer, adUnitVideoConfig.adServer);
}
function renderWinningBid(adUnit) {
const adUnitCode = adUnit.code;
const options = { adUnitCode };
const videoConfig = adUnit.video;
const divId = videoConfig.divId;
const adServerConfig = getAdServerConfig(videoConfig);
let adUrl;
if (adServerConfig) {
adUrl = gamSubmodule.getAdTagUrl(adUnit, adServerConfig.baseAdTagUrl, adServerConfig.params);
}
if (adUrl) {
loadAdTag(adUrl, divId, options);
return;
}
const highestCpmBids = pbGlobal.getHighestCpmBids(adUnitCode);
if (!highestCpmBids.length) {
pbEvents.emit(getExternalVideoEventName(AUCTION_AD_LOAD_ABORT), options);
return;
}
const highestBid = highestCpmBids.shift();
if (!highestBid) {
return;
}
renderBid(divId, highestBid, options);
}
// options: adXml, winner, adUnitCode,
function loadAdTag(adUrl, divId, options) {
const payload = Object.assign({ adUrl }, options);
pbEvents.emit(getExternalVideoEventName(AUCTION_AD_LOAD_ATTEMPT), payload);
videoCore.setAdTagUrl(adUrl, divId, options);
}
function triggerVideoBidEvent(eventName, adEventPayload) {
const bid = getBid(adEventPayload);
if (!bid) {
return;
}
pbGlobal.markWinningBidAsUsed(bid);
pbEvents.emit(getExternalVideoEventName(eventName), { bid, adEvent: adEventPayload });
}
function getBid(adPayload) {
const { adId, adTagUrl, wrapperAdIds } = adPayload;
const bidIdentifiers = videoImpressionVerifier.getBidIdentifiers(adId, adTagUrl, wrapperAdIds);
if (!bidIdentifiers) {
return;
}
const { adUnitCode, requestId, auctionId } = bidIdentifiers;
const bidAdId = bidIdentifiers.adId;
const { bids } = pbGlobal.getBidResponsesForAdUnitCode(adUnitCode);
return find(bids, bid => bid.adId === bidAdId && bid.requestId === requestId && bid.auctionId === auctionId);
}
}
export function pbVideoFactory() {
const videoCore = videoCoreFactory();
const pbGlobal = getGlobal();
const pbVideo = PbVideo(videoCore, config.getConfig, pbGlobal, events, allVideoEvents, gamSubmoduleFactory, videoImpressionVerifierFactory);
pbVideo.init();
pbGlobal.videoModule = pbVideo;
return pbVideo;
}
function getExternalVideoEventName(eventName) {
return videoKey + eventName.replace(/^./, eventName[0].toUpperCase());
}
pbVideoFactory();