forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 1
/
videoImpressionVerifier.js
206 lines (169 loc) · 6.13 KB
/
videoImpressionVerifier.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
import { find } from '../../src/polyfill.js';
import { vastXmlEditorFactory } from '../../libraries/video/shared/vastXmlEditor.js';
import { generateUUID } from '../../src/utils.js';
export const PB_PREFIX = 'pb_';
export const UUID_MARKER = PB_PREFIX + 'uuid';
/**
* Video Impression Verifier interface. All implementations of a Video Impression Verifier must comply with this interface.
* @description adds tracking markers to an ad and extracts the bid identifiers from ad event information.
* @typedef {Object} VideoImpressionVerifier
* @function trackBid - requests that a bid's ad be tracked for impression verification.
* @function getBidIdentifiers - requests information from the ad event data that can be used to match the ad to a tracked bid.
*/
/**
* @function VideoImpressionVerifier#trackBid
* @param {Object} bid - Bid that should be tracked.
* @return {String} - Identifier for the bid being tracked.
*/
/**
* @function VideoImpressionVerifier#getBidIdentifiers
* @param {String} adId - In the VAST tag, this value is present in the Ad element's id property.
* @param {String} adTagUrl - The ad tag url that was loaded into the player.
* @param {[String]} adWrapperIds - List of ad id's that were obtained from the different wrappers. Each redirect points to an ad wrapper.
* @return {bidIdentifier} - Object allowing the bid matching the ad event to be identified.
*/
/**
* @typedef {Object} bidIdentifier
* @property {String} adId - Bid identifier.
* @property {String} adUnitCode - Identifier for the Ad Unit for which the bid was made.
* @property {String} auctionId - Id of the auction in which the bid was made.
* @property {String} requestId - Id of the bid request which resulted in the bid.
*/
/**
* Factory function for obtaining a Video Impression Verifier.
* @param {Boolean} isCacheUsed - wether Prebid is configured to use a cache.
* @return {VideoImpressionVerifier}
*/
export function videoImpressionVerifierFactory(isCacheUsed) {
const vastXmlEditor = vastXmlEditorFactory();
const bidTracker = tracker();
if (isCacheUsed) {
return cachedVideoImpressionVerifier(vastXmlEditor, bidTracker);
}
return videoImpressionVerifier(vastXmlEditor, bidTracker);
}
export function videoImpressionVerifier(vastXmlEditor_, bidTracker_) {
const verifier = baseImpressionVerifier(bidTracker_);
const superTrackBid = verifier.trackBid;
const vastXmlEditor = vastXmlEditor_;
verifier.trackBid = function(bid) {
let { vastXml, vastUrl } = bid;
if (!vastXml && !vastUrl) {
return;
}
const uuid = superTrackBid(bid);
if (vastUrl) {
const url = new URL(vastUrl);
url.searchParams.append(UUID_MARKER, uuid);
bid.vastUrl = url.toString();
} else if (vastXml) {
bid.vastXml = vastXmlEditor.getVastXmlWithTracking(vastXml, uuid);
}
return uuid;
}
return verifier;
}
export function cachedVideoImpressionVerifier(vastXmlEditor_, bidTracker_) {
const verifier = baseImpressionVerifier(bidTracker_);
const superTrackBid = verifier.trackBid;
const superGetBidIdentifiers = verifier.getBidIdentifiers;
const vastXmlEditor = vastXmlEditor_;
verifier.trackBid = function (bid, globalAdUnits) {
const adIdOverride = superTrackBid(bid);
let { vastXml, vastUrl, adId, adUnitCode } = bid;
const adUnit = find(globalAdUnits, adUnit => adUnitCode === adUnit.code);
const videoConfig = adUnit && adUnit.video;
const adServerConfig = videoConfig && videoConfig.adServer;
const trackingConfig = adServerConfig && adServerConfig.tracking;
let impressionUrl;
let impressionId;
let errorUrl;
const impressionTracking = trackingConfig.impression;
const errorTracking = trackingConfig.error;
if (impressionTracking) {
impressionUrl = getTrackingUrl(impressionTracking.getUrl, bid);
impressionId = impressionTracking.id || adId + '-impression';
}
if (errorTracking) {
errorUrl = getTrackingUrl(errorTracking.getUrl, bid);
}
if (vastXml) {
vastXml = vastXmlEditor.getVastXmlWithTracking(vastXml, adIdOverride, impressionUrl, impressionId, errorUrl);
} else if (vastUrl) {
vastXml = vastXmlEditor.buildVastWrapper(adIdOverride, vastUrl, impressionUrl, impressionId, errorUrl);
}
bid.vastXml = vastXml;
return adIdOverride;
}
verifier.getBidIdentifiers = function (adId, adTagUrl, adWrapperIds) {
// When the video is cached, the ad tag loaded into the player is a parent wrapper of the cache url.
// As a result, the ad tag Url cannot include identifiers.
return superGetBidIdentifiers(adId, null, adWrapperIds);
}
return verifier;
function getTrackingUrl(getUrl, bid) {
if (!getUrl || typeof getUrl !== 'function') {
return;
}
return getUrl(bid);
}
}
export function baseImpressionVerifier(bidTracker_) {
const bidTracker = bidTracker_;
function trackBid(bid) {
let { adId, adUnitCode, requestId, auctionId } = bid;
const trackingId = PB_PREFIX + generateUUID(10 ** 13);
bidTracker.store(trackingId, { adId, adUnitCode, requestId, auctionId });
return trackingId;
}
function getBidIdentifiers(adId, adTagUrl, adWrapperIds) {
return bidTracker.remove(adId) || getBidForAdTagUrl(adTagUrl) || getBidForAdWrappers(adWrapperIds);
}
return {
trackBid,
getBidIdentifiers
};
function getBidForAdTagUrl(adTagUrl) {
if (!adTagUrl) {
return;
}
let url;
try {
url = new URL(adTagUrl);
} catch (e) {
return;
}
const queryParams = url.searchParams;
let uuid = queryParams.get(UUID_MARKER);
return uuid && bidTracker.remove(uuid);
}
function getBidForAdWrappers(adWrapperIds) {
if (!adWrapperIds || !adWrapperIds.length) {
return;
}
for (const wrapperId in adWrapperIds) {
const bidInfo = bidTracker.remove(wrapperId);
if (bidInfo) {
return bidInfo;
}
}
}
}
export function tracker() {
const model = {};
function store(key, value) {
model[key] = value;
}
function remove(key) {
const value = model[key];
if (!value) {
return;
}
delete model[key];
return value;
}
return {
store,
remove
}
}