This repository has been archived by the owner on May 7, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
locker-dome-htb.js
539 lines (458 loc) · 20.5 KB
/
locker-dome-htb.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
'use strict';
////////////////////////////////////////////////////////////////////////////////
// Dependencies ////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
var Browser = require('browser.js');
var Classify = require('classify.js');
var Constants = require('constants.js');
var Partner = require('partner.js');
var Size = require('size.js');
var SpaceCamp = require('space-camp.js');
var System = require('system.js');
var Network = require('network.js');
var ComplianceService;
var RenderService;
//? if (DEBUG) {
var ConfigValidators = require('config-validators.js');
var PartnerSpecificValidator = require('locker-dome-htb-validator.js');
var Scribe = require('scribe.js');
var Whoopsie = require('whoopsie.js');
//? }
////////////////////////////////////////////////////////////////////////////////
// Main ////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/**
* Partner module template
*
* @class
*/
function LockerDomeHtb(configs) {
// Endpoint w/ AJAX only
if (!Network.isXhrSupported()) {
// ? if (DEBUG) {
Scribe.warn('Partner lockerdome requires AJAX support. Aborting instantiation.');
// ? }
return null;
}
/* =====================================
* Data
* ---------------------------------- */
/* Private
* ---------------------------------- */
/**
* Reference to the partner base class.
*
* @private {object}
*/
var __baseClass;
/**
* Profile for this partner.
*
* @private {object}
*/
var __profile;
/* =====================================
* Functions
* ---------------------------------- */
/* Utilities
* ---------------------------------- */
/**
* Generates the request URL and query data to the endpoint for the xSlots
* in the given returnParcels.
*
* @param {object[]} returnParcels
*
* @return {object}
*/
function __generateRequestObj(returnParcels) {
/* =============================================================================
* STEP 2 | Generate Request URL
* -----------------------------------------------------------------------------
*
* Generate the URL to request demand from the partner endpoint using the provided
* returnParcels. The returnParcels is an array of objects each object containing
* an .xSlotRef which is a reference to the xSlot object from the partner configuration.
* Use this to retrieve the placements/xSlots you need to request for.
*
* If your partner is MRA, returnParcels will be an array of length one. If your
* partner is SRA, it will contain any number of entities. In any event, the full
* contents of the array should be able to fit into a single request and the
* return value of this function should similarly represent a single request to the
* endpoint.
*
* Return an object containing:
* queryUrl: the url for the request
* data: the query object containing a map of the query string paramaters
*
* callbackId:
*
* arbitrary id to match the request with the response in the callback function. If
* your endpoint supports passing in an arbitrary ID and returning it as part of the response
* please use the callbackType: Partner.CallbackTypes.ID and fill out the adResponseCallback.
* Also please provide this adResponseCallback to your bid request here so that the JSONP
* response calls it once it has completed.
*
* If your endpoint does not support passing in an ID, simply use
* Partner.CallbackTypes.CALLBACK_NAME and the wrapper will take care of handling request
* matching by generating unique callbacks for each request using the callbackId.
*
* If your endpoint is ajax only, please set the appropriate values in your profile for this,
* i.e. Partner.CallbackTypes.NONE and Partner.Requesttypes.AJAX. You also do not need to provide
* a callbackId in this case because there is no callback.
*
* The return object should look something like this:
* {
* url: 'http://bidserver.com/api/bids' // base request url for a GET/POST request
* data: { // query string object that will be attached to the base url
* slots: [
* {
* placementId: 54321,
* sizes: [[300, 250]]
* },{
* placementId: 12345,
* sizes: [[300, 600]]
* },{
* placementId: 654321,
* sizes: [[728, 90]]
* }
* ],
* site: 'http://google.com'
* },
* callbackId: '_23sd2ij4i1' //unique id used for pairing requests and responses
* }
*/
/* ---------------------- PUT CODE HERE ------------------------------------ */
var baseUrl = 'https://lockerdome.com/ladbid/indexexchange?cachebuster=' + System.generateUniqueId();
var payload = {
url: Browser.getPageUrl(),
referrer: Browser.getReferrer()
};
/* ------------------------ Get consent information -------------------------
* If you want to implement GDPR consent in your adapter, use the function
* ComplianceService.gdpr.getConsent() which will return an object.
*
* Here is what the values in that object mean:
* - applies: the boolean value indicating if the request is subject to
* GDPR regulations
* - consentString: the consent string developed by GDPR Consent Working
* Group under the auspices of IAB Europe
*
* The return object should look something like this:
* {
* applies: true,
* consentString: "BOQ7WlgOQ7WlgABABwAAABJOACgACAAQABA"
* }
*
* You can also determine whether or not the publisher has enabled privacy
* features in their wrapper by querying ComplianceService.isPrivacyEnabled().
*
* This function will return a boolean, which indicates whether the wrapper's
* privacy features are on (true) or off (false). If they are off, the values
* returned from gdpr.getConsent() are safe defaults and no attempt has been
* made by the wrapper to contact a Consent Management Platform.
*/
var privacyEnabled = ComplianceService.isPrivacyEnabled();
if (privacyEnabled) {
var gdprStatus = ComplianceService.gdpr.getConsent();
payload.gdpr = {
applies: gdprStatus.applies,
consent: gdprStatus.consentString
};
}
/* ---------------- Craft bid request using the above returnParcels --------- */
var bidRequests = [];
var requestIds = [];
for (var i = 0; i !== returnParcels.length; i++) {
var returnParcel = returnParcels[i];
var xSlotRef = returnParcel.xSlotRef;
var requestId = returnParcel.requestId;
bidRequests.push({
adUnitId: xSlotRef.adUnitId,
requestId: requestId
});
requestIds.push(requestId);
}
payload.bidRequests = bidRequests;
baseUrl += '&requestIds=' + requestIds.join(',');
/* -------------------------------------------------------------------------- */
return {
url: baseUrl,
data: payload,
networkParamOverrides: {
method: 'POST',
contentType: 'text/plain'
}
};
}
/* =============================================================================
* STEP 3 | Response callback
* -----------------------------------------------------------------------------
*
* This generator is only necessary if the partner's endpoint has the ability
* to return an arbitrary ID that is sent to it. It should retrieve that ID from
* the response and save the response to adResponseStore keyed by that ID.
*
* If the endpoint does not have an appropriate field for this, set the profile's
* callback type to CallbackTypes.CALLBACK_NAME and omit this function.
*/
function adResponseCallback(adResponse) {
/* Get callbackId from adResponse here */
var callbackId = 0;
__baseClass._adResponseStore[callbackId] = adResponse;
}
/* -------------------------------------------------------------------------- */
/* Helpers
* ---------------------------------- */
/* =============================================================================
* STEP 5 | Rendering Pixel
* -----------------------------------------------------------------------------
*
*/
/**
* This function will render the pixel given.
* @param {string} pixelUrl Tracking pixel img url.
*/
function __renderPixel(pixelUrl) {
if (pixelUrl) {
Network.img({
url: decodeURIComponent(pixelUrl),
method: 'GET'
});
}
}
/**
* Parses and extracts demand from adResponse according to the adapter and then attaches it
* to the corresponding bid's returnParcel in the correct format using targeting keys.
*
* @param {string} sessionId The sessionId, used for stats and other events.
*
* @param {any} adResponse This is the bid response as returned from the bid request, that was either
* passed to a JSONP callback or simply sent back via AJAX.
*
* @param {object[]} returnParcels The array of original parcels, SAME array that was passed to
* generateRequestObj to signal which slots need demand. In this funciton, the demand needs to be
* attached to each one of the objects for which the demand was originally requested for.
*/
function __parseResponse(sessionId, adResponse, returnParcels) {
/* =============================================================================
* STEP 4 | Parse & store demand response
* -----------------------------------------------------------------------------
*
* Fill the below variables with information about the bid from the partner, using
* the adResponse variable that contains your module adResponse.
*/
/* This an array of all the bids in your response that will be iterated over below. Each of
* these will be mapped back to a returnParcel object using some criteria explained below.
* The following variables will also be parsed and attached to that returnParcel object as
* returned demand.
*
* Use the adResponse variable to extract your bid information and insert it into the
* bids array. Each element in the bids array should represent a single bid and should
* match up to a single element from the returnParcel array.
*
*/
/* ---------- Process adResponse and extract the bids into the bids array ------------ */
var bids = adResponse && adResponse.bids;
if (!bids) {
bids = [];
}
/* --------------------------------------------------------------------------------- */
for (var j = 0; j < returnParcels.length; j++) {
var curReturnParcel = returnParcels[j];
var headerStatsInfo = {};
var htSlotId = curReturnParcel.htSlot.getId();
headerStatsInfo[htSlotId] = {};
headerStatsInfo[htSlotId][curReturnParcel.requestId] = [curReturnParcel.xSlotName];
var curBid;
for (var i = 0; i < bids.length; i++) {
/**
* This section maps internal returnParcels and demand returned from the bid request.
* In order to match them correctly, they must be matched via some criteria. This
* is usually some sort of placements or inventory codes. Please replace the someCriteria
* key to a key that represents the placement in the configuration and in the bid responses.
*/
/* ----------- Fill this out to find a matching bid for the current parcel ------------- */
if (curReturnParcel.requestId === bids[i].requestId) {
curBid = bids[i];
bids.splice(i, 1);
break;
}
}
/* No matching bid found so its a pass */
if (!curBid) {
if (__profile.enabledAnalytics.requestTime) {
__baseClass._emitStatsEvent(sessionId, 'hs_slot_pass', headerStatsInfo);
}
curReturnParcel.pass = true;
continue;
}
/* ---------- Fill the bid variables with data from the bid response here. ------------ */
/* Using the above variable, curBid, extract various information about the bid and assign it to
* these local variables */
/* The bid price for the given slot */
var bidPrice = curBid.cpm;
/* The size of the given slot */
var bidSize = [Number(curBid.width), Number(curBid.height)];
/* The creative/adm for the given slot that will be rendered if is the winner.
* Please make sure the URL is decoded and ready to be document.written.
*/
var bidCreative = curBid.ad;
/* The dealId if applicable for this slot. */
var bidDealId = curBid.dealid;
/* Explicitly pass */
var bidIsPass = bidPrice <= 0;
/* OPTIONAL: tracking pixel url to be fired AFTER rendering a winning creative.
* If firing a tracking pixel is not required or the pixel url is part of the adm,
* leave empty;
*/
var pixelUrl = '';
/* --------------------------------------------------------------------------------------- */
curBid = null;
if (bidIsPass) {
//? if (DEBUG) {
Scribe.info(__profile.partnerId + ' returned pass for { id: ' + adResponse.id + ' }.');
//? }
if (__profile.enabledAnalytics.requestTime) {
__baseClass._emitStatsEvent(sessionId, 'hs_slot_pass', headerStatsInfo);
}
curReturnParcel.pass = true;
continue;
}
if (__profile.enabledAnalytics.requestTime) {
__baseClass._emitStatsEvent(sessionId, 'hs_slot_bid', headerStatsInfo);
}
curReturnParcel.size = bidSize;
curReturnParcel.targetingType = 'slot';
curReturnParcel.targeting = {};
var targetingCpm = '';
//? if (FEATURES.GPT_LINE_ITEMS) {
targetingCpm = __baseClass._bidTransformers.targeting.apply(bidPrice);
var sizeKey = Size.arrayToString(curReturnParcel.size);
if (bidDealId) {
curReturnParcel.targeting[__baseClass._configs.targetingKeys.pmid] = [sizeKey + '_' + bidDealId];
curReturnParcel.targeting[__baseClass._configs.targetingKeys.pm] = [sizeKey + '_' + targetingCpm];
} else {
curReturnParcel.targeting[__baseClass._configs.targetingKeys.om] = [sizeKey + '_' + targetingCpm];
}
curReturnParcel.targeting[__baseClass._configs.targetingKeys.id] = [curReturnParcel.requestId];
//? }
//? if (FEATURES.RETURN_CREATIVE) {
curReturnParcel.adm = bidCreative;
if (pixelUrl) {
curReturnParcel.winNotice = __renderPixel.bind(null, pixelUrl);
}
//? }
//? if (FEATURES.RETURN_PRICE) {
curReturnParcel.price = Number(__baseClass._bidTransformers.price.apply(bidPrice));
//? }
var expiry = 0;
if (__profile.features.demandExpiry.enabled) {
expiry = __profile.features.demandExpiry.value + System.now();
}
var pubKitAdId = RenderService.registerAd({
sessionId: sessionId,
partnerId: __profile.partnerId,
adm: bidCreative,
requestId: curReturnParcel.requestId,
size: curReturnParcel.size,
price: targetingCpm,
dealId: bidDealId || null,
timeOfExpiry: expiry,
auxFn: __renderPixel,
auxArgs: [pixelUrl]
});
//? if (FEATURES.INTERNAL_RENDER) {
curReturnParcel.targeting.pubKitAdId = pubKitAdId;
//? }
}
}
/* =====================================
* Constructors
* ---------------------------------- */
(function __constructor() {
ComplianceService = SpaceCamp.services.ComplianceService;
RenderService = SpaceCamp.services.RenderService;
/* =============================================================================
* STEP 1 | Partner Configuration
* -----------------------------------------------------------------------------
*
* Please fill out the below partner profile according to the steps in the README doc.
*/
/* ---------- Please fill out this partner profile according to your module ------------ */
__profile = {
partnerId: 'LockerDomeHtb',
namespace: 'LockerDomeHtb',
statsId: 'LKDM',
version: '2.0.0',
targetingType: 'slot',
enabledAnalytics: {
requestTime: true
},
features: {
demandExpiry: {
enabled: false,
value: 0
},
rateLimiting: {
enabled: false,
value: 0
}
},
/* Targeting keys for demand, should follow format ix_{statsId}_id */
targetingKeys: {
id: 'ix_lkdm_id',
om: 'ix_lkdm_cpm',
pm: 'ix_lkdm_cpm',
pmid: 'ix_lkdm_dealid'
},
/* The bid price unit (in cents) the endpoint returns, please refer to the readme for details */
bidUnitInCents: 100,
lineItemType: Constants.LineItemTypes.ID_AND_SIZE,
callbackType: Partner.CallbackTypes.NONE,
architecture: Partner.Architectures.FSRA,
requestType: Partner.RequestTypes.AJAX
};
/* --------------------------------------------------------------------------------------- */
//? if (DEBUG) {
var results = ConfigValidators.partnerBaseConfig(configs) || PartnerSpecificValidator(configs);
if (results) {
throw Whoopsie('INVALID_CONFIG', results);
}
//? }
__baseClass = Partner(__profile, configs, null, {
parseResponse: __parseResponse,
generateRequestObj: __generateRequestObj,
adResponseCallback: adResponseCallback
});
})();
/* =====================================
* Public Interface
* ---------------------------------- */
var derivedClass = {
/* Class Information
* ---------------------------------- */
//? if (DEBUG) {
__type__: 'LockerDomeHtb',
//? }
//? if (TEST) {
__baseClass: __baseClass,
//? }
/* Data
* ---------------------------------- */
//? if (TEST) {
profile: __profile,
//? }
/* Functions
* ---------------------------------- */
//? if (TEST) {
parseResponse: __parseResponse,
generateRequestObj: __generateRequestObj,
adResponseCallback: adResponseCallback
//? }
};
return Classify.derive(__baseClass, derivedClass);
}
////////////////////////////////////////////////////////////////////////////////
// Exports /////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
module.exports = LockerDomeHtb;