prebid.js 9.4.1 → 9.6.0

package/modules/symitriDapRtdProvider.md

@@ -0,0 +1,49 @@
+### Overview
+
+ Symitri DAP Real time data Provider automatically invokes the DAP APIs and submit audience segments and the SAID to the bid-stream.
+
+### Integration
+
+ 1) Build the symitriDapRTD module into the Prebid.js package with:
+
+ ```
+ gulp build --modules=symitriDapRtdProvider,...
+ ```
+
+ 2) Use `setConfig` to instruct Prebid.js to initilaize the symitriDapRtdProvider module, as specified below.
+
+### Configuration
+
+```
+ pbjs.setConfig({
+   realTimeData: {
+     auctionDelay: 2000,
+     dataProviders: [
+       {
+         name: "dap",
+         waitForIt: true,
+         params: {
+           apiHostname: '<see your Symitri account rep>',
+           apiVersion: "x1",
+           domain: 'your-domain.com',
+           identityType: 'email' | 'mobile' | ... | 'dap-signature:1.3.0',
+           segtax: 504,
+           dapEntropyUrl: 'https://sym-dist.symitri.net/dapentropy.js',
+           dapEntropyTimeout: 1500       // Maximum time for dapentropy to run
+         }
+       }
+     ]
+   }
+ });
+ ```
+
+Please reach out to your Symitri account representative(Prebid@symitri.com) to get provisioned on the DAP platform.
+
+
+### Testing
+To view an example of available segments returned by dap:
+```
+‘gulp serve --modules=rtdModule,symitriDapRtdProvider,appnexusBidAdapter,sovrnBidAdapter’
+```
+and then point your browser at:
+"http://localhost:9999/integrationExamples/gpt/symitridap_segments_example.html"

package/modules/targetVideoBidAdapter.js

@@ -1,24 +1,19 @@
-import {find} from '../src/polyfill.js';
-import {getBidRequest} from '../src/utils.js';
+import {_each, getDefinedParams, parseGPTSingleSizeArrayToRtbSize} from '../src/utils.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {formatRequest, getRtbBid, getSiteObj, videoBid, bannerBid, createVideoTag} from '../libraries/targetVideoUtils/bidderUtils.js';
+import {SOURCE, GVLID, BIDDER_CODE, VIDEO_PARAMS, BANNER_ENDPOINT_URL, VIDEO_ENDPOINT_URL, MARGIN, TIME_TO_LIVE} from '../libraries/targetVideoUtils/constants.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
  * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
  */
 
-const SOURCE = 'pbjs';
-const BIDDER_CODE = 'targetVideo';
-const ENDPOINT_URL = 'https://ib.adnxs.com/ut/v3/prebid';
-const MARGIN = 1.35;
-const GVLID = 786;
-
 export const spec = {
 
   code: BIDDER_CODE,
   gvlid: GVLID,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
 
   /**
    * Determines whether or not the given bid request is valid.
@@ -37,35 +32,114 @@ export const spec = {
    * @return ServerRequest Info describing the request to the server.
    */
   buildRequests: function(bidRequests, bidderRequest) {
-    const tags = bidRequests.map(createVideoTag);
-    const schain = bidRequests[0].schain;
-    const payload = {
-      tags: tags,
-      sdk: {
-        source: SOURCE,
-        version: '$prebid.version$'
-      },
-      schain: schain
+    const requests = [];
+    const sdk = {
+      source: SOURCE,
+      version: '$prebid.version$'
     };
 
-    if (bidderRequest && bidderRequest.gdprConsent) {
-      payload.gdpr_consent = {
-        consent_string: bidderRequest.gdprConsent.consentString,
-        consent_required: bidderRequest.gdprConsent.gdprApplies
-      };
-
-      if (bidderRequest.gdprConsent.addtlConsent && bidderRequest.gdprConsent.addtlConsent.indexOf('~') !== -1) {
-        let ac = bidderRequest.gdprConsent.addtlConsent;
-        let acStr = ac.substring(ac.indexOf('~') + 1);
-        payload.gdpr_consent.addtl_consent = acStr.split('.').map(id => parseInt(id, 10));
+    for (let {params, bidId, sizes, mediaTypes} of bidRequests) {
+      for (const mediaType in mediaTypes) {
+        switch (mediaType) {
+          case VIDEO: {
+            const video = mediaTypes[VIDEO];
+            const placementId = params.placementId;
+            const site = getSiteObj();
+
+            if (sizes && !Array.isArray(sizes[0])) sizes = [sizes];
+
+            const payload = {
+              sdk,
+              id: bidderRequest.bidderRequestId,
+              site,
+              imp: []
+            }
+
+            const imp = {
+              ext: {
+                prebid: {
+                  storedrequest: { id: placementId }
+                }
+              },
+              video: getDefinedParams(video, VIDEO_PARAMS)
+            }
+
+            if (video.playerSize) {
+              imp.video = Object.assign(
+                imp.video, parseGPTSingleSizeArrayToRtbSize(video.playerSize[0]) || {}
+              );
+            } else if (video.w && video.h) {
+              imp.video.w = video.w;
+              imp.video.h = video.h;
+            }
+
+            payload.imp.push(imp);
+
+            const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
+            const uspConsent = bidderRequest && bidderRequest.uspConsent;
+
+            if (gdprConsent || uspConsent) {
+              payload.regs = { ext: {} };
+
+              if (uspConsent) {
+                payload.regs.ext.us_privacy = uspConsent;
+              };
+
+              if (gdprConsent) {
+                if (typeof gdprConsent.gdprApplies !== 'undefined') {
+                  payload.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
+                };
+
+                if (typeof gdprConsent.consentString !== 'undefined') {
+                  payload.user = {
+                    ext: { consent: gdprConsent.consentString }
+                  };
+                };
+              };
+            };
+
+            if (bidRequests[0].schain) {
+              payload.schain = bidRequests[0].schain;
+            }
+
+            requests.push(formatRequest({ payload, url: VIDEO_ENDPOINT_URL, bidId }));
+            break;
+          }
+
+          case BANNER: {
+            const tags = bidRequests.map(createVideoTag);
+            const schain = bidRequests[0].schain;
+
+            const payload = {
+              tags,
+              sdk,
+              schain,
+            };
+
+            if (bidderRequest && bidderRequest.gdprConsent) {
+              payload.gdpr_consent = {
+                consent_string: bidderRequest.gdprConsent.consentString,
+                consent_required: bidderRequest.gdprConsent.gdprApplies
+              };
+
+              if (bidderRequest.gdprConsent.addtlConsent && bidderRequest.gdprConsent.addtlConsent.indexOf('~') !== -1) {
+                let ac = bidderRequest.gdprConsent.addtlConsent;
+                let acStr = ac.substring(ac.indexOf('~') + 1);
+                payload.gdpr_consent.addtl_consent = acStr.split('.').map(id => parseInt(id, 10));
+              }
+            }
+
+            if (bidderRequest && bidderRequest.uspConsent) {
+              payload.us_privacy = bidderRequest.uspConsent
+            }
+
+            return formatRequest({ payload, url: BANNER_ENDPOINT_URL, bidderRequest });
+          }
+        }
       }
     }
 
-    if (bidderRequest && bidderRequest.uspConsent) {
-      payload.us_privacy = bidderRequest.uspConsent
-    }
-
-    return formatRequest(payload, bidderRequest);
+    return requests;
   },
 
   /**
@@ -74,139 +148,33 @@ export const spec = {
    * @param {*} serverResponse A successful response from the server.
    * @return {Bid[]} An array of bids which were nested inside the server.
    */
-  interpretResponse: function(serverResponse, { bidderRequest }) {
+  interpretResponse: function(serverResponse, { bidderRequest, ...bidRequest }) {
     serverResponse = serverResponse.body;
+    const currency = serverResponse.cur;
     const bids = [];
 
     if (serverResponse.tags) {
       serverResponse.tags.forEach(serverBid => {
         const rtbBid = getRtbBid(serverBid);
         if (rtbBid && rtbBid.cpm !== 0 && rtbBid.ad_type == VIDEO) {
-          bids.push(newBid(serverBid, rtbBid, bidderRequest));
+          bids.push(bannerBid(serverBid, rtbBid, bidderRequest, MARGIN));
         }
       });
     }
 
-    return bids;
-  }
-
-}
-
-function getSizes(request) {
-  let sizes = request.sizes;
-  if (!sizes && request.mediaTypes && request.mediaTypes.banner && request.mediaTypes.banner.sizes) {
-    sizes = request.mediaTypes.banner.sizes;
-  }
-  if (Array.isArray(sizes) && !Array.isArray(sizes[0])) {
-    sizes = [sizes[0], sizes[1]];
-  }
-  if (!Array.isArray(sizes) || !Array.isArray(sizes[0])) {
-    sizes = [[0, 0]];
-  }
-
-  return sizes;
-}
+    if (serverResponse.seatbid) {
+      _each(serverResponse.seatbid, (resp) => {
+        _each(resp.bid, (bid) => {
+          const requestId = bidRequest.bidId;
+          const params = bidRequest.params;
 
-function formatRequest(payload, bidderRequest) {
-  const options = {
-    withCredentials: true
-  };
-  const request = {
-    method: 'POST',
-    url: ENDPOINT_URL,
-    data: JSON.stringify(payload),
-    bidderRequest,
-    options
-  };
-
-  return request;
-}
-
-/**
- * Create video auction.
- *
- * @param {*} serverResponse A successful response from the server.
- * @return {Bid[]} An array of bids which were nested inside the server.
- */
-function createVideoTag(bid) {
-  const tag = {};
-  tag.id = parseInt(bid.params.placementId, 10);
-  tag.gpid = 'targetVideo';
-  tag.sizes = getSizes(bid);
-  tag.primary_size = tag.sizes[0];
-  tag.ad_types = [VIDEO];
-  tag.uuid = bid.bidId;
-  tag.allow_smaller_sizes = false;
-  tag.use_pmt_rule = false;
-  tag.prebid = true;
-  tag.disable_psa = true;
-  tag.hb_source = 1;
-  tag.require_asset_url = true;
-  tag.video = {
-    playback_method: 2,
-    skippable: true
-  };
-
-  return tag;
-}
-
-/**
- * Unpack the Server's Bid into a Prebid-compatible one.
- * @param serverBid
- * @param rtbBid
- * @param bidderRequest
- * @return Bid
- */
-function newBid(serverBid, rtbBid, bidderRequest) {
-  const bidRequest = getBidRequest(serverBid.uuid, [bidderRequest]);
-  const sizes = getSizes(bidRequest);
-  const bid = {
-    requestId: serverBid.uuid,
-    cpm: rtbBid.cpm / MARGIN,
-    creativeId: rtbBid.creative_id,
-    dealId: rtbBid.deal_id,
-    currency: 'USD',
-    netRevenue: true,
-    width: sizes[0][0],
-    height: sizes[0][1],
-    ttl: 300,
-    adUnitCode: bidRequest.adUnitCode,
-    appnexus: {
-      buyerMemberId: rtbBid.buyer_member_id,
-      dealPriority: rtbBid.deal_priority,
-      dealCode: rtbBid.deal_code
+          bids.push(videoBid(bid, requestId, currency, params, TIME_TO_LIVE));
+        });
+      });
     }
-  };
-
-  if (rtbBid.rtb.video) {
-    Object.assign(bid, {
-      vastImpUrl: rtbBid.notify_url,
-      ad: getBannerHtml(rtbBid.notify_url + '&redir=' + encodeURIComponent(rtbBid.rtb.video.asset_url)),
-      ttl: 3600
-    });
-  }
-
-  return bid;
-}
 
-function getRtbBid(tag) {
-  return tag && tag.ads && tag.ads.length && find(tag.ads, ad => ad.rtb);
-}
-
-function getBannerHtml(vastUrl) {
-  return `<!DOCTYPE html>
-    <html lang="en">
-    <head>
-      <meta charset="UTF-8">
-      <title></title>
-      <style>html, body {width: 100%; height: 100%; margin: 0;}</style>
-    </head>
-    <body>
-      <div id="targetVideoPlayer"></div>
-      <script src="https://player.target-video.com/custom/targetvideo-banner.js"></script>
-      <script>initPlayer("${vastUrl}");</script>
-    </body>
-  </html>`;
+    return bids;
+  }
 }
 
 registerBidder(spec);

package/modules/targetVideoBidAdapter.md

@@ -3,17 +3,17 @@
 ```
 Module Name:  Target Video Bid Adapter
 Module Type:  Bidder Adapter
-Maintainer:   grajzer@gmail.com
+Maintainers:   grajzer@gmail.com, danijel.ristic@target-video.com
 ```
 
 # Description
 
 Connects to Appnexus exchange for bids.
 
-TargetVideo bid adapter supports Banner.
+TargetVideo bid adapter supports Banner and Video.
 
 # Test Parameters
-```
+```js
 var adUnits = [
   // Banner adUnit
   {
@@ -29,6 +29,23 @@ var adUnits = [
               placementId: 13232361
           }
       }]
+  },
+  // Video adUnit
+  {
+    mediaTypes: {
+        video: {
+            playerSize: [[640, 360]],
+            context: 'instream',
+            playbackmethod: [1, 2, 3, 4]
+        }
+    },
+    bids: [{
+        bidder: 'targetVideo',
+        params: {
+            placementId: 12345,
+            reserve: 0,
+        }
+    }]
   }
 ];
 ```

package/modules/telariaBidAdapter.js

@@ -1,6 +1,7 @@
 import { logError, isEmpty, deepAccess, triggerPixel, logWarn, isArray } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {VIDEO} from '../src/mediaTypes.js';
+import {getSupplyChain} from '../libraries/riseUtils/index.js';
 
 const BIDDER_CODE = 'telaria';
 const DOMAIN = 'tremorhub.com';
@@ -127,37 +128,6 @@ function getDefaultSrcPageUrl() {
   return encodeURIComponent(document.location.href);
 }
 
-function getEncodedValIfNotEmpty(val) {
-  return (val !== '' && val !== undefined) ? encodeURIComponent(val) : '';
-}
-
-/**
- * Converts the schain object to a url param value. Please refer to
- * https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md
- * (schain for non ORTB section) for more information
- * @param schainObject
- * @returns {string}
- */
-function getSupplyChainAsUrlParam(schainObject) {
-  if (isEmpty(schainObject)) {
-    return '';
-  }
-
-  let scStr = `&schain=${schainObject.ver},${schainObject.complete}`;
-
-  schainObject.nodes.forEach((node) => {
-    scStr += '!';
-    scStr += `${getEncodedValIfNotEmpty(node.asi)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.sid)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.hp)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.rid)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.name)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.domain)}`;
-  });
-
-  return scStr;
-}
-
 function getUrlParams(params, schainFromBidRequest) {
   let urlSuffix = '';
 
@@ -167,7 +137,7 @@ function getUrlParams(params, schainFromBidRequest) {
         urlSuffix += `&${key}=${params[key]}`;
       }
     }
-    urlSuffix += getSupplyChainAsUrlParam(!isEmpty(schainFromBidRequest) ? schainFromBidRequest : params['schain']);
+    urlSuffix += getSupplyChain(!isEmpty(schainFromBidRequest) ? schainFromBidRequest : params['schain']);
   }
 
   return urlSuffix;