Pix Fixture Bid Adapter: add new bid adapter (prebid#7069)

* Add files via upload * Add files via upload * Update pixfutureBidAdapter.md * Update pixfutureBidAdapter.md * Update pixfutureBidAdapter.js * Update pixfutureBidAdapter_spec.js * Update pixfutureBidAdapter.js * Update pixfutureBidAdapter.js Bug fixing: has been lost "pubext" parameter * Update pixfutureBidAdapter.js * Update pixfutureBidAdapter.md * Update pixfutureBidAdapter.js * Update pixfutureBidAdapter.js * Update pixfutureBidAdapter.js * Update pixfutureBidAdapter.js Removing the trailing spaces in lines: 168 and 172 * Add files via upload * Update pixfutureBidAdapter.js removing trilling spaces in the lines: 168,172,178 * Update pixfutureBidAdapter.md
DeepIntent · Jun 24, 2021 · e39cb75 · e39cb75
1 parent 235a330
commit e39cb75
Show file tree

Hide file tree

Showing 3 changed files with 605 additions and 0 deletions.
diff --git a/modules/pixfutureBidAdapter.js b/modules/pixfutureBidAdapter.js
@@ -0,0 +1,323 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+import includes from 'core-js-pure/features/array/includes.js';
+import * as utils from '../src/utils.js';
+import { auctionManager } from '../src/auctionManager.js';
+import find from 'core-js-pure/features/array/find.js';
+
+const SOURCE = 'pbjs';
+const storageManager = getStorageManager();
+const USER_PARAMS = ['age', 'externalUid', 'segments', 'gender', 'dnt', 'language'];
+export const spec = {
+  code: 'pixfuture',
+  hostname: 'https://prebid-js.pixfuture.com',
+
+  getHostname() {
+    let ret = this.hostname;
+    try {
+      ret = storageManager.getDataFromLocalStorage('ov_pixbidder_host') || ret;
+    } catch (e) {
+    }
+    return ret;
+  },
+
+  isBidRequestValid(bid) {
+    return !!(bid.sizes && bid.bidId && bid.params &&
+                (bid.params.pix_id && (typeof bid.params.pix_id === 'string')));
+  },
+
+  buildRequests(validBidRequests, bidderRequest) {
+    const tags = validBidRequests.map(bidToTag);
+    const hostname = this.getHostname();
+    return validBidRequests.map((bidRequest) => {
+      let referer = '';
+      if (bidderRequest && bidderRequest.refererInfo) {
+        referer = bidderRequest.refererInfo.referer || '';
+      }
+
+      const userObjBid = find(validBidRequests, hasUserInfo);
+      let userObj = {};
+      if (config.getConfig('coppa') === true) {
+        userObj = {'coppa': true};
+      }
+
+      if (userObjBid) {
+        Object.keys(userObjBid.params.user)
+          .filter(param => includes(USER_PARAMS, param))
+          .forEach((param) => {
+            let uparam = utils.convertCamelToUnderscore(param);
+            if (param === 'segments' && utils.isArray(userObjBid.params.user[param])) {
+              let segs = [];
+              userObjBid.params.user[param].forEach(val => {
+                if (utils.isNumber(val)) {
+                  segs.push({'id': val});
+                } else if (utils.isPlainObject(val)) {
+                  segs.push(val);
+                }
+              });
+              userObj[uparam] = segs;
+            } else if (param !== 'segments') {
+              userObj[uparam] = userObjBid.params.user[param];
+            }
+          });
+      }
+
+      const schain = validBidRequests[0].schain;
+
+      const payload = {
+        tags: [...tags],
+        user: userObj,
+        sdk: {
+          source: SOURCE,
+          version: '$prebid.version$'
+        },
+        schain: schain
+      };
+
+      if (bidderRequest && bidderRequest.uspConsent) {
+        payload.us_privacy = bidderRequest.uspConsent
+      }
+
+      if (bidderRequest && bidderRequest.refererInfo) {
+        let refererinfo = {
+          rd_ref: encodeURIComponent(bidderRequest.refererInfo.referer),
+          rd_top: bidderRequest.refererInfo.reachedTop,
+          rd_ifs: bidderRequest.refererInfo.numIframes,
+          rd_stk: bidderRequest.refererInfo.stack.map((url) => encodeURIComponent(url)).join(',')
+        };
+        payload.referrer_detection = refererinfo;
+      }
+
+      if (validBidRequests[0].userId) {
+        let eids = [];
+
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.flocId.id`), 'chrome.com', null);
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.criteoId`), 'criteo.com', null);
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.unifiedId`), 'thetradedesk.com', null);
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.id5Id`), 'id5.io', null);
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.sharedId`), 'thetradedesk.com', null);
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.identityLink`), 'liveramp.com', null);
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.liveIntentId`), 'liveintent.com', null);
+        addUserId(eids, utils.deepAccess(validBidRequests[0], `userId.fabrickId`), 'home.neustar', null);
+
+        if (eids.length) {
+          payload.eids = eids;
+        }
+      }
+
+      if (tags[0].publisher_id) {
+        payload.publisher_id = tags[0].publisher_id;
+      }
+
+      const ret = {
+        url: `${hostname}/auc/auc.php`,
+        method: 'POST',
+        options: {withCredentials: false},
+        data: {
+          v: $$PREBID_GLOBAL$$.version,
+          pageUrl: referer,
+          bidId: bidRequest.bidId,
+          auctionId: bidRequest.auctionId,
+          transactionId: bidRequest.transactionId,
+          adUnitCode: bidRequest.adUnitCode,
+          bidRequestCount: bidRequest.bidRequestCount,
+          sizes: bidRequest.sizes,
+          params: bidRequest.params,
+          pubext: payload
+        }
+      };
+      if (bidderRequest && bidderRequest.gdprConsent) {
+        ret.data.gdprConsent = {
+          consentString: bidderRequest.gdprConsent.consentString,
+          consentRequired: (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') && bidderRequest.gdprConsent.gdprApplies
+        };
+      }
+      return ret;
+    });
+  },
+
+  interpretResponse: function (serverResponse, { bidderRequest }) {
+    serverResponse = serverResponse.body;
+    const bids = [];
+    if (serverResponse.creatives.bids && serverResponse.placements) {
+      serverResponse.placements.forEach(serverBid => {
+        serverBid.creatives.forEach(creative => {
+          const bid = newBid(serverBid, creative, serverBid.placement_id, serverBid.uuid);
+          bid.mediaType = BANNER;
+          bids.push(bid);
+        });
+      });
+    }
+
+    return bids;
+  },
+};
+
+function newBid(serverBid, rtbBid, placementId, uuid) {
+  const bid = {
+    requestId: uuid,
+    cpm: rtbBid.cpm,
+    creativeId: rtbBid.creative_id,
+    currency: 'USD',
+    netRevenue: true,
+    ttl: 300,
+    adUnitCode: placementId
+  };
+
+  if (rtbBid.adomain) {
+    bid.meta = Object.assign({}, bid.meta, { advertiserDomains: [rtbBid.adomain] });
+  };
+
+  Object.assign(bid, {
+    width: rtbBid.width,
+    height: rtbBid.height,
+    ad: rtbBid.code
+  });
+
+  return bid;
+}
+
+// Functions related optional parameters
+function bidToTag(bid) {
+  const tag = {};
+  tag.sizes = transformSizes(bid.sizes);
+  tag.primary_size = tag.sizes[0];
+  tag.ad_types = [];
+  tag.uuid = bid.bidId;
+  if (bid.params.placementId) {
+    tag.id = parseInt(bid.params.placementId, 10);
+  } else {
+    tag.code = bid.params.invCode;
+  }
+  tag.allow_smaller_sizes = bid.params.allowSmallerSizes || false;
+  tag.use_pmt_rule = bid.params.usePaymentRule || false
+  tag.prebid = true;
+  tag.disable_psa = true;
+  let bidFloor = getBidFloor(bid);
+  if (bidFloor) {
+    tag.reserve = bidFloor;
+  }
+  if (bid.params.position) {
+    tag.position = {'above': 1, 'below': 2}[bid.params.position] || 0;
+  }
+  if (bid.params.trafficSourceCode) {
+    tag.traffic_source_code = bid.params.trafficSourceCode;
+  }
+  if (bid.params.privateSizes) {
+    tag.private_sizes = transformSizes(bid.params.privateSizes);
+  }
+  if (bid.params.supplyType) {
+    tag.supply_type = bid.params.supplyType;
+  }
+  if (bid.params.pubClick) {
+    tag.pubclick = bid.params.pubClick;
+  }
+  if (bid.params.extInvCode) {
+    tag.ext_inv_code = bid.params.extInvCode;
+  }
+  if (bid.params.publisherId) {
+    tag.publisher_id = parseInt(bid.params.publisherId, 10);
+  }
+  if (bid.params.externalImpId) {
+    tag.external_imp_id = bid.params.externalImpId;
+  }
+  if (!utils.isEmpty(bid.params.keywords)) {
+    let keywords = utils.transformBidderParamKeywords(bid.params.keywords);
+
+    if (keywords.length > 0) {
+      keywords.forEach(deleteValues);
+    }
+    tag.keywords = keywords;
+  }
+
+  let gpid = utils.deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
+  if (gpid) {
+    tag.gpid = gpid;
+  }
+
+  if (bid.renderer) {
+    tag.video = Object.assign({}, tag.video, {custom_renderer_present: true});
+  }
+
+  if (bid.params.frameworks && utils.isArray(bid.params.frameworks)) {
+    tag['banner_frameworks'] = bid.params.frameworks;
+  }
+
+  let adUnit = find(auctionManager.getAdUnits(), au => bid.transactionId === au.transactionId);
+  if (adUnit && adUnit.mediaTypes && adUnit.mediaTypes.banner) {
+    tag.ad_types.push(BANNER);
+  }
+
+  if (tag.ad_types.length === 0) {
+    delete tag.ad_types;
+  }
+
+  return tag;
+}
+
+function addUserId(eids, id, source, rti) {
+  if (id) {
+    if (rti) {
+      eids.push({source, id, rti_partner: rti});
+    } else {
+      eids.push({source, id});
+    }
+  }
+  return eids;
+}
+
+function hasUserInfo(bid) {
+  return !!bid.params.user;
+}
+
+function transformSizes(requestSizes) {
+  let sizes = [];
+  let sizeObj = {};
+
+  if (utils.isArray(requestSizes) && requestSizes.length === 2 &&
+            !utils.isArray(requestSizes[0])) {
+    sizeObj.width = parseInt(requestSizes[0], 10);
+    sizeObj.height = parseInt(requestSizes[1], 10);
+    sizes.push(sizeObj);
+  } else if (typeof requestSizes === 'object') {
+    for (let i = 0; i < requestSizes.length; i++) {
+      let size = requestSizes[i];
+      sizeObj = {};
+      sizeObj.width = parseInt(size[0], 10);
+      sizeObj.height = parseInt(size[1], 10);
+      sizes.push(sizeObj);
+    }
+  }
+
+  return sizes;
+}
+
+function getBidFloor(bid) {
+  if (!utils.isFn(bid.getFloor)) {
+    return (bid.params.reserve) ? bid.params.reserve : null;
+  }
+
+  let floor = bid.getFloor({
+    currency: 'USD',
+    mediaType: '*',
+    size: '*'
+  });
+  if (utils.isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === 'USD') {
+    return floor.floor;
+  }
+  return null;
+}
+
+function deleteValues(keyPairObj) {
+  if (isPopulatedArray(keyPairObj.value) && keyPairObj.value[0] === '') {
+    delete keyPairObj.value;
+  }
+}
+
+function isPopulatedArray(arr) {
+  return !!(utils.isArray(arr) && arr.length > 0);
+}
+
+registerBidder(spec);
diff --git a/modules/pixfutureBidAdapter.md b/modules/pixfutureBidAdapter.md
@@ -0,0 +1,27 @@
+# Overview
+
+```
+Module Name: PixFuture Bid Adapter
+Module Type: Bidder Adapter
+Maintainer: admin@pixfuture.net
+```
+# Description
+
+Module that connects to PixFuture demand sources
+
+# Test Parameters
+```
+var adUnits = [{
+    "bidderCode": "pixfuture",
+    "auctionId": "634c9d0e-306f-4a5c-974e-21697dfd4fcd",
+    "bidderRequestId": "5f85993da0f6be",
+    "bids": [
+        {
+            "labelAny": [
+                "display"
+            ],
+            "bidder": "pixfuture",
+            "params": {
+                "pix_id": "Abc123"
+            }];
+```