prebid.js 5.16.0 → 5.20.0

package/modules/yieldlabBidAdapter.js

@@ -3,6 +3,7 @@ import { registerBidder } from '../src/adapters/bidderFactory.js'
 import find from 'core-js-pure/features/array/find.js'
 import { VIDEO, BANNER } from '../src/mediaTypes.js'
 import { Renderer } from '../src/Renderer.js'
+import { config } from '../src/config.js';
 
 const ENDPOINT = 'https://ad.yieldlab.net'
 const BIDDER_CODE = 'yieldlab'
@@ -52,6 +53,11 @@ export const spec = {
       if (bid.schain && isPlainObject(bid.schain) && Array.isArray(bid.schain.nodes)) {
         query.schain = createSchainString(bid.schain)
       }
+
+      const iabContent = getContentObject(bid)
+      if (iabContent) {
+        query.iab_content = createIabContentString(iabContent)
+      }
     })
 
     if (bidderRequest) {
@@ -105,6 +111,7 @@ export const spec = {
         const gdprApplies = reqParams.gdpr ? '&gdpr=' + reqParams.gdpr : ''
         const gdprConsent = reqParams.consent ? '&consent=' + reqParams.consent : ''
         const pvId = matchedBid.pvid !== undefined ? '&pvid=' + matchedBid.pvid : ''
+        const iabContent = reqParams.iab_content ? '&iab_content=' + reqParams.iab_content : ''
 
         const bidResponse = {
           requestId: bidRequest.bidId,
@@ -117,7 +124,7 @@ export const spec = {
           netRevenue: false,
           ttl: BID_RESPONSE_TTL_SEC,
           referrer: '',
-          ad: `<script src="${ENDPOINT}/d/${matchedBid.id}/${bidRequest.params.supplyId}/?ts=${timestamp}${extId}${gdprApplies}${gdprConsent}${pvId}"></script>`,
+          ad: `<script src="${ENDPOINT}/d/${matchedBid.id}/${bidRequest.params.supplyId}/?ts=${timestamp}${extId}${gdprApplies}${gdprConsent}${pvId}${iabContent}"></script>`,
           meta: {
             advertiserDomains: (matchedBid.advertiser) ? matchedBid.advertiser : 'n/a'
           }
@@ -130,7 +137,7 @@ export const spec = {
             bidResponse.height = playersize[1]
           }
           bidResponse.mediaType = VIDEO
-          bidResponse.vastUrl = `${ENDPOINT}/d/${matchedBid.id}/${bidRequest.params.supplyId}/?ts=${timestamp}${extId}${gdprApplies}${gdprConsent}${pvId}`
+          bidResponse.vastUrl = `${ENDPOINT}/d/${matchedBid.id}/${bidRequest.params.supplyId}/?ts=${timestamp}${extId}${gdprApplies}${gdprConsent}${pvId}${iabContent}`
           if (isOutstream(bidRequest)) {
             const renderer = Renderer.install({
               id: bidRequest.bidId,
@@ -211,7 +218,7 @@ function createQueryString (obj) {
   for (var p in obj) {
     if (obj.hasOwnProperty(p)) {
       let val = obj[p]
-      if (p !== 'schain') {
+      if (p !== 'schain' && p !== 'iab_content') {
         str.push(encodeURIComponent(p) + '=' + encodeURIComponent(val))
       } else {
         str.push(p + '=' + val)
@@ -253,6 +260,44 @@ function createSchainString (schain) {
   return `${ver},${complete}${nodesString}`
 }
 
+/**
+ * Get content object from bid request
+ * First get content from bidder params;
+ * If not provided in bidder params, get from first party data under 'ortb2.site.content' or 'ortb2.app.content'
+ * @param {Object} bid
+ * @returns {Object}
+ */
+function getContentObject(bid) {
+  if (bid.params.iabContent && isPlainObject(bid.params.iabContent)) {
+    return bid.params.iabContent
+  }
+
+  const globalContent = config.getConfig('ortb2.site') ? config.getConfig('ortb2.site.content')
+    : config.getConfig('ortb2.app.content')
+  if (globalContent && isPlainObject(globalContent)) {
+    return globalContent
+  }
+  return undefined
+}
+
+/**
+ * Creates a string for iab_content object
+ * @param {Object} iabContent
+ * @returns {String}
+ */
+function createIabContentString(iabContent) {
+  const arrKeys = ['keywords', 'cat']
+  let str = []
+  for (let key in iabContent) {
+    if (iabContent.hasOwnProperty(key)) {
+      const value = (arrKeys.indexOf(key) !== -1 && Array.isArray(iabContent[key]))
+        ? iabContent[key].map(node => encodeURIComponent(node)).join('|') : encodeURIComponent(iabContent[key])
+      str.push(''.concat(key, ':', value))
+    }
+  }
+  return encodeURIComponent(str.join(','))
+}
+
 /**
  * Encodes URI Component with exlamation mark included. Needed for schain object.
  * @param {String} str

package/modules/yieldlabBidAdapter.md

@@ -25,7 +25,22 @@ Module that connects to Yieldlab's demand sources
                            key1: "value1",
                            key2: "value2"
                        },
-                       extId: "abc"
+                       extId: "abc",
+                       iabContent: {
+                           id: "some_id",
+                           episode: "1",
+                           title: "some title",
+                           series: "some series",
+                           season: "s1",
+                           artist: "John Doe",
+                           genre: "some genre",
+                           isrc: "CC-XXX-YY-NNNNN",
+                           url: "http://foo_url.de",
+                           cat: ["IAB1-1", "IAB1-2", "IAB2-10"],
+                           context: "7",
+                           keywords: ["k1", "k2"],
+                           live: "0"
+                       }
                    }
                }]
            }, {

package/modules/yieldmoBidAdapter.js

@@ -1,9 +1,10 @@
-import { getWindowTop, deepAccess, parseQueryStringParameters, isArrayOfNums, isArray, parseUrl, isEmpty, deepSetValue, isStr, isNumber, isInteger, isBoolean, logError } from '../src/utils.js';
+import { isNumber, isStr, isInteger, isBoolean, isArray, isEmpty, isArrayOfNums, getWindowTop, parseQueryStringParameters, parseUrl, deepSetValue, deepAccess, logError } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { Renderer } from '../src/Renderer.js';
 import includes from 'core-js-pure/features/array/includes';
 import find from 'core-js-pure/features/array/find.js';
+import { createEidsArray } from './userId/eids.js';
 
 const BIDDER_CODE = 'yieldmo';
 const CURRENCY = 'USD';
@@ -46,8 +47,8 @@ export const spec = {
   buildRequests: function (bidRequests, bidderRequest) {
     const bannerBidRequests = bidRequests.filter(request => hasBannerMediaType(request));
     const videoBidRequests = bidRequests.filter(request => hasVideoMediaType(request));
-
     let serverRequests = [];
+    const eids = getEids(bidRequests[0]) || [];
     if (bannerBidRequests.length > 0) {
       let serverRequest = {
         pbav: '$prebid.version$',
@@ -99,6 +100,9 @@ export const spec = {
       });
       serverRequest.p = '[' + serverRequest.p.toString() + ']';
 
+      if (eids.length) {
+        serverRequest.eids = JSON.stringify(eids);
+      };
       // check if url exceeded max length
       const url = `${BANNER_SERVER_ENDPOINT}?${parseQueryStringParameters(serverRequest)}`;
       let extraCharacters = url.length - MAX_BANNER_REQUEST_URL_LENGTH;
@@ -121,6 +125,9 @@ export const spec = {
 
     if (videoBidRequests.length > 0) {
       const serverRequest = openRtbRequest(videoBidRequests, bidderRequest);
+      if (eids.length) {
+        serverRequest.user = { eids };
+      };
       serverRequests.push({
         method: 'POST',
         url: VIDEO_SERVER_ENDPOINT,
@@ -447,14 +454,10 @@ function openRtbSite(bidRequest, bidderRequest) {
  * @return Object OpenRTB's 'device' object
  */
 function openRtbDevice(bidRequest) {
-  const ip = deepAccess(bidRequest, 'params.device.ip');
   const deviceObj = {
     ua: navigator.userAgent,
     language: (navigator.language || navigator.browserLanguage || navigator.userLanguage || navigator.systemLanguage),
   };
-  if (ip) {
-    deviceObj.ip = ip;
-  }
   return deviceObj;
 }
 
@@ -595,3 +598,14 @@ function shortcutProperty(extraCharacters, target, propertyName) {
 
   return charactersLeft;
 }
+
+/**
+ * Creates and returnes eids arr using createEidsArray from './userId/eids.js' module;
+ * @param {Object} openRtbRequest OpenRTB's request as a cource of userId.
+ * @return array of eids objects
+ */
+function getEids(bidRequest) {
+  if (deepAccess(bidRequest, 'userId')) {
+    return createEidsArray(bidRequest.userId) || [];
+  }
+};

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.16.0",
+  "version": "5.20.0",
   "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);
+          }
         });
       });
     }

package/test/.eslintrc.js

@@ -8,7 +8,8 @@ module.exports = {
     '$$PREBID_GLOBAL$$': false
   },
   parserOptions: {
-    sourceType: 'module'
+    sourceType: 'module',
+    ecmaVersion: 2018
   },
   rules: {
     'comma-dangle': 'off',