Prebid adapter for windtalker (#5040)

* prebid adatper for windtalker * file extension for imports * fix whitespace in adapter * removed inital value assignment per LGTM request * Minorchange to md file for windtalker * Updated windtalker adapter with tests Co-authored-by: Chris DeGroat <chris@degroat.net>
prebid · Apr 7, 2020 · 036d71d · 036d71d
1 parent 6ad085f
commit 036d71d
Show file tree

Hide file tree

Showing 3 changed files with 741 additions and 0 deletions.
diff --git a/modules/windtalkerBidAdapter.js b/modules/windtalkerBidAdapter.js
@@ -0,0 +1,307 @@
+import * as utils from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import includes from 'core-js/library/fn/array/includes.js';
+
+const NATIVE_DEFAULTS = {
+ TITLE_LEN: 100,
+ DESCR_LEN: 200,
+ SPONSORED_BY_LEN: 50,
+ IMG_MIN: 150,
+ ICON_MIN: 50,
+};
+const DEFAULT_MIMES = ['video/mp4', 'video/webm', 'application/x-shockwave-flash', 'application/javascript'];
+const VIDEO_TARGETING = ['mimes', 'skippable', 'playback_method', 'protocols', 'api'];
+const DEFAULT_PROTOCOLS = [2, 3, 5, 6];
+const DEFAULT_APIS = [1, 2];
+
+export const spec = {
+
+ code: 'windtalker',
+ supportedMediaTypes: ['banner', 'native', 'video'],
+
+ isBidRequestValid: bid => (
+ !!(bid && bid.params && bid.params.pubId && bid.params.placementId)
+ ),
+ buildRequests: (bidRequests, bidderRequest) => {
+ const request = {
+ id: bidRequests[0].bidderRequestId,
+ at: 2,
+ imp: bidRequests.map(slot => impression(slot)),
+ site: site(bidRequests),
+ app: app(bidRequests),
+ device: device(bidRequests),
+ };
+ applyGdpr(bidderRequest, request);
+ return {
+ method: 'POST',
+ url: 'https://windtalkerdisplay.hb.adp3.net/',
+ data: JSON.stringify(request),
+ };
+ },
+ interpretResponse: (response, request) => (
+ bidResponseAvailable(request, response.body)
+ ),
+};
+
+function bidResponseAvailable(bidRequest, bidResponse) {
+ const idToImpMap = {};
+ const idToBidMap = {};
+ const ortbRequest = parse(bidRequest.data);
+ ortbRequest.imp.forEach(imp => {
+ idToImpMap[imp.id] = imp;
+ });
+ if (bidResponse) {
+ bidResponse.seatbid.forEach(seatBid => seatBid.bid.forEach(bid => {
+ idToBidMap[bid.impid] = bid;
+ }));
+ }
+ const bids = [];
+ Object.keys(idToImpMap).forEach(id => {
+ if (idToBidMap[id]) {
+ const bid = {};
+ bid.requestId = id;
+ bid.adId = id;
+ bid.creativeId = id;
+ bid.cpm = idToBidMap[id].price;
+ bid.currency = bidResponse.cur;
+ bid.ttl = 360;
+ bid.netRevenue = true;
+ if (idToImpMap[id]['native']) {
+ bid['native'] = nativeResponse(idToImpMap[id], idToBidMap[id]);
+ let nurl = idToBidMap[id].nurl;
+ nurl = nurl.replace(/\$(%7B|\{)AUCTION_IMP_ID(%7D|\})/gi, idToBidMap[id].impid);
+ nurl = nurl.replace(/\$(%7B|\{)AUCTION_PRICE(%7D|\})/gi, idToBidMap[id].price);
+ nurl = nurl.replace(/\$(%7B|\{)AUCTION_CURRENCY(%7D|\})/gi, bidResponse.cur);
+ nurl = nurl.replace(/\$(%7B|\{)AUCTION_BID_ID(%7D|\})/gi, bidResponse.bidid);
+ bid['native']['impressionTrackers'] = [nurl];
+ bid.mediaType = 'native';
+ } else if (idToImpMap[id]['video']) {
+ bid.vastUrl = idToBidMap[id].adm;
+ bid.vastUrl = bid.vastUrl.replace(/\$(%7B|\{)AUCTION_PRICE(%7D|\})/gi, idToBidMap[id].price);
+ bid.crid = idToBidMap[id].crid;
+ bid.width = idToImpMap[id].video.w;
+ bid.height = idToImpMap[id].video.h;
+ bid.mediaType = 'video';
+ } else if (idToImpMap[id]['banner']) {
+ bid.ad = idToBidMap[id].adm;
+ bid.ad = bid.ad.replace(/\$(%7B|\{)AUCTION_IMP_ID(%7D|\})/gi, idToBidMap[id].impid);
+ bid.ad = bid.ad.replace(/\$(%7B|\{)AUCTION_AD_ID(%7D|\})/gi, idToBidMap[id].adid);
+ bid.ad = bid.ad.replace(/\$(%7B|\{)AUCTION_PRICE(%7D|\})/gi, idToBidMap[id].price);
+ bid.ad = bid.ad.replace(/\$(%7B|\{)AUCTION_CURRENCY(%7D|\})/gi, bidResponse.cur);
+ bid.ad = bid.ad.replace(/\$(%7B|\{)AUCTION_BID_ID(%7D|\})/gi, bidResponse.bidid);
+ bid.width = idToBidMap[id].w;
+ bid.height = idToBidMap[id].h;
+ bid.mediaType = 'banner';
+ }
+ bids.push(bid);
+ }
+ });
+ return bids;
+}
+function impression(slot) {
+ return {
+ id: slot.bidId,
+ secure: window.location.protocol === 'https:' ? 1 : 0,
+ 'banner': banner(slot),
+ 'native': nativeImpression(slot),
+ 'video': videoImpression(slot),
+ bidfloor: slot.params.bidFloor || '0.000001',
+ tagid: slot.params.placementId.toString(),
+ };
+}
+
+function banner(slot) {
+ if (slot.mediaType === 'banner' || utils.deepAccess(slot, 'mediaTypes.banner')) {
+ const sizes = utils.deepAccess(slot, 'mediaTypes.banner.sizes');
+ if (sizes.length > 1) {
+ let format = [];
+ for (let f = 0; f < sizes.length; f++) {
+ format.push({'w': sizes[f][0], 'h': sizes[f][1]});
+ }
+ return {'format': format};
+ } else {
+ return {
+ w: sizes[0][0],
+ h: sizes[0][1]
+ }
+ }
+ }
+ return null;
+}
+
+function videoImpression(slot) {
+ if (slot.mediaType === 'video' || utils.deepAccess(slot, 'mediaTypes.video')) {
+ const sizes = utils.deepAccess(slot, 'mediaTypes.video.playerSize');
+ const video = {
+ w: sizes[0][0],
+ h: sizes[0][1],
+ mimes: DEFAULT_MIMES,
+ protocols: DEFAULT_PROTOCOLS,
+ api: DEFAULT_APIS,
+ };
+ if (slot.params.video) {
+ Object.keys(slot.params.video).filter(param => includes(VIDEO_TARGETING, param)).forEach(param => video[param] = slot.params.video[param]);
+ }
+ return video;
+ }
+ return null;
+}
+
+function nativeImpression(slot) {
+ if (slot.mediaType === 'native' || utils.deepAccess(slot, 'mediaTypes.native')) {
+ const assets = [];
+ addAsset(assets, titleAsset(1, slot.nativeParams.title, NATIVE_DEFAULTS.TITLE_LEN));
+ addAsset(assets, dataAsset(2, slot.nativeParams.body, 2, NATIVE_DEFAULTS.DESCR_LEN));
+ addAsset(assets, dataAsset(3, slot.nativeParams.sponsoredBy, 1, NATIVE_DEFAULTS.SPONSORED_BY_LEN));
+ addAsset(assets, imageAsset(4, slot.nativeParams.icon, 1, NATIVE_DEFAULTS.ICON_MIN, NATIVE_DEFAULTS.ICON_MIN));
+ addAsset(assets, imageAsset(5, slot.nativeParams.image, 3, NATIVE_DEFAULTS.IMG_MIN, NATIVE_DEFAULTS.IMG_MIN));
+ return {
+ request: JSON.stringify({ assets }),
+ ver: '1.1',
+ };
+ }
+ return null;
+}
+
+function addAsset(assets, asset) {
+ if (asset) {
+ assets.push(asset);
+ }
+}
+
+function titleAsset(id, params, defaultLen) {
+ if (params) {
+ return {
+ id,
+ required: params.required ? 1 : 0,
+ title: {
+ len: params.len || defaultLen,
+ },
+ };
+ }
+ return null;
+}
+
+function imageAsset(id, params, type, defaultMinWidth, defaultMinHeight) {
+ return params ? {
+ id,
+ required: params.required ? 1 : 0,
+ img: {
+ type,
+ wmin: params.wmin || defaultMinWidth,
+ hmin: params.hmin || defaultMinHeight,
+ }
+ } : null;
+}
+
+function dataAsset(id, params, type, defaultLen) {
+ return params ? {
+ id,
+ required: params.required ? 1 : 0,
+ data: {
+ type,
+ len: params.len || defaultLen,
+ }
+ } : null;
+}
+
+function site(bidderRequest) {
+ const pubId = bidderRequest && bidderRequest.length > 0 ? bidderRequest[0].params.pubId : '0';
+ const siteId = bidderRequest && bidderRequest.length > 0 ? bidderRequest[0].params.siteId : '0';
+ const appParams = bidderRequest[0].params.app;
+ if (!appParams) {
+ return {
+ publisher: {
+ id: pubId.toString(),
+ domain: window.location.hostname,
+ },
+ id: siteId.toString(),
+ ref: window.top.document.referrer,
+ page: window.location.href,
+ }
+ }
+ return null;
+}
+
+function app(bidderRequest) {
+ const pubId = bidderRequest && bidderRequest.length > 0 ? bidderRequest[0].params.pubId : '0';
+ const appParams = bidderRequest[0].params.app;
+ if (appParams) {
+ return {
+ publisher: {
+ id: pubId.toString(),
+ },
+ id: appParams.id,
+ name: appParams.name,
+ bundle: appParams.bundle,
+ storeurl: appParams.storeUrl,
+ domain: appParams.domain,
+ }
+ }
+ return null;
+}
+
+function device(bidderRequest) {
+ const lat = bidderRequest && bidderRequest.length > 0 ? bidderRequest[0].params.latitude : '';
+ const lon = bidderRequest && bidderRequest.length > 0 ? bidderRequest[0].params.longitude : '';
+ const ifa = bidderRequest && bidderRequest.length > 0 ? bidderRequest[0].params.ifa : '';
+ return {
+ dnt: utils.getDNT() ? 1 : 0,
+ ua: navigator.userAgent,
+ language: (navigator.language || navigator.browserLanguage || navigator.userLanguage || navigator.systemLanguage),
+ w: (window.screen.width || window.innerWidth),
+ h: (window.screen.height || window.innerHeigh),
+ geo: {
+ lat: lat,
+ lon: lon,
+ },
+ ifa: ifa,
+ };
+}
+
+function parse(rawResponse) {
+ try {
+ if (rawResponse) {
+ return JSON.parse(rawResponse);
+ }
+ } catch (ex) {
+ utils.logError('windtalker.parse', 'ERROR', ex);
+ }
+ return null;
+}
+
+function applyGdpr(bidderRequest, ortbRequest) {
+ if (bidderRequest && bidderRequest.gdprConsent) {
+ ortbRequest.regs = { ext: { gdpr: bidderRequest.gdprConsent.gdprApplies ? 1 : 0 } };
+ ortbRequest.user = { ext: { consent: bidderRequest.gdprConsent.consentString } };
+ }
+}
+
+function nativeResponse(imp, bid) {
+ if (imp['native']) {
+ const nativeAd = parse(bid.adm);
+ const keys = {};
+ keys.image = {};
+ keys.icon = {};
+ if (nativeAd && nativeAd['native'] && nativeAd['native'].assets) {
+ nativeAd['native'].assets.forEach(asset => {
+ keys.title = asset.title ? asset.title.text : keys.title;
+ keys.body = asset.data && asset.id === 2 ? asset.data.value : keys.body;
+ keys.sponsoredBy = asset.data && asset.id === 3 ? asset.data.value : keys.sponsoredBy;
+ keys.icon.url = asset.img && asset.id === 4 ? asset.img.url : keys.icon.url;
+ keys.icon.width = asset.img && asset.id === 4 ? asset.img.w : keys.icon.width;
+ keys.icon.height = asset.img && asset.id === 4 ? asset.img.h : keys.icon.height;
+ keys.image.url = asset.img && asset.id === 5 ? asset.img.url : keys.image.url;
+ keys.image.width = asset.img && asset.id === 5 ? asset.img.w : keys.image.width;
+ keys.image.height = asset.img && asset.id === 5 ? asset.img.h : keys.image.height;
+ });
+ if (nativeAd['native'].link) {
+ keys.clickUrl = encodeURIComponent(nativeAd['native'].link.url);
+ }
+ return keys;
+ }
+ }
+ return null;
+}
+
+registerBidder(spec);
diff --git a/modules/windtalkerBidAdapter.md b/modules/windtalkerBidAdapter.md
@@ -0,0 +1,86 @@
+# Overview
+
+**Module Name**: Windtalker Bidder Adapter 
+**Module Type**: Bidder Adapter 
+**Maintainer**: corbin@windtalker.io
+
+# Description
+
+Connects to Windtalker demand source to fetch bids. 
+Banner, Native, Video formats are supported. 
+Please use ```windtalker``` as the bidder code.
+
+# Test Parameters
+```
+ var adUnits = [{
+ code: 'dfp-native-div',
+ mediaTypes: {
+ native: {
+ title: {
+ required: true,
+ len: 75
+ },
+ image: {
+ required: true
+ },
+ body: {
+ len: 200
+ },
+ icon: {
+ required: false
+ }
+ }
+ },
+ bids: [{
+ bidder: 'windtalker',
+ params: {
+ pubId: '584971',
+ siteId: '584971',
+ placementId: '123',
+ bidFloor: '0.001', // optional
+ ifa: 'XXX-XXX', // optional
+ latitude: '40.712775', // optional
+ longitude: '-74.005973', // optional
+ }
+ }]
+ },
+ {
+ code: 'dfp-banner-div',
+ mediaTypes: {
+ banner: {
+ sizes: [
+ [300, 250],[300,600]
+ ],
+ }
+ },
+ bids: [{
+ bidder: 'windtalker',
+ params: {
+ pubId: '584971',
+ siteId: '584971',
+ placementId: '123',
+ }
+ }]
+ },
+ {
+ code: 'dfp-video-div',
+ mediaTypes: {
+ video: {
+ playerSize: [[640, 480]],
+ context: "instream"
+ }
+ },
+ bids: [{
+ bidder: 'windtalker',
+ params: {
+ pubId: '584971',
+ siteId: '584971',
+ placementId: '123',
+ video: {
+ skipppable: true,
+ }
+ }
+ }]
+ }
+ ];
+```