mk9-prebid
Version:
Header Bidding Management Library
267 lines (234 loc) • 8 kB
JavaScript
import { registerBidder } from '../src/adapters/bidderFactory.js';
import * as utils from '../src/utils.js';
import { config } from '../src/config.js';
import {ajax} from '../src/ajax.js';
const BIDDER_CODE = 'impactify';
const BIDDER_ALIAS = ['imp'];
const DEFAULT_CURRENCY = 'USD';
const DEFAULT_VIDEO_WIDTH = 640;
const DEFAULT_VIDEO_HEIGHT = 360;
const ORIGIN = 'https://sonic.impactify.media';
const LOGGER_URI = 'https://logger.impactify.media';
const AUCTIONURI = '/bidder';
const COOKIESYNCURI = '/static/cookie_sync.html';
const GVLID = 606;
const GETCONFIG = config.getConfig;
const getDeviceType = () => {
// OpenRTB Device type
if ((/ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle/i.test(navigator.userAgent.toLowerCase()))) {
return 5;
}
if ((/iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i.test(navigator.userAgent.toLowerCase()))) {
return 4;
}
return 2;
}
const createOpenRtbRequest = (validBidRequests, bidderRequest) => {
// Create request and set imp bids inside
let request = {
id: bidderRequest.auctionId,
validBidRequests,
cur: [DEFAULT_CURRENCY],
imp: []
};
// Force impactify debugging parameter
if (window.localStorage.getItem('_im_db_bidder') != null) {
request.test = Number(window.localStorage.getItem('_im_db_bidder'));
}
// Set device/user/site
if (!request.device) request.device = {};
if (!request.site) request.site = {};
request.device = {
w: window.innerWidth,
h: window.innerHeight,
devicetype: getDeviceType(),
ua: navigator.userAgent,
js: 1,
dnt: (navigator.doNotTrack == 'yes' || navigator.doNotTrack == '1' || navigator.msDoNotTrack == '1') ? 1 : 0,
language: ((navigator.language || navigator.userLanguage || '').split('-'))[0] || 'en',
};
request.site = {page: bidderRequest.refererInfo.referer};
// Handle privacy settings for GDPR/CCPA/COPPA
let gdprApplies = 0;
if (bidderRequest.gdprConsent) {
if (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') gdprApplies = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
utils.deepSetValue(request, 'user.ext.consent', bidderRequest.gdprConsent.consentString);
}
utils.deepSetValue(request, 'regs.ext.gdpr', gdprApplies);
if (bidderRequest.uspConsent) {
utils.deepSetValue(request, 'regs.ext.us_privacy', bidderRequest.uspConsent);
this.syncStore.uspConsent = bidderRequest.uspConsent;
}
if (GETCONFIG('coppa') == true) utils.deepSetValue(request, 'regs.coppa', 1);
if (bidderRequest.uspConsent) {
utils.deepSetValue(request, 'regs.ext.us_privacy', bidderRequest.uspConsent);
}
// Set buyer uid
utils.deepSetValue(request, 'user.buyeruid', utils.generateUUID());
// Create imps with bids
validBidRequests.forEach((bid) => {
let imp = {
id: bid.bidId,
bidfloor: bid.params.bidfloor ? bid.params.bidfloor : 0,
ext: {
impactify: {
appId: bid.params.appId,
format: bid.params.format,
style: bid.params.style
},
},
video: {
playerSize: [DEFAULT_VIDEO_WIDTH, DEFAULT_VIDEO_HEIGHT],
context: 'outstream',
mimes: ['video/mp4'],
},
};
if (bid.params.container) {
imp.ext.impactify.container = bid.params.container;
}
request.imp.push(imp);
});
return request;
};
export const spec = {
code: BIDDER_CODE,
gvlid: GVLID,
supportedMediaTypes: ['video'],
aliases: BIDDER_ALIAS,
/**
* Determines whether or not the given bid request is valid.
*
* @param {BidRequest} bid The bid params to validate.
* @return boolean True if this is a valid bid, and false otherwise.
*/
isBidRequestValid: function (bid) {
if (!bid.params.appId || typeof bid.params.appId != 'string' || !bid.params.format || typeof bid.params.format != 'string' || !bid.params.style || typeof bid.params.style != 'string') {
return false;
}
if (bid.params.format != 'screen' && bid.params.format != 'display') {
return false;
}
if (bid.params.style != 'inline' && bid.params.style != 'impact' && bid.params.style != 'static') {
return false;
}
return true;
},
/**
* Make a server request from the list of BidRequests.
*
* @param {validBidRequests[]} - an array of bids
* @param {bidderRequest} - the bidding request
* @return ServerRequest Info describing the request to the server.
*/
buildRequests: function (validBidRequests, bidderRequest) {
// Create a clean openRTB request
let request = createOpenRtbRequest(validBidRequests, bidderRequest);
return {
method: 'POST',
url: ORIGIN + AUCTIONURI,
data: JSON.stringify(request),
};
},
/**
* Unpack the response from the server into a list of bids.
*
* @param {ServerResponse} serverResponse A successful response from the server.
* @return {Bid[]} An array of bids which were nested inside the server.
*/
interpretResponse: function (serverResponse, bidRequest) {
const serverBody = serverResponse.body;
let bidResponses = [];
if (!serverBody) {
return bidResponses;
}
if (!serverBody.seatbid || !serverBody.seatbid.length) {
return [];
}
serverBody.seatbid.forEach((seatbid) => {
if (seatbid.bid.length) {
bidResponses = [
...bidResponses,
...seatbid.bid
.filter((bid) => bid.price > 0)
.map((bid) => ({
id: bid.id,
requestId: bid.impid,
cpm: bid.price,
currency: serverBody.cur,
netRevenue: true,
ad: bid.adm,
width: bid.w || 0,
height: bid.h || 0,
ttl: 300,
creativeId: bid.crid || 0,
hash: bid.hash,
expiry: bid.expiry,
meta: {
advertiserDomains: bid.adomain && bid.adomain.length ? bid.adomain : []
}
})),
];
}
});
return bidResponses;
},
/**
* Register the user sync pixels which should be dropped after the auction.
*
* @param {SyncOptions} syncOptions Which user syncs are allowed?
* @param {ServerResponse[]} serverResponses List of server's responses.
* @return {UserSync[]} The user syncs which should be dropped.
*/
getUserSyncs: function (
syncOptions,
serverResponses,
gdprConsent,
uspConsent
) {
if (!serverResponses || serverResponses.length === 0) {
return [];
}
if (!syncOptions.iframeEnabled) {
return [];
}
let params = '';
if (gdprConsent && typeof gdprConsent.consentString === 'string') {
if (typeof gdprConsent.gdprApplies === 'boolean') {
params += `?gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
} else {
params += `?gdpr_consent=${gdprConsent.consentString}`;
}
}
if (uspConsent) {
params += `${params ? '&' : '?'}us_privacy=${encodeURIComponent(uspConsent)}`;
}
if (document.location.search.match(/pbs_debug=true/)) params += `&pbs_debug=true`;
return [{
type: 'iframe',
url: ORIGIN + COOKIESYNCURI + params
}];
},
/**
* Register bidder specific code, which will execute if a bid from this bidder won the auction
* @param {Bid} The bid that won the auction
*/
onBidWon: function(bid) {
ajax(`${LOGGER_URI}/log/bidder/won`, null, JSON.stringify(bid), {
method: 'POST',
contentType: 'application/json'
});
return true;
},
/**
* Register bidder specific code, which will execute if bidder timed out after an auction
* @param {data} Containing timeout specific data
*/
onTimeout: function(data) {
ajax(`${LOGGER_URI}/log/bidder/timeout`, null, JSON.stringify(data[0]), {
method: 'POST',
contentType: 'application/json'
});
return true;
}
};
registerBidder(spec);