Adhese Bid Adapter: add adomain and adapter to 5.0

modules/adheseBidAdapter.js

@@ -0,0 +1,236 @@
+'use strict';
+
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'adhese';
+const GVLID = 553;
+const USER_SYNC_BASE_URL = 'https://user-sync.adhese.com/iframe/user_sync.html';
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  supportedMediaTypes: [BANNER, VIDEO],
+
+  isBidRequestValid: function(bid) {
+    return !!(bid.params.account && bid.params.location && (bid.params.format || bid.mediaTypes.banner.sizes));
+  },
+
+  buildRequests: function(validBidRequests, bidderRequest) {
+    if (validBidRequests.length === 0) {
+      return null;
+    }
+    const { gdprConsent, refererInfo } = bidderRequest;
+
+    const gdprParams = (gdprConsent && gdprConsent.consentString) ? { xt: [gdprConsent.consentString] } : {};
+    const refererParams = (refererInfo && refererInfo.referer) ? { xf: [base64urlEncode(refererInfo.referer)] } : {};
+    const commonParams = { ...gdprParams, ...refererParams };
+
+    const slots = validBidRequests.map(bid => ({
+      slotname: bidToSlotName(bid),
+      parameters: cleanTargets(bid.params.data)
+    }));
+
+    const payload = {
+      slots: slots,
+      parameters: commonParams,
+      vastContentAsUrl: true,
+      user: {
+        ext: {
+          eids: getEids(validBidRequests),
+        }
+      }
+    };
+
+    const account = getAccount(validBidRequests);
+    const uri = 'https://ads-' + account + '.adhese.com/json';
+
+    return {
+      method: 'POST',
+      url: uri,
+      data: JSON.stringify(payload),
+      bids: validBidRequests,
+      options: {
+        contentType: 'application/json'
+      }
+    };
+  },
+
+  interpretResponse: function(serverResponse, request) {
+    const serverAds = serverResponse.body.reduce(function(map, ad) {
+      map[ad.slotName] = ad;
+      return map;
+    }, {});
+
+    serverResponse.account = getAccount(request.bids);
+
+    return request.bids
+      .map(bid => ({
+        bid: bid,
+        ad: serverAds[bidToSlotName(bid)]
+      }))
+      .filter(item => item.ad)
+      .map(item => adResponse(item.bid, item.ad));
+  },
+
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent) {
+    if (syncOptions.iframeEnabled && serverResponses.length > 0) {
+      const account = serverResponses[0].account;
+      if (account) {
+        let syncurl = USER_SYNC_BASE_URL + '?account=' + account;
+        if (gdprConsent) {
+          syncurl += '&gdpr=' + (gdprConsent.gdprApplies ? 1 : 0);
+          syncurl += '&consentString=' + encodeURIComponent(gdprConsent.consentString || '');
+        }
+        return [{type: 'iframe', url: syncurl}];
+      }
+    }
+    return [];
+  }
+};
+
+function adResponse(bid, ad) {
+  const price = getPrice(ad);
+  const adDetails = getAdDetails(ad);
+  const markup = getAdMarkup(ad);
+
+  const bidResponse = getbaseAdResponse({
+    requestId: bid.bidId,
+    mediaType: ad.extension.mediaType,
+    cpm: Number(price.amount),
+    currency: price.currency,
+    width: Number(ad.width),
+    height: Number(ad.height),
+    creativeId: adDetails.creativeId,
+    dealId: adDetails.dealId,
+    adhese: {
+      originData: adDetails.originData,
+      origin: adDetails.origin,
+      originInstance: adDetails.originInstance
+    },
+    meta: {
+      advertiserDomains: ad.adomain || []
+    }
+  });
+
+  if (bidResponse.mediaType === VIDEO) {
+    if (ad.cachedBodyUrl) {
+      bidResponse.vastUrl = ad.cachedBodyUrl
+    } else {
+      bidResponse.vastXml = markup;
+    }
+  } else {
+    const counter = ad.impressionCounter ? "<img src='" + ad.impressionCounter + "' style='height:1px; width:1px; margin: -1px -1px; display:none;'/>" : '';
+    bidResponse.ad = markup + counter;
+  }
+  return bidResponse;
+}
+
+function cleanTargets(target) {
+  const targets = {};
+  if (target) {
+    Object.keys(target).forEach(function (key) {
+      const val = target[key];
+      const dirtyValues = Array.isArray(val) ? val : [val];
+      const values = dirtyValues.filter(v => v === 0 || v);
+      if (values.length > 0) {
+        if (targets[key]) {
+          const distinctValues = values.filter(v => targets[key].indexOf(v) < 0);
+          targets[key].push.apply(targets[key], distinctValues);
+        } else {
+          targets[key] = values;
+        }
+      }
+    });
+  }
+  return targets;
+}
+
+function bidToSlotName(bid) {
+  if (bid.params.format) {
+    return bid.params.location + '-' + bid.params.format;
+  }
+
+  var sizes = bid.mediaTypes.banner.sizes;
+  sizes.sort();
+  var format = sizes.map(size => size[0] + 'x' + size[1]).join('_');
+
+  if (format.length > 0) {
+    return bid.params.location + '-' + format;
+  } else {
+    return bid.params.location;
+  }
+}
+
+function getAccount(validBidRequests) {
+  return validBidRequests[0].params.account;
+}
+
+function getEids(validBidRequests) {
+  if (validBidRequests[0] && validBidRequests[0].userIdAsEids) {
+    return validBidRequests[0].userIdAsEids;
+  }
+}
+
+function getbaseAdResponse(response) {
+  return Object.assign({ netRevenue: true, ttl: 360 }, response);
+}
+
+function isAdheseAd(ad) {
+  return !ad.origin || ad.origin === 'JERLICIA';
+}
+
+function getAdMarkup(ad) {
+  if (!isAdheseAd(ad) || (ad.ext === 'js' && ad.body !== undefined && ad.body !== '' && ad.body.match(/<script|<SCRIPT|<html|<HTML|<\?xml/))) {
+    return ad.body
+  } else {
+    return ad.tag;
+  }
+}
+
+function getPrice(ad) {
+  if (ad.extension && ad.extension.prebid && ad.extension.prebid.cpm) {
+    return ad.extension.prebid.cpm;
+  }
+  return { amount: 0, currency: 'USD' };
+}
+
+function getAdDetails(ad) {
+  let creativeId = '';
+  let dealId = '';
+  let originData = {};
+  let origin = '';
+  let originInstance = '';
+
+  if (isAdheseAd(ad)) {
+    creativeId = ad.id;
+    dealId = ad.orderId;
+    originData = { priority: ad.priority, orderProperty: ad.orderProperty, adFormat: ad.adFormat, adType: ad.adType, libId: ad.libId, adspaceId: ad.adspaceId, viewableImpressionCounter: ad.viewableImpressionCounter, slotId: ad.slotID, slotName: ad.slotName, advertiserId: ad.advertiserId, adId: ad.id };
+  } else {
+    creativeId = ad.origin + (ad.originInstance ? '-' + ad.originInstance : '');
+    if (ad.originData) {
+      originData = ad.originData;
+      originData.slotId = ad.slotID;
+      originData.slotName = ad.slotName;
+      originData.adType = ad.adType;
+      if (ad.adFormat) originData.adFormat = ad.adFormat;
+      if (ad.originData.seatbid && ad.originData.seatbid.length) {
+        const seatbid = ad.originData.seatbid[0];
+        if (seatbid.bid && seatbid.bid.length) {
+          const bid = seatbid.bid[0];
+          creativeId = String(bid.crid || '');
+          dealId = String(bid.dealid || '');
+        }
+      }
+    }
+    if (ad.originInstance) originInstance = ad.originInstance;
+    if (ad.origin) origin = ad.origin;
+  }
+  return { creativeId: creativeId, dealId: dealId, originData: originData, origin: origin, originInstance: originInstance };
+}
+
+function base64urlEncode(s) {
+  return btoa(s).replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '');
+}
+
+registerBidder(spec);