prebid.js 7.3.0 → 7.6.0

package/modules/shinezBidAdapter.js

@@ -0,0 +1,435 @@
+import { logWarn, logInfo, isArray, isFn, deepAccess, isEmpty, contains, timestamp, getBidIdParameter, triggerPixel, isInteger } from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import {config} from '../src/config.js';
+
+const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
+const BIDDER_CODE = 'shinez';
+const ADAPTER_VERSION = '1.0.0';
+const TTL = 360;
+const CURRENCY = 'USD';
+const SELLER_ENDPOINT = 'https://hb.sweetgum.io/';
+const MODES = {
+  PRODUCTION: 'hb-sz-multi',
+  TEST: 'hb-multi-sz-test'
+}
+const SUPPORTED_SYNC_METHODS = {
+  IFRAME: 'iframe',
+  PIXEL: 'pixel'
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  version: ADAPTER_VERSION,
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+  isBidRequestValid: function (bidRequest) {
+    if (!bidRequest.params) {
+      logWarn('no params have been set to Shinez adapter');
+      return false;
+    }
+
+    if (!bidRequest.params.org) {
+      logWarn('org is a mandatory param for Shinez adapter');
+      return false;
+    }
+
+    return true;
+  },
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const combinedRequestsObject = {};
+
+    // use data from the first bid, to create the general params for all bids
+    const generalObject = validBidRequests[0];
+    const testMode = generalObject.params.testMode;
+
+    combinedRequestsObject.params = generateGeneralParams(generalObject, bidderRequest);
+    combinedRequestsObject.bids = generateBidsParams(validBidRequests, bidderRequest);
+
+    return {
+      method: 'POST',
+      url: getEndpoint(testMode),
+      data: combinedRequestsObject
+    }
+  },
+  interpretResponse: function ({body}) {
+    const bidResponses = [];
+
+    if (body.bids) {
+      body.bids.forEach(adUnit => {
+        const bidResponse = {
+          requestId: adUnit.requestId,
+          cpm: adUnit.cpm,
+          currency: adUnit.currency || CURRENCY,
+          width: adUnit.width,
+          height: adUnit.height,
+          ttl: adUnit.ttl || TTL,
+          creativeId: adUnit.requestId,
+          netRevenue: adUnit.netRevenue || true,
+          nurl: adUnit.nurl,
+          mediaType: adUnit.mediaType,
+          meta: {
+            mediaType: adUnit.mediaType
+          }
+        };
+
+        if (adUnit.mediaType === VIDEO) {
+          bidResponse.vastXml = adUnit.vastXml;
+        } else if (adUnit.mediaType === BANNER) {
+          bidResponse.ad = adUnit.ad;
+        }
+
+        if (adUnit.adomain && adUnit.adomain.length) {
+          bidResponse.meta.advertiserDomains = adUnit.adomain;
+        }
+
+        bidResponses.push(bidResponse);
+      });
+    }
+
+    return bidResponses;
+  },
+  getUserSyncs: function (syncOptions, serverResponses) {
+    const syncs = [];
+    for (const response of serverResponses) {
+      if (syncOptions.iframeEnabled && response.body.params.userSyncURL) {
+        syncs.push({
+          type: 'iframe',
+          url: response.body.params.userSyncURL
+        });
+      }
+      if (syncOptions.pixelEnabled && isArray(response.body.params.userSyncPixels)) {
+        const pixels = response.body.params.userSyncPixels.map(pixel => {
+          return {
+            type: 'image',
+            url: pixel
+          }
+        })
+        syncs.push(...pixels)
+      }
+    }
+    return syncs;
+  },
+  onBidWon: function (bid) {
+    if (bid == null) {
+      return;
+    }
+
+    logInfo('onBidWon:', bid);
+    if (bid.hasOwnProperty('nurl') && bid.nurl.length > 0) {
+      triggerPixel(bid.nurl);
+    }
+  }
+};
+
+registerBidder(spec);
+
+/**
+ * Get floor price
+ * @param bid {bid}
+ * @returns {Number}
+ */
+function getFloor(bid, mediaType) {
+  if (!isFn(bid.getFloor)) {
+    return 0;
+  }
+  let floorResult = bid.getFloor({
+    currency: CURRENCY,
+    mediaType: mediaType,
+    size: '*'
+  });
+  return floorResult.currency === CURRENCY && floorResult.floor ? floorResult.floor : 0;
+}
+
+/**
+ * Get the the ad sizes array from the bid
+ * @param bid {bid}
+ * @returns {Array}
+ */
+function getSizesArray(bid, mediaType) {
+  let sizesArray = []
+
+  if (deepAccess(bid, `mediaTypes.${mediaType}.sizes`)) {
+    sizesArray = bid.mediaTypes[mediaType].sizes;
+  } else if (Array.isArray(bid.sizes) && bid.sizes.length > 0) {
+    sizesArray = bid.sizes;
+  }
+
+  return sizesArray;
+}
+
+/**
+ * Get schain string value
+ * @param schainObject {Object}
+ * @returns {string}
+ */
+function getSupplyChain(schainObject) {
+  if (isEmpty(schainObject)) {
+    return '';
+  }
+  let scStr = `${schainObject.ver},${schainObject.complete}`;
+  schainObject.nodes.forEach((node) => {
+    scStr += '!';
+    scStr += `${getEncodedValIfNotEmpty(node.asi)},`;
+    scStr += `${getEncodedValIfNotEmpty(node.sid)},`;
+    scStr += `${node.hp ? encodeURIComponent(node.hp) : ''},`;
+    scStr += `${getEncodedValIfNotEmpty(node.rid)},`;
+    scStr += `${getEncodedValIfNotEmpty(node.name)},`;
+    scStr += `${getEncodedValIfNotEmpty(node.domain)}`;
+  });
+  return scStr;
+}
+
+/**
+ * Get encoded node value
+ * @param val {string}
+ * @returns {string}
+ */
+function getEncodedValIfNotEmpty(val) {
+  return !isEmpty(val) ? encodeURIComponent(val) : '';
+}
+
+/**
+ * Get preferred user-sync method based on publisher configuration
+ * @param bidderCode {string}
+ * @returns {string}
+ */
+function getAllowedSyncMethod(filterSettings, bidderCode) {
+  const iframeConfigsToCheck = ['all', 'iframe'];
+  const pixelConfigToCheck = 'image';
+  if (filterSettings && iframeConfigsToCheck.some(config => isSyncMethodAllowed(filterSettings[config], bidderCode))) {
+    return SUPPORTED_SYNC_METHODS.IFRAME;
+  }
+  if (!filterSettings || !filterSettings[pixelConfigToCheck] || isSyncMethodAllowed(filterSettings[pixelConfigToCheck], bidderCode)) {
+    return SUPPORTED_SYNC_METHODS.PIXEL;
+  }
+}
+
+/**
+ * Check if sync rule is supported
+ * @param syncRule {Object}
+ * @param bidderCode {string}
+ * @returns {boolean}
+ */
+function isSyncMethodAllowed(syncRule, bidderCode) {
+  if (!syncRule) {
+    return false;
+  }
+  const isInclude = syncRule.filter === 'include';
+  const bidders = isArray(syncRule.bidders) ? syncRule.bidders : [bidderCode];
+  return isInclude && contains(bidders, bidderCode);
+}
+
+/**
+ * Get the seller endpoint
+ * @param testMode {boolean}
+ * @returns {string}
+ */
+function getEndpoint(testMode) {
+  return testMode
+    ? SELLER_ENDPOINT + MODES.TEST
+    : SELLER_ENDPOINT + MODES.PRODUCTION;
+}
+
+/**
+ * get device type
+ * @param uad {ua}
+ * @returns {string}
+ */
+function getDeviceType(ua) {
+  if (/ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle/i
+    .test(ua.toLowerCase())) {
+    return '5';
+  }
+  if (/iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i
+    .test(ua.toLowerCase())) {
+    return '4';
+  }
+  if (/smart[-_\s]?tv|hbbtv|appletv|googletv|hdmi|netcast|viera|nettv|roku|\bdtv\b|sonydtv|inettvbrowser|\btv\b/i
+    .test(ua.toLowerCase())) {
+    return '3';
+  }
+  return '1';
+}
+
+function generateBidsParams(validBidRequests, bidderRequest) {
+  const bidsArray = [];
+
+  if (validBidRequests.length) {
+    validBidRequests.forEach(bid => {
+      bidsArray.push(generateBidParameters(bid, bidderRequest));
+    });
+  }
+
+  return bidsArray;
+}
+
+/**
+ * Generate bid specific parameters
+ * @param {bid} bid
+ * @param {bidderRequest} bidderRequest
+ * @returns {Object} bid specific params object
+ */
+function generateBidParameters(bid, bidderRequest) {
+  const {params} = bid;
+  const mediaType = isBanner(bid) ? BANNER : VIDEO;
+  const sizesArray = getSizesArray(bid, mediaType);
+
+  // fix floor price in case of NAN
+  if (isNaN(params.floorPrice)) {
+    params.floorPrice = 0;
+  }
+
+  const bidObject = {
+    mediaType,
+    adUnitCode: getBidIdParameter('adUnitCode', bid),
+    sizes: sizesArray,
+    floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
+    bidId: getBidIdParameter('bidId', bid),
+    bidderRequestId: getBidIdParameter('bidderRequestId', bid),
+    transactionId: getBidIdParameter('transactionId', bid),
+  };
+
+  const pos = deepAccess(bid, `mediaTypes.${mediaType}.pos`);
+  if (pos) {
+    bidObject.pos = pos;
+  }
+
+  const gpid = deepAccess(bid, `ortb2Imp.ext.gpid`);
+  if (gpid) {
+    bidObject.gpid = gpid;
+  }
+
+  const placementId = params.placementId || deepAccess(bid, `mediaTypes.${mediaType}.name`);
+  if (placementId) {
+    bidObject.placementId = placementId;
+  }
+
+  if (mediaType === VIDEO) {
+    const playbackMethod = deepAccess(bid, `mediaTypes.video.playbackmethod`);
+    let playbackMethodValue;
+
+    // verify playbackMethod is of type integer array, or integer only.
+    if (Array.isArray(playbackMethod) && isInteger(playbackMethod[0])) {
+      // only the first playbackMethod in the array will be used, according to OpenRTB 2.5 recommendation
+      playbackMethodValue = playbackMethod[0];
+    } else if (isInteger(playbackMethod)) {
+      playbackMethodValue = playbackMethod;
+    }
+
+    if (playbackMethodValue) {
+      bidObject.playbackMethod = playbackMethodValue;
+    }
+
+    const placement = deepAccess(bid, `mediaTypes.video.placement`);
+    if (placement) {
+      bidObject.placement = placement;
+    }
+
+    const minDuration = deepAccess(bid, `mediaTypes.video.minduration`);
+    if (minDuration) {
+      bidObject.minDuration = minDuration;
+    }
+
+    const maxDuration = deepAccess(bid, `mediaTypes.video.maxduration`);
+    if (maxDuration) {
+      bidObject.maxDuration = maxDuration;
+    }
+
+    const skip = deepAccess(bid, `mediaTypes.video.skip`);
+    if (skip) {
+      bidObject.skip = skip;
+    }
+
+    const linearity = deepAccess(bid, `mediaTypes.video.linearity`);
+    if (linearity) {
+      bidObject.linearity = linearity;
+    }
+  }
+
+  return bidObject;
+}
+
+function isBanner(bid) {
+  return bid.mediaTypes && bid.mediaTypes.banner;
+}
+
+/**
+ * Generate params that are common between all bids
+ * @param {single bid object} generalObject
+ * @param {bidderRequest} bidderRequest
+ * @returns {object} the common params object
+ */
+function generateGeneralParams(generalObject, bidderRequest) {
+  const domain = window.location.hostname;
+  const {syncEnabled, filterSettings} = config.getConfig('userSync') || {};
+  const {bidderCode} = bidderRequest;
+  const generalBidParams = generalObject.params;
+  const timeout = config.getConfig('bidderTimeout');
+
+  // these params are snake_case instead of camelCase to allow backwards compatability on the server.
+  // in the future, these will be converted to camelCase to match our convention.
+  const generalParams = {
+    wrapper_type: 'prebidjs',
+    wrapper_vendor: '$$PREBID_GLOBAL$$',
+    wrapper_version: '$prebid.version$',
+    adapter_version: ADAPTER_VERSION,
+    auction_start: timestamp(),
+    publisher_id: generalBidParams.org,
+    publisher_name: domain,
+    site_domain: domain,
+    dnt: (navigator.doNotTrack == 'yes' || navigator.doNotTrack == '1' || navigator.msDoNotTrack == '1') ? 1 : 0,
+    device_type: getDeviceType(navigator.userAgent),
+    ua: navigator.userAgent,
+    session_id: getBidIdParameter('auctionId', generalObject),
+    tmax: timeout
+  }
+
+  const userIdsParam = getBidIdParameter('userId', generalObject);
+  if (userIdsParam) {
+    generalParams.userIds = JSON.stringify(userIdsParam);
+  }
+
+  const ortb2Metadata = bidderRequest.ortb2 || {};
+  if (ortb2Metadata.site) {
+    generalParams.site_metadata = JSON.stringify(ortb2Metadata.site);
+  }
+  if (ortb2Metadata.user) {
+    generalParams.user_metadata = JSON.stringify(ortb2Metadata.user);
+  }
+
+  if (syncEnabled) {
+    const allowedSyncMethod = getAllowedSyncMethod(filterSettings, bidderCode);
+    if (allowedSyncMethod) {
+      generalParams.cs_method = allowedSyncMethod;
+    }
+  }
+
+  if (bidderRequest.uspConsent) {
+    generalParams.us_privacy = bidderRequest.uspConsent;
+  }
+
+  if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
+    generalParams.gdpr = bidderRequest.gdprConsent.gdprApplies;
+    generalParams.gdpr_consent = bidderRequest.gdprConsent.consentString;
+  }
+
+  if (generalBidParams.ifa) {
+    generalParams.ifa = generalBidParams.ifa;
+  }
+
+  if (generalObject.schain) {
+    generalParams.schain = getSupplyChain(generalObject.schain);
+  }
+
+  if (bidderRequest.ortb2 && bidderRequest.ortb2.site) {
+    generalParams.referrer = bidderRequest.ortb2.site.ref;
+    generalParams.page_url = bidderRequest.ortb2.site.page;
+  }
+
+  if (bidderRequest && bidderRequest.refererInfo) {
+    generalParams.referrer = generalParams.referrer || deepAccess(bidderRequest, 'refererInfo.referer');
+    generalParams.page_url = generalParams.page_url || config.getConfig('pageUrl') || deepAccess(window, 'location.href');
+  }
+
+  return generalParams
+}

package/modules/shinezBidAdapter.md

@@ -0,0 +1,76 @@
+#Overview
+
+Module Name: Shinez Bidder Adapter
+
+Module Type: Bidder Adapter
+
+Maintainer: tech-team@shinez.io
+
+
+# Description
+
+Module that connects to Shinez's demand sources.
+
+The Shinez adapter requires setup and approval from the Shinez. Please reach out to tech-team@shinez.io to create an Shinez account.
+
+The adapter supports Video(instream) & Banner.
+
+# Bid Parameters
+## Video
+
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `org` | required | String |  Shinez publisher Id provided by your Shinez representative  | "56f91cd4d3e3660002000033"
+| `floorPrice` | optional | Number |  Minimum price in USD. Misuse of this parameter can impact revenue | 2.00
+| `placementId` | optional | String |  A unique placement identifier  | "12345678"
+| `testMode` | optional | Boolean |  This activates the test mode  | false
+
+# Test Parameters
+```javascript
+var adUnits = [{
+        code: 'dfp-video-div',
+        sizes: [
+            [640, 480]
+        ],
+        mediaTypes: {
+            video: {
+                playerSize: [
+                    [640, 480]
+                ],
+                context: 'instream'
+            }
+        },
+        bids: [{
+            bidder: 'shinez',
+            params: {
+                org: '56f91cd4d3e3660002000033', // Required
+                floorPrice: 2.00, // Optional
+                placementId: 'shinez-video-test', // Optional
+                testMode: true // Optional
+            }
+        }]
+    },
+    {
+        code: 'dfp-banner-div',
+        sizes: [
+            [640, 480]
+        ],
+        mediaTypes: {
+            banner: {
+                sizes: [
+                    [640, 480]
+                ]
+            }
+        },
+        bids: [{
+            bidder: 'shinez',
+            params: {
+                org: '56f91cd4d3e3660002000033', // Required
+                floorPrice: 2.00, // Optional
+                placementId: 'shinez-banner-test', // Optional
+                testMode: true // Optional
+            }
+        }]
+    }
+];
+```

package/modules/taboolaBidAdapter.js

@@ -233,7 +233,7 @@ function getBid(requestId, currency, bidResponse) {
 
   return {
     requestId,
-    ttl: 360,
+    ttl: 60,
     mediaType: BANNER,
     cpm,
     creativeId,

package/modules/taboolaBidAdapter.md

@@ -40,10 +40,10 @@ The Taboola Bidding adapter requires setup before beginning. Please contact us o
 
 | Name           | Scope    | Description                                             | Example                    | Type         |
 |----------------|----------|---------------------------------------------------------|----------------------------|--------------|
-| `tagId`        | required | Tag ID / Placement Name <br>(as provided by Taboola)    | `'Below The Article'`      | `String`     |
-| `publisherId`  | required | Alphabetic Publisher ID <br>(as provided by Taboola)    | `'acme-publishing'`        | `String`     |
+| `tagId`        | required | Tag ID / Placement Name <br>                            | `'Below The Article'`      | `String`     |
+| `publisherId`  | required | Numeric Publisher ID <br>(as provided by Taboola)       | `'1234567'`                | `String`     |
 | `bcat`         | optional | List of blocked advertiser categories (IAB)             | `['IAB1-1']`               | `Array`      |
 | `badv`         | optional | Blocked Advertiser Domains                              | `'example.com'`            | `String Url` |
-| `bidfloor`     | optional | CPM bid floor                                           | `0.25`                     | `Integer`    |
+| `bidfloor`     | optional | CPM bid floor                                           | `0.25`                     | `Float`      |
 
 

package/modules/ventesBidAdapter.js

@@ -4,7 +4,7 @@ import {find} from '../src/polyfill.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 
 const BID_METHOD = 'POST';
-const BIDDER_URL = 'http://13.234.201.146:8088/va/ad';
+const BIDDER_URL = 'https://ad.ventesavenues.in/va/ad';
 
 function groupBy(values, key) {
   const groups = values.reduce((acc, value) => {

package/modules/ventesBidAdapter.md

@@ -2,7 +2,7 @@
 layout: bidder
 title: ventes
 description: Prebid ventes Bidder Adapter
-pbjs: false
+pbjs: true
 biddercode: ventes
 gdpr_supported: false
 usp_supported: false

package/modules/vrtcalBidAdapter.js

@@ -2,6 +2,7 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
 import {ajax} from '../src/ajax.js';
 import {isFn, isPlainObject} from '../src/utils.js';
+import { config } from '../src/config.js';
 
 export const spec = {
   code: 'vrtcal',
@@ -21,10 +22,32 @@ export const spec = {
         }
       }
 
+      let gdprApplies = 0;
+      let gdprConsent = '';
+      let ccpa = '';
+      let coppa = 0;
+      let tmax = 0;
+
+      if (bid && bid.gdprConsent) {
+        gdprApplies = bid.gdprConsent.gdprApplies ? 1 : 0;
+        gdprConsent = bid.gdprConsent.consentString;
+      }
+
+      if (bid && bid.uspConsent) {
+        ccpa = bid.uspConsent;
+      }
+
+      if (config.getConfig('coppa') === true) {
+        coppa = 1;
+      }
+
+      tmax = config.getConfig('bidderTimeout');
+
       const params = {
         prebidJS: 1,
         prebidAdUnitCode: bid.adUnitCode,
         id: bid.bidId,
+        tmax: tmax,
         imp: [{
           id: '1',
           banner: {
@@ -41,6 +64,18 @@ export const spec = {
         device: {
           ua: 'VRTCAL_FILLED',
           ip: 'VRTCAL_FILLED'
+        },
+        regs: {
+          coppa: coppa,
+          ext: {
+            gdpr: gdprApplies,
+            us_privacy: ccpa
+          }
+        },
+        user: {
+          ext: {
+            consent: gdprConsent
+          }
         }
       };
 

package/package.json

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

package/plugins/pbjsGlobals.js

@@ -19,7 +19,8 @@ function featureMap(disable = []) {
 
 function getNpmVersion(version) {
   try {
-    return /^(.*?)(-pre)?$/.exec(version)[1];
+    // only use "real" versions (that is, not the -pre ones, they won't be on jsDelivr)
+    return /^([\d.]+)$/.exec(version)[1];
   } catch (e) {
     return 'latest';
   }

package/src/storageManager.js

@@ -48,7 +48,7 @@ export function newStorageManager({gvlid, moduleName, bidderCode, moduleType} =
       let hookDetails = {
         hasEnforcementHook: false
       }
-      validateStorageEnforcement(gvlid, bidderCode || moduleName, moduleType, hookDetails, function(result) {
+      validateStorageEnforcement(gvlid, bidderCode || moduleName, hookDetails, function(result) {
         if (result && result.hasEnforcementHook) {
           value = cb(result);
         } else {
@@ -303,7 +303,7 @@ export function newStorageManager({gvlid, moduleName, bidderCode, moduleType} =
 /**
  * This hook validates the storage enforcement if gdprEnforcement module is included
  */
-export const validateStorageEnforcement = hook('async', function(gvlid, moduleName, moduleType, hookDetails, callback) {
+export const validateStorageEnforcement = hook('async', function(gvlid, moduleName, hookDetails, callback) {
   callback(hookDetails);
 }, 'validateStorageEnforcement');
 
@@ -322,13 +322,12 @@ export function getCoreStorageManager(moduleName) {
  * @param {Number=} gvlid? Vendor id - required for proper GDPR integration
  * @param {string=} bidderCode? - required for bid adapters
  * @param {string=} moduleName? module name
- * @param {string=} moduleType? module type
  */
-export function getStorageManager({gvlid, moduleName, bidderCode, moduleType} = {}) {
+export function getStorageManager({gvlid, moduleName, bidderCode} = {}) {
   if (arguments.length > 1 || (arguments.length > 0 && !isPlainObject(arguments[0]))) {
     throw new Error('Invalid invocation for getStorageManager')
   }
-  return newStorageManager({gvlid, moduleName, bidderCode, moduleType});
+  return newStorageManager({gvlid, moduleName, bidderCode});
 }
 
 export function resetData() {