prebid.js 5.18.0 → 5.20.2

package/modules/ventesBidAdapter.md

@@ -0,0 +1,94 @@
+---
+layout: bidder
+title: ventes
+description: Prebid ventes Bidder Adapter
+pbjs: false
+biddercode: ventes
+gdpr_supported: false
+usp_supported: false
+media_types: banner
+coppa_supported: false
+schain_supported: false
+dchain_supported: false
+prebid_member: false
+---
+
+### BidParams
+{: .table .table-bordered .table-striped }
+| Name            | Scope    | Description                                		 | Example                      		| Type          |
+|-----------------|----------|-----------------------------------------------------------|----------------------------------------------|---------------|
+| `placementId`   | required | Placement ID from Ventes Avenues 			 | `'VA-062-0013-0183'` 			| `string`	|
+| `publisherId`   | required | Publisher ID from Ventes Avenues 			 | `'VA-062'` 					| `string`	|
+| `user`          | optional | Object that specifies information about an external user. | `user: { age: 25, gender: 0, dnt: true}` 	| `object`	|
+| `app`           | required | Object containing mobile app parameters.  		 | `app : { id: 'app-id'}`			| `object`	|
+| `device`        | required | Object containing device info mandatory for mobile devices| `device : { ifa: 'device-id'}`	        | `object`	|
+
+#### User Object
+
+{: .table .table-bordered .table-striped }
+| Name              | Description 										| Example		| Type             	|
+|-------------------|-------------------------------------------------------------------------------------------|-----------------------|-----------------------|
+| `age`             | The age of the user.									| `35`			| `integer`		|
+| `externalUid`     | Specifies a string that corresponds to an external user ID for this user. 		| `'1234567890abcdefg'`	| `string` 		|
+| `segments`        | Specifies the segments to which the user belongs.						| `[1, 2]` 		| `Array<integer>`	|
+| `gender`          | Specifies the gender of the user.  Allowed values: Unknown: `0`; Male: `1`; Female: `2`	| `1` 			| `integer`		|
+| `dnt`             | Do not track flag.  Indicates if tracking cookies should be disabled for this auction	| `true`  	 	| `boolean`		|
+| `language`        | Two-letter ANSI code for this user's language.						| `EN`			| `string`		|
+
+
+### Ad Unit Setup for Banner through mobile devices
+```javascript
+var adUnits = [
+{
+  code: 'test-hb-ad-11111-1',
+  mediaTypes: {
+    banner: {  
+      sizes: [
+          [300, 250]
+      ]
+    }   
+  }, 
+  bids: [{
+    bidder: 'ventes',
+    params: {
+        placementId: 'VA-062-0013-0183',
+        publisherId: '5cebea3c9eea646c7b623d5e',
+        IABCategories: "['IAB1', 'IAB5']",
+        device:{
+          ip: '123.145.167.189',
+          ifa:"AEBE52E7-03EE-455A-B3C4-E57283966239",
+        },
+        app: {
+          id: "agltb3B1Yi1pbmNyDAsSA0FwcBiJkfIUDA",
+          name: "Yahoo Weather",
+          bundle: 'com.kiloo.subwaysurf',
+          storeurl: 'https://play.google.com/store/apps/details?id=com.kiloo.subwaysurf&hl=en',
+          domain: 'somoaudience.com',
+        } 
+    }
+  }]
+ }
+]
+```
+
+### Ad Unit Setup for Banner through Websites
+```javascript
+var adUnits = [
+{
+  code: 'test-hb-ad-11111-1',
+  mediaTypes: {
+    banner: {  
+      sizes: [
+          [300, 250]
+      ]
+    }   
+  }, 
+  bids: [{
+    bidder: 'ventes',
+    params: {
+        placementId: 'VA-002-0007-0799',
+        publisherId: '5cebea3c9eea646c7b623d5e',
+    }
+  }]
+ }
+]

package/modules/videobyteBidAdapter.js

@@ -27,7 +27,7 @@ export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [VIDEO],
   VERSION: '1.0.0',
-  ENDPOINT: 'https://x.videobyte.com/ortb/',
+  ENDPOINT: 'https://x.videobyte.com/ortbhb',
 
   /**
    * Determines whether or not the given bid request is valid.
@@ -53,13 +53,22 @@ export const spec = {
     return bidRequests.map(bidRequest => {
       const {params} = bidRequest;
       let pubId = params.pubId;
+      const placementId = params.placementId;
+      const nId = params.nid;
       if (bidRequest.params.video && bidRequest.params.video.e2etest) {
         logMessage('E2E test mode enabled');
         pubId = 'e2etest'
       }
+      let baseEndpoint = spec.ENDPOINT + '?pid=' + pubId;
+      if (placementId) {
+        baseEndpoint += '&placementId=' + placementId
+      }
+      if (nId) {
+        baseEndpoint += '&nid=' + nId
+      }
       return {
         method: 'POST',
-        url: spec.ENDPOINT + pubId,
+        url: baseEndpoint,
         data: JSON.stringify(buildRequestData(bidRequest, bidderRequest)),
       }
     });
@@ -97,8 +106,6 @@ export const spec = {
         };
         bidResponses.push(bidResponse)
       }
-    } else {
-      logError('invalid server response received');
     }
     return bidResponses;
   },
@@ -228,7 +235,7 @@ function buildRequestData(bidRequest, bidderRequest) {
   // content
   if (videoParams.content && isPlainObject(videoParams.content)) {
     openrtbRequest.site.content = {};
-    const contentStringKeys = ['id', 'title', 'series', 'season', 'genre', 'contentrating', 'language'];
+    const contentStringKeys = ['id', 'title', 'series', 'season', 'genre', 'contentrating', 'language', 'url'];
     const contentNumberkeys = ['episode', 'prodq', 'context', 'livestream', 'len'];
     const contentArrayKeys = ['cat'];
     const contentObjectKeys = ['ext'];
@@ -271,7 +278,7 @@ function validateVideo(bidRequest) {
   }
 
   if (!bidRequest.params.pubId) {
-    logError('failed validation: publisher id not declared');
+    logError('failed validation: pubId not declared');
     return false;
   }
 

package/modules/videobyteBidAdapter.md

@@ -49,6 +49,55 @@ Module that connects to VideoByte's demand sources
   ]
 ```
 
+## Instream Video adUnit with placement, nid and content params
+```
+  var adUnits = [
+    {
+        code: 'video1',
+          mediaTypes: {
+            video: {
+                  context: 'instream',
+                  playerSize: [640, 480],
+                  mimes: ['video/mp4', 'application/javascript'],
+                  protocols: [2,5],
+                  api: [2],
+                  position: 1,
+                  delivery: [2],
+                  minduration: 10,
+                  maxduration: 30,
+                  placement: 1,
+                  playbackmethod: [1,5],
+                  protocols: [2,5],
+                  api: [2],
+            }
+          },
+          bids: [
+            {
+                  bidder: 'videobyte',
+                  params: {
+                    bidfloor: 0.5,
+                    pubId: 'e2etest',
+                    placementId: '1234567',
+                    nid: '1234',
+                    video: {
+                      content:{
+                        id: "uuid",
+                        url: "https://videobyte.com/awesome-video.mp4",
+                        title: "Awesome video",
+                        genre: "Comedy",
+                        language: "en",
+                        season: "1",
+                        series: "1",
+        
+                      }
+                    }
+                  }
+                }
+          ]
+      }
+  ]
+```
+
 # End To End testing mode
 By passing bid.params.video.e2etest = true you will be able to receive a test creative
 

package/modules/yahoosspBidAdapter.js

@@ -144,9 +144,9 @@ function getAdapterMode() {
 
 function getResponseFormat(bid) {
   const adm = bid.adm;
-  if (adm.includes('o2playerSettings') || adm.includes('YAHOO.VideoPlatform.VideoPlayer') || adm.includes('AdPlacement')) {
+  if (adm.indexOf('o2playerSettings') !== -1 || adm.indexOf('YAHOO.VideoPlatform.VideoPlayer') !== -1 || adm.indexOf('AdPlacement') !== -1) {
     return BANNER;
-  } else if (adm.includes('VAST')) {
+  } else if (adm.indexOf('VAST') !== -1) {
     return VIDEO;
   }
 };
@@ -188,23 +188,23 @@ function validateAppendObject(validationType, allowedKeys, inputObject, appendTo
   for (const objectKey in inputObject) {
     switch (validationType) {
       case 'string':
-        if (allowedKeys.includes(objectKey) && isStr(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isStr(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;
       case 'number':
-        if (allowedKeys.includes(objectKey) && isNumber(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isNumber(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;
 
       case 'array':
-        if (allowedKeys.includes(objectKey) && isArray(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isArray(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;
       case 'object':
-        if (allowedKeys.includes(objectKey) && isPlainObject(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isPlainObject(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;

package/modules/yieldmoSyntheticInventoryModule.js

@@ -0,0 +1,46 @@
+import { config } from '../src/config.js';
+import { isGptPubadsDefined } from '../src/utils.js';
+
+export const MODULE_NAME = 'Yieldmo Synthetic Inventory Module';
+
+export function init(config) {
+  validateConfig(config);
+
+  if (!isGptPubadsDefined()) {
+    window.googletag = window.googletag || {};
+    window.googletag.cmd = window.googletag.cmd || [];
+  }
+
+  const googletag = window.googletag;
+  const containerName = 'ym_sim_container_' + config.placementId;
+
+  googletag.cmd.push(() => {
+    if (window.document.body) {
+      googletagCmd(config, containerName, googletag);
+    } else {
+      window.document.addEventListener('DOMContentLoaded', () => googletagCmd(config, containerName, googletag));
+    }
+  });
+}
+
+export function validateConfig(config) {
+  if (!('placementId' in config)) {
+    throw new Error(`${MODULE_NAME}: placementId required`);
+  }
+  if (!('adUnitPath' in config)) {
+    throw new Error(`${MODULE_NAME}: adUnitPath required`);
+  }
+}
+
+function googletagCmd(config, containerName, googletag) {
+  const gamContainer = window.document.createElement('div');
+  gamContainer.id = containerName;
+  window.document.body.appendChild(gamContainer);
+  googletag.defineSlot(config.adUnitPath, [1, 1], containerName)
+    .addService(googletag.pubads())
+    .setTargeting('ym_sim_p_id', config.placementId);
+  googletag.enableServices();
+  googletag.display(containerName);
+}
+
+config.getConfig('yieldmo_synthetic_inventory', config => init(config.yieldmo_synthetic_inventory));

package/modules/yieldmoSyntheticInventoryModule.md

@@ -0,0 +1,68 @@
+# Yieldmo Synthetic Inventory Module
+
+## Overview
+
+This module enables publishers to set up Yieldmo Synthetic Outstream ads on their pages.
+
+If publishers will enable this module and provide placementId and Google Ad Manager ad unit path, this module will create a placement on the page and inject Yieldmo SDK into this placement. Publisher will then need to get a placement id from their Yieldmo account manager (accounts email) and setup corresponding ad units on the GAM ad server.
+
+## Integration
+
+Build the Yieldmo Synthetic Inventory Module into the Prebid.js package with:
+
+```
+gulp build --modules=yieldmoSyntheticInventoryModule,...
+```
+
+## Module Configuration
+
+```js
+pbjs.que.push(function() {
+    pbjs.setConfig({
+        yieldmo_synthetic_inventory: {
+            placementId: '1234567890',
+            adUnitPath: '/1234567/ad_unit_name_used_in_gam'
+        }
+    });
+});
+```
+
+### Configuration Parameters
+
+|Name |Scope |Description | Example| Type
+| :------------ | :------------ | :------------ | :------------ | :------------ |
+|placementId | required | Yieldmo placement ID | '1234567890' | string
+|adUnitPath | required | Google Ad Manager ad unit path | '/6355419/ad_unit_name_used_in_gam' | string
+
+### How to get ad unit path
+
+Ad unit path follows the format /network-code/[parent-ad-unit-code/.../]ad-unit-code, where:
+
+- network-code is a unique identifier for the Ad Manager network the ad unit belongs to
+- parent-ad-unit-code are the codes of all parent ad units (only applies to non-top level ad units)
+- ad-unit-code is the code for the ad unit to be displayed
+
+Note that all ad unit codes included in the ad unit path must adhere to the [formatting rules](https://support.google.com/admanager/answer/1628457#ad-unit-codes) specified by Ad Manager.
+
+Another and probably the easiest way to get an ad unit path is to get it from the google ad manager ad unit document header generated tag:
+
+```js
+googletag.defineSlot('/1234567/ad_unit_name_used_in_gam', [1, 1], 'ad-container-id').addService(googletag.pubads());
+```
+
+### How to get Yieldmo placement id
+
+Please reach out to your Yieldmo account's person or email to support@yieldmo.com
+
+### Google Ad Manager setup
+
+Yieldmo Synthetic Inventory Module is designed to be used along with Google Ad Manager. GAM should be set as usual, but there are a few requirements:
+
+- Ad unit size should be 1x1
+- Creative should NOT be served into a SafeFrame and also should have 1x1 size
+- Synthetic Inventory Universal Tag should be used as 3rd party creative code
+### Synthetic Inventory Universal Tag
+
+```js
+<div id="ym_%%PATTERN:ym_sim_p_id%%" class="ym"></div><script type="text/javascript">(function(e,t){if(t._ym===void 0){t._ym="";var m=e.createElement("script");m.type="text/javascript",m.async=!0,m.src="//static.yieldmo.com/ym."+Math.round(5*Math.random()/3)+".js",(e.getElementsByTagName("head")[0]||e.getElementsByTagName("body")[0]).appendChild(m)}else t._ym instanceof String||void 0===t._ym.chkPls||t._ym.chkPls()})(document,window);</script>
+```

package/package.json

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

package/src/adapterManager.js

@@ -621,4 +621,9 @@ adapterManager.callBidViewableBidder = function(bidder, bid) {
   tryCallBidderMethod(bidder, 'onBidViewable', bid);
 };
 
+adapterManager.callBidderError = function(bidder, error, bidderRequest) {
+  const param = { error, bidderRequest };
+  tryCallBidderMethod(bidder, 'onBidderError', param);
+};
+
 export default adapterManager;

package/src/adapters/bidderFactory.js

@@ -335,10 +335,11 @@ export function newBidder(spec) {
 
         // If the server responds with an error, there's not much we can do. Log it, and make sure to
         // call onResponse() so that we're one step closer to calling done().
-        function onFailure(err) {
+        function onFailure(errorMessage, error) {
           onTimelyResponse(spec.code);
-
-          logError(`Server call for ${spec.code} failed: ${err}. Continuing without bids.`);
+          adapterManager.callBidderError(spec.code, error, bidderRequest)
+          events.emit(CONSTANTS.EVENTS.BIDDER_ERROR, { error, bidderRequest });
+          logError(`Server call for ${spec.code} failed: ${errorMessage} ${error.status}. Continuing without bids.`);
           onResponse();
         }
       }

package/src/auction.js

@@ -613,7 +613,8 @@ export const getPriceGranularity = (mediaType, bidReq) => {
  * @returns {function}
  */
 export const getPriceByGranularity = (granularity) => {
-  return (bid) => {
+  return (bid, bidReq) => {
+    granularity = granularity || getPriceGranularity(bid.mediaType, bidReq);
     if (granularity === CONSTANTS.GRANULARITY_OPTIONS.AUTO) {
       return bid.pbAg;
     } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.DENSE) {
@@ -646,14 +647,14 @@ export const getAdvertiserDomain = () => {
  * @param {BidRequest} bidReq
  * @returns {*}
  */
-export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
+export function getStandardBidderSettings(mediaType, bidderCode) {
   // factory for key value objs
   function createKeyVal(key, value) {
     return {
       key,
       val: (typeof value === 'function')
-        ? function (bidResponse) {
-          return value(bidResponse);
+        ? function (bidResponse, bidReq) {
+          return value(bidResponse, bidReq);
         }
         : function (bidResponse) {
           return getValue(bidResponse, value);
@@ -661,7 +662,6 @@ export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
     };
   }
   const TARGETING_KEYS = CONSTANTS.TARGETING_KEYS;
-  const granularity = getPriceGranularity(mediaType, bidReq);
 
   let bidderSettings = $$PREBID_GLOBAL$$.bidderSettings;
   if (!bidderSettings[CONSTANTS.JSON_MAPPING.BD_SETTING_STANDARD]) {
@@ -671,7 +671,7 @@ export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
     bidderSettings[CONSTANTS.JSON_MAPPING.BD_SETTING_STANDARD][CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING] = [
       createKeyVal(TARGETING_KEYS.BIDDER, 'bidderCode'),
       createKeyVal(TARGETING_KEYS.AD_ID, 'adId'),
-      createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity(granularity)),
+      createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity()),
       createKeyVal(TARGETING_KEYS.SIZE, 'size'),
       createKeyVal(TARGETING_KEYS.DEAL, 'dealId'),
       createKeyVal(TARGETING_KEYS.SOURCE, 'source'),
@@ -716,12 +716,12 @@ export function getKeyValueTargetingPairs(bidderCode, custBidObj, bidReq) {
   // 1) set the keys from "standard" setting or from prebid defaults
   if (bidderSettings) {
     // initialize default if not set
-    const standardSettings = getStandardBidderSettings(custBidObj.mediaType, bidderCode, bidReq);
-    setKeys(keyValues, standardSettings, custBidObj);
+    const standardSettings = getStandardBidderSettings(custBidObj.mediaType, bidderCode);
+    setKeys(keyValues, standardSettings, custBidObj, bidReq);
 
     // 2) set keys from specific bidder setting override if they exist
     if (bidderCode && bidderSettings[bidderCode] && bidderSettings[bidderCode][CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING]) {
-      setKeys(keyValues, bidderSettings[bidderCode], custBidObj);
+      setKeys(keyValues, bidderSettings[bidderCode], custBidObj, bidReq);
       custBidObj.sendStandardTargeting = bidderSettings[bidderCode].sendStandardTargeting;
     }
   }
@@ -734,7 +734,7 @@ export function getKeyValueTargetingPairs(bidderCode, custBidObj, bidReq) {
   return keyValues;
 }
 
-function setKeys(keyValues, bidderSettings, custBidObj) {
+function setKeys(keyValues, bidderSettings, custBidObj, bidReq) {
   var targeting = bidderSettings[CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING];
   custBidObj.size = custBidObj.getSize();
 
@@ -748,7 +748,7 @@ function setKeys(keyValues, bidderSettings, custBidObj) {
 
     if (isFn(value)) {
       try {
-        value = value(custBidObj);
+        value = value(custBidObj, bidReq);
       } catch (e) {
         logError('bidmanager', 'ERROR', e);
       }

package/src/constants.json

@@ -32,6 +32,7 @@
     "NO_BID": "noBid",
     "BID_WON": "bidWon",
     "BIDDER_DONE": "bidderDone",
+    "BIDDER_ERROR": "bidderError",
     "SET_TARGETING": "setTargeting",
     "BEFORE_REQUEST_BIDS": "beforeRequestBids",
     "BEFORE_BIDDER_HTTP": "beforeBidderHttp",

package/src/secureCreatives.js

@@ -60,7 +60,6 @@ export function receiveMessage(ev) {
       if (data.action === 'assetRequest') {
         const message = getAssetMessage(data, adObject);
         ev.source.postMessage(JSON.stringify(message), ev.origin);
-        return;
       } else if (data.action === 'allAssetRequest') {
         const message = getAllAssetsMessage(data, adObject);
         ev.source.postMessage(JSON.stringify(message), ev.origin);
@@ -68,13 +67,13 @@ export function receiveMessage(ev) {
         adObject.height = data.height;
         adObject.width = data.width;
         resizeRemoteCreative(adObject);
-      }
-
-      const trackerType = fireNativeTrackers(data, adObject);
-      if (trackerType === 'click') { return; }
+      } else {
+        const trackerType = fireNativeTrackers(data, adObject);
+        if (trackerType === 'click') { return; }
 
-      auctionManager.addWinningBid(adObject);
-      events.emit(BID_WON, adObject);
+        auctionManager.addWinningBid(adObject);
+        events.emit(BID_WON, adObject);
+      }
     }
   }
 }

package/src/targeting.js

@@ -123,17 +123,19 @@ export function newTargeting(auctionManager) {
     if (isGptPubadsDefined()) {
       const adUnitCodes = getAdUnitCodes(adUnitCode);
       const adUnits = auctionManager.getAdUnits().filter(adUnit => includes(adUnitCodes, adUnit.code));
+      let unsetKeys = pbTargetingKeys.reduce((reducer, key) => {
+        reducer[key] = null;
+        return reducer;
+      }, {});
       window.googletag.pubads().getSlots().forEach(slot => {
         let customSlotMatchingFunc = isFn(customSlotMatching) && customSlotMatching(slot);
-        pbTargetingKeys.forEach(function(key) {
-          // reset only registered adunits
-          adUnits.forEach(function(unit) {
-            if (unit.code === slot.getAdUnitPath() ||
-                unit.code === slot.getSlotElementId() ||
-                (isFn(customSlotMatchingFunc) && customSlotMatchingFunc(unit.code))) {
-              slot.setTargeting(key, null);
-            }
-          });
+        // reset only registered adunits
+        adUnits.forEach(unit => {
+          if (unit.code === slot.getAdUnitPath() ||
+              unit.code === slot.getSlotElementId() ||
+              (isFn(customSlotMatchingFunc) && customSlotMatchingFunc(unit.code))) {
+            slot.updateTargetingFromMap(unsetKeys);
+          }
         });
       });
     }