prebid.js 7.8.0 → 7.9.0

package/modules/c1xBidAdapter.js

@@ -0,0 +1,209 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { logInfo, logError } from '../src/utils.js';
+import { BANNER } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'c1x';
+const URL = 'https://hb-stg.c1exchange.com/ht';
+// const PIXEL_ENDPOINT = '//px.c1exchange.com/pubpixel/';
+const LOG_MSG = {
+  invalidBid: 'C1X: [ERROR] bidder returns an invalid bid',
+  noSite: 'C1X: [ERROR] no site id supplied',
+  noBid: 'C1X: [INFO] creating a NO bid for Adunit: ',
+  bidWin: 'C1X: [INFO] creating a bid for Adunit: '
+};
+
+/**
+ * Adapter for requesting bids from C1X header tag server.
+ * v3.1 (c) C1X Inc., 2018
+ */
+
+export const c1xAdapter = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {object} bid The bid to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  // check the bids sent to c1x bidder
+  isBidRequestValid: function (bid) {
+    if (bid.bidder !== BIDDER_CODE || typeof bid.params === 'undefined') {
+      return false;
+    }
+    if (typeof bid.params.placementId === 'undefined') {
+      return false;
+    }
+    return true;
+  },
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {BidRequest[]} validBidRequests A non-empty list of valid bid requests that should be sent to the Server.
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function (validBidRequests, bidderRequest) {
+    let payload = {};
+    let tagObj = {};
+    let bidRequest = [];
+    const adunits = validBidRequests.length;
+    const rnd = new Date().getTime();
+    const c1xTags = validBidRequests.map(bidToTag);
+    const bidIdTags = validBidRequests.map(bidToShortTag); // include only adUnitCode and bidId from request obj
+
+    // flattened tags in a tag object
+    tagObj = c1xTags.reduce((current, next) => Object.assign(current, next));
+
+    payload = {
+      adunits: adunits.toString(),
+      rnd: rnd.toString(),
+      response: 'json',
+      compress: 'gzip'
+    };
+
+    // for GDPR support
+    if (bidderRequest && bidderRequest.gdprConsent) {
+      payload['consent_string'] = bidderRequest.gdprConsent.consentString;
+      payload['consent_required'] = (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') ? bidderRequest.gdprConsent.gdprApplies.toString() : 'true'
+      ;
+    }
+
+    Object.assign(payload, tagObj);
+    let payloadString = stringifyPayload(payload);
+    // ServerRequest object
+    bidRequest.push({
+      method: 'GET',
+      url: URL,
+      data: payloadString,
+      bids: bidIdTags
+    })
+    return bidRequest;
+  },
+
+  interpretResponse: function (serverResponse, requests) {
+    serverResponse = serverResponse.body;
+    requests = requests.bids || [];
+    const currency = 'USD';
+    const bidResponses = [];
+    let netRevenue = false;
+
+    if (!serverResponse || serverResponse.error) {
+      let errorMessage = serverResponse.error;
+      logError(LOG_MSG.invalidBid + errorMessage);
+      return bidResponses;
+    } else {
+      serverResponse.forEach(bid => {
+        logInfo(bid)
+        if (bid.bid) {
+          if (bid.bidType === 'NET_BID') {
+            netRevenue = !netRevenue;
+          }
+          const curBid = {
+            requestId: bid.bidId,
+            width: bid.width,
+            height: bid.height,
+            cpm: bid.cpm,
+            ad: bid.ad,
+            creativeId: bid.crid,
+            currency: currency,
+            ttl: 300,
+            netRevenue: netRevenue
+          };
+
+          if (bid.dealId) {
+            curBid['dealId'] = bid.dealId
+          }
+
+          for (let i = 0; i < requests.length; i++) {
+            if (bid.adId === requests[i].adUnitCode) {
+              curBid.requestId = requests[i].bidId;
+            }
+          }
+          logInfo(LOG_MSG.bidWin + bid.adId + ' size: ' + curBid.width + 'x' + curBid.height);
+          bidResponses.push(curBid);
+        } else {
+          // no bid
+          logInfo(LOG_MSG.noBid + bid.adId);
+        }
+      });
+    }
+
+    return bidResponses;
+  }
+
+}
+
+function bidToTag(bid, index) {
+  const tag = {};
+  const adIndex = 'a' + (index + 1).toString(); // ad unit id for c1x
+  const sizeKey = adIndex + 's';
+  const priceKey = adIndex + 'p';
+  const dealKey = adIndex + 'd';
+  // TODO: Multiple Floor Prices
+
+  const sizesArr = bid.sizes;
+  const floorPriceMap = getBidFloor(bid);
+
+  const dealId = bid.params.dealId || '';
+
+  if (dealId) {
+    tag[dealKey] = dealId;
+  }
+
+  tag[adIndex] = bid.adUnitCode;
+  tag[sizeKey] = sizesArr.reduce((prev, current) => prev + (prev === '' ? '' : ',') + current.join('x'), '');
+  const newSizeArr = tag[sizeKey].split(',');
+  if (floorPriceMap) {
+    newSizeArr.forEach(size => {
+      if (size in floorPriceMap) {
+        tag[priceKey] = floorPriceMap[size].toString();
+      } // we only accept one cpm price in floorPriceMap
+    });
+  }
+  if (bid.params.pageurl) {
+    tag['pageurl'] = bid.params.pageurl;
+  }
+
+  return tag;
+}
+
+function getBidFloor(bidRequest) {
+  let floorInfo = {};
+
+  if (typeof bidRequest.getFloor === 'function') {
+    floorInfo = bidRequest.getFloor({
+      currency: 'USD',
+      mediaType: 'banner',
+      size: '*',
+    });
+  }
+
+  let floor =
+    floorInfo.floor ||
+    bidRequest.params.bidfloor ||
+    bidRequest.params.floorPriceMap ||
+    0;
+
+  return floor;
+}
+
+function bidToShortTag(bid) {
+  const tag = {};
+  tag.adUnitCode = bid.adUnitCode;
+  tag.bidId = bid.bidId;
+  return tag;
+}
+
+function stringifyPayload(payload) {
+  let payloadString = [];
+  for (var key in payload) {
+    if (payload.hasOwnProperty(key)) {
+      payloadString.push(key + '=' + payload[key]);
+    }
+  }
+  return payloadString.join('&');
+}
+
+registerBidder(c1xAdapter);

package/modules/c1xBidAdapter.md

@@ -0,0 +1,70 @@
+# Overview
+
+Module Name: C1X Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: vishnu@c1exchange.com
+
+# Description
+
+Module that connects to C1X's demand sources
+
+# Test Parameters
+```
+  var adUnits = [{
+    code: 'test-div-1',
+    mediaTypes: {
+        banner: {
+            sizes: [[750, 200]],
+        }
+    },
+    bids: [{
+        bidder: 'c1x',
+        params: {
+            placementId: 'div-gpt-ad-1654594619717-0',
+            'floorPriceMap': {
+                    '300x250': 4.35
+            }
+        }
+    }]
+  }, {
+    code: 'test-div-2',
+    mediaTypes: {
+        banner: {
+            sizes: [[300, 250], [750, 200]],
+        }
+    },
+    bids: [{
+        bidder: 'c1x',
+        params: {
+            placementId: 'div-gpt-ad-1654940683355-0',
+            'floorPriceMap': {
+                    '300x250': 4.35
+            }
+            dealId: '1233' // optional parameter
+        }
+    }]
+  }];
+
+
+  pbjs.bidderSettings = {
+    c1x: {
+      siteId: 999,
+      adserverTargeting: [{
+          key: "hb_bidder",
+          val: function(bidResponse) {
+              return bidResponse.bidderCode;
+          }
+      }, {
+          key: "hb_adid",
+          val: function(bidResponse) {
+              return bidResponse.adId;
+          }
+      }, {
+          key: "hb_pb",
+          val: function(bidResponse) {
+              return bidResponse.pbLg;
+          }
+      }]
+    }
+  }
+```

package/modules/improvedigitalBidAdapter.js

@@ -434,6 +434,9 @@ const ID_REQUEST = {
       return null;
     }
     const request = {
+      eventtrackers: [
+        {event: 1, methods: [1, 2]}
+      ],
       assets: [],
     }
     for (let i of Object.keys(nativeParams)) {

package/modules/tripleliftBidAdapter.js

@@ -8,7 +8,7 @@ const GVLID = 28;
 const BIDDER_CODE = 'triplelift';
 const STR_ENDPOINT = 'https://tlx.3lift.com/header/auction?';
 const BANNER_TIME_TO_LIVE = 300;
-const INSTREAM_TIME_TO_LIVE = 3600;
+const VIDEO_TIME_TO_LIVE = 3600;
 let gdprApplies = true;
 let consentString = null;
 export const storage = getStorageManager({gvlid: GVLID, bidderCode: BIDDER_CODE});
@@ -120,12 +120,15 @@ function _buildPostBody(bidRequests, bidderRequest) {
       tagid: bidRequest.params.inventoryCode,
       floor: _getFloor(bidRequest)
     };
-    // remove the else to support multi-imp
-    if (_isInstreamBidRequest(bidRequest)) {
+    // Check for video bidrequest
+    if (_isVideoBidRequest(bidRequest)) {
       imp.video = _getORTBVideo(bidRequest);
-    } else if (bidRequest.mediaTypes.banner) {
+    }
+    // append banner if applicable and request is not for instream
+    if (bidRequest.mediaTypes.banner && !_isInstream(bidRequest)) {
       imp.banner = { format: _sizes(bidRequest.sizes) };
-    };
+    }
+
     if (!isEmpty(bidRequest.ortb2Imp)) {
       imp.fpd = _getAdUnitFpd(bidRequest.ortb2Imp);
     }
@@ -153,22 +156,41 @@ function _buildPostBody(bidRequests, bidderRequest) {
   return data;
 }
 
-function _isInstreamBidRequest(bidRequest) {
-  if (!bidRequest.mediaTypes.video) return false;
-  if (!bidRequest.mediaTypes.video.context) return false;
-  if (bidRequest.mediaTypes.video.context.toLowerCase() === 'instream') {
-    return true;
-  } else {
-    return false;
-  }
+function _isVideoBidRequest(bidRequest) {
+  return _isValidVideoObject(bidRequest) && (_isInstream(bidRequest) || _isOutstream(bidRequest));
+}
+
+function _isOutstream(bidRequest) {
+  return _isValidVideoObject(bidRequest) && bidRequest.mediaTypes.video.context.toLowerCase() === 'outstream';
+}
+
+function _isInstream(bidRequest) {
+  return _isValidVideoObject(bidRequest) && bidRequest.mediaTypes.video.context.toLowerCase() === 'instream';
+}
+
+function _isValidVideoObject(bidRequest) {
+  return bidRequest.mediaTypes.video && bidRequest.mediaTypes.video.context;
 }
 
 function _getORTBVideo(bidRequest) {
   // give precedent to mediaTypes.video
   let video = { ...bidRequest.params.video, ...bidRequest.mediaTypes.video };
-  if (!video.w) video.w = video.playerSize[0][0];
-  if (!video.h) video.h = video.playerSize[0][1];
+  try {
+    if (!video.w) video.w = video.playerSize[0][0];
+    if (!video.h) video.h = video.playerSize[0][1];
+  } catch (err) {
+    logWarn('Video size not defined', err);
+  }
   if (video.context === 'instream') video.placement = 1;
+  if (video.context === 'outstream') {
+    if (!video.placement) {
+      video.placement = 3
+    } else if ([3, 4, 5].indexOf(video.placement) === -1) {
+      logMessage(`video.placement value of ${video.placement} is invalid for outstream context. Setting placement to 3`)
+      video.placement = 3
+    }
+  }
+
   // clean up oRTB object
   delete video.playerSize;
   return video;
@@ -180,7 +202,7 @@ function _getFloor (bid) {
     try {
       const floorInfo = bid.getFloor({
         currency: 'USD',
-        mediaType: _isInstreamBidRequest(bid) ? 'video' : 'banner',
+        mediaType: _isVideoBidRequest(bid) ? 'video' : 'banner',
         size: '*'
       });
       if (typeof floorInfo === 'object' &&
@@ -366,10 +388,10 @@ function _buildResponseObject(bidderRequest, bid) {
       meta: {}
     };
 
-    if (_isInstreamBidRequest(breq)) {
+    if (_isVideoBidRequest(breq) && bid.media_type === 'video') {
       bidResponse.vastXml = bid.ad;
       bidResponse.mediaType = 'video';
-      bidResponse.ttl = INSTREAM_TIME_TO_LIVE;
+      bidResponse.ttl = VIDEO_TIME_TO_LIVE;
     };
 
     if (bid.advertiser_name) {
@@ -381,7 +403,11 @@ function _buildResponseObject(bidderRequest, bid) {
     }
 
     if (bid.tl_source && bid.tl_source == 'hdx') {
-      bidResponse.meta.mediaType = 'banner';
+      if (_isVideoBidRequest(breq) && bid.media_type === 'video') {
+        bidResponse.meta.mediaType = 'video'
+      } else {
+        bidResponse.meta.mediaType = 'banner'
+      }
     }
 
     if (bid.tl_source && bid.tl_source == 'tlx') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.8.0",
+  "version": "7.9.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {