prebid.js 6.7.0 → 6.8.0

package/integrationExamples/gpt/x-domain/creative.html

@@ -2,37 +2,40 @@
 // this script can be returned by an ad server delivering a cross domain iframe, into which the
 // creative will be rendered, e.g. DFP delivering a SafeFrame
 
-let windowLocation = window.location;
-var urlParser = document.createElement('a');
+const windowLocation = window.location;
+const urlParser = document.createElement('a');
 urlParser.href = '%%PATTERN:url%%';
-var publisherDomain = urlParser.protocol + '//' + urlParser.hostname;
+const publisherDomain = urlParser.protocol + '//' + urlParser.hostname;
+const adId = '%%PATTERN:hb_adid%%';
 
 function renderAd(ev) {
-    var key = ev.message ? 'message' : 'data';
-    var adObject = {};
-    try {
-      adObject = JSON.parse(ev[key]);
-    } catch (e) {
-      return;
-    }
+  const key = ev.message ? 'message' : 'data';
+  let adObject = {};
+  try {
+    adObject = JSON.parse(ev[key]);
+  } catch (e) {
+    return;
+  }
 
-    var origin = ev.origin || ev.originalEvent.origin;
-    if (adObject.message && adObject.message === 'Prebid Response' &&
-        publisherDomain === origin &&
-        adObject.adId === '%%PATTERN:hb_adid%%' &&
-        (adObject.ad || adObject.adUrl)) {
-      var body = window.document.body;
-      var ad = adObject.ad;
-      var url = adObject.adUrl;
-      var width = adObject.width;
-      var height = adObject.height;
+  const origin = ev.origin || ev.originalEvent.origin;
+  if (adObject.message && adObject.message === 'Prebid Response' &&
+    publisherDomain === origin &&
+    adObject.adId === adId) {
+    try {
+      const body = window.document.body;
+      const ad = adObject.ad;
+      const url = adObject.adUrl;
+      const width = adObject.width;
+      const height = adObject.height;
 
       if (adObject.mediaType === 'video') {
+        signalRenderResult(false, {
+          reason: 'preventWritingOnMainDocument',
+          message: `Cannot render video ad ${adId}`
+        });
         console.log('Error trying to write ad.');
-      } else
-
-      if (ad) {
-        var frame = document.createElement('iframe');
+      } else if (ad) {
+        const frame = document.createElement('iframe');
         frame.setAttribute('FRAMEBORDER', 0);
         frame.setAttribute('SCROLLING', 'no');
         frame.setAttribute('MARGINHEIGHT', 0);
@@ -46,18 +49,42 @@ function renderAd(ev) {
         frame.contentDocument.open();
         frame.contentDocument.write(ad);
         frame.contentDocument.close();
+        signalRenderResult(true);
       } else if (url) {
         body.insertAdjacentHTML('beforeend', '<IFRAME SRC="' + url + '" FRAMEBORDER="0" SCROLLING="no" MARGINHEIGHT="0" MARGINWIDTH="0" TOPMARGIN="0" LEFTMARGIN="0" ALLOWTRANSPARENCY="true" WIDTH="' + width + '" HEIGHT="' + height + '"></IFRAME>');
+        signalRenderResult(true);
       } else {
-        console.log('Error trying to write ad. No ad for bid response id: ' + id);
+        signalRenderResult(false, {
+          reason: 'noAd',
+          message: `No ad for ${adId}`
+        });
+        console.log(`Error trying to write ad. No ad markup or adUrl for ${adId}`);
       }
+    } catch (e) {
+      signalRenderResult(false, {reason: 'exception', message: e.message});
+      console.log(`Error in rendering ad`, e);
     }
   }
 
+  function signalRenderResult(success, {reason, message} = {}) {
+    const payload = {
+      message: 'Prebid Event',
+      adId,
+      event: success ? 'adRenderSucceeded' : 'adRenderFailed',
+    }
+    if (!success) {
+      payload.info = {reason, message};
+    }
+    ev.source.postMessage(JSON.stringify(payload), publisherDomain);
+  }
+
+}
+
+
 function requestAdFromPrebid() {
   var message = JSON.stringify({
     message: 'Prebid Request',
-    adId: '%%PATTERN:hb_adid%%'
+    adId
   });
   window.parent.postMessage(message, publisherDomain);
 }

package/modules/adagioBidAdapter.js

@@ -268,8 +268,6 @@ function getSite(bidderRequest) {
   } else if (refererInfo.stack && refererInfo.stack.length && refererInfo.stack[0]) {
     // important note check if refererInfo.stack[0] is 'thruly' because a `null` value
     // will be considered as "localhost" by the parseUrl function.
-    // As the isBidRequestValid returns false when it does not reach the referer
-    // this should never called.
     const url = parseUrl(refererInfo.stack[0]);
     domain = url.hostname;
   }
@@ -873,12 +871,6 @@ export const spec = {
 
     autoFillParams(bid);
 
-    if (!internal.getRefererInfo().reachedTop) {
-      logWarn(`${LOG_PREFIX} the main page url is unreachabled.`);
-      // internal.enqueue(debugData());
-      return false;
-    }
-
     if (!(bid.params.organizationId && bid.params.site && bid.params.placement)) {
       logWarn(`${LOG_PREFIX} at least one required param is missing.`);
       // internal.enqueue(debugData());

package/modules/adagioBidAdapter.md

@@ -18,7 +18,7 @@ Below, the list of Adagio params and where they can be set.
 | ---------- | ------------- | ------------- |
 | siteId | x |
 | organizationId (obsolete) | | x
-| site (obsolete) | | x
+| site (obsolete) | | x
 | pagetype | x | x
 | environment | x | x
 | category | x | x

package/modules/appnexusBidAdapter.js

@@ -201,6 +201,17 @@ export const spec = {
       payload.app = appIdObj;
     }
 
+    let auctionKeywords = config.getConfig('appnexusAuctionKeywords');
+    if (isPlainObject(auctionKeywords)) {
+      let aucKeywords = transformBidderParamKeywords(auctionKeywords);
+
+      if (aucKeywords.length > 0) {
+        aucKeywords.forEach(deleteValues);
+      }
+
+      payload.keywords = aucKeywords;
+    }
+
     if (config.getConfig('adpod.brandCategoryExclusion')) {
       payload.brand_category_uniqueness = true;
     }

package/modules/brandmetricsRtdProvider.js

@@ -0,0 +1,168 @@
+/**
+ * This module adds brandmetrics provider to the real time data module
+ * The {@link module:modules/realTimeData} module is required
+ * The module will load load the brandmetrics script and set survey- targeting to ad units of specific bidders.
+ * @module modules/brandmetricsRtdProvider
+ * @requires module:modules/realTimeData
+ */
+import { config } from '../src/config.js'
+import { submodule } from '../src/hook.js'
+import { deepSetValue, mergeDeep, logError, deepAccess } from '../src/utils.js'
+import {loadExternalScript} from '../src/adloader.js'
+const MODULE_NAME = 'brandmetrics'
+const MODULE_CODE = MODULE_NAME
+const RECEIVED_EVENTS = []
+const GVL_ID = 422
+const TCF_PURPOSES = [1, 7]
+
+function init (config, userConsent) {
+  const hasConsent = checkConsent(userConsent)
+
+  if (hasConsent) {
+    const moduleConfig = getMergedConfig(config)
+    initializeBrandmetrics(moduleConfig.params.scriptId)
+  }
+  return hasConsent
+}
+
+/**
+ * Checks TCF and USP consents
+ * @param {Object} userConsent
+ * @returns {boolean}
+ */
+function checkConsent (userConsent) {
+  let consent = false
+
+  if (userConsent && userConsent.gdpr && userConsent.gdpr.gdprApplies) {
+    const gdpr = userConsent.gdpr
+
+    if (gdpr.vendorData) {
+      const vendor = gdpr.vendorData.vendor
+      const purpose = gdpr.vendorData.purpose
+
+      let vendorConsent = false
+      if (vendor.consents) {
+        vendorConsent = vendor.consents[GVL_ID]
+      }
+
+      if (vendor.legitimateInterests) {
+        vendorConsent = vendorConsent || vendor.legitimateInterests[GVL_ID]
+      }
+
+      const purposes = TCF_PURPOSES.map(id => {
+        return (purpose.consents && purpose.consents[id]) || (purpose.legitimateInterests && purpose.legitimateInterests[id])
+      })
+      const purposesValid = purposes.filter(p => p === true).length === TCF_PURPOSES.length
+      consent = vendorConsent && purposesValid
+    }
+  } else if (userConsent.usp) {
+    const usp = userConsent.usp
+    consent = usp[1] !== 'N' && usp[2] !== 'Y'
+  }
+
+  return consent
+}
+
+/**
+* Add event- listeners to hook in to brandmetrics events
+* @param {Object} reqBidsConfigObj
+* @param {function} callback
+*/
+function processBrandmetricsEvents (reqBidsConfigObj, moduleConfig, callback) {
+  const callBidTargeting = (event) => {
+    if (event.available && event.conf) {
+      const targetingConf = event.conf.displayOption || {}
+      if (targetingConf.type === 'pbjs') {
+        setBidderTargeting(reqBidsConfigObj, moduleConfig, targetingConf.targetKey || 'brandmetrics_survey', event.survey.measurementId)
+      }
+    }
+    callback()
+  }
+
+  if (RECEIVED_EVENTS.length > 0) {
+    callBidTargeting(RECEIVED_EVENTS[RECEIVED_EVENTS.length - 1])
+  } else {
+    window._brandmetrics = window._brandmetrics || []
+    window._brandmetrics.push({
+      cmd: '_addeventlistener',
+      val: {
+        event: 'surveyloaded',
+        reEmitLast: true,
+        handler: (ev) => {
+          RECEIVED_EVENTS.push(ev)
+          if (RECEIVED_EVENTS.length === 1) {
+            // Call bid targeting only for the first received event, if called subsequently, last event from the RECEIVED_EVENTS array is used
+            callBidTargeting(ev)
+          }
+        },
+      }
+    })
+  }
+}
+
+/**
+ * Sets bid targeting of specific bidders
+ * @param {Object} reqBidsConfigObj
+ * @param {string} key Targeting key
+ * @param {string} val Targeting value
+ */
+function setBidderTargeting (reqBidsConfigObj, moduleConfig, key, val) {
+  const bidders = deepAccess(moduleConfig, 'params.bidders')
+  if (bidders && bidders.length > 0) {
+    const ortb2 = {}
+    deepSetValue(ortb2, 'ortb2.user.ext.data.' + key, val)
+    config.setBidderConfig({
+      bidders: bidders,
+      config: ortb2
+    })
+  }
+}
+
+/**
+ * Add the brandmetrics script to the page.
+ * @param {string} scriptId - The script- id provided by brandmetrics or brandmetrics partner
+ */
+function initializeBrandmetrics(scriptId) {
+  if (scriptId) {
+    const path = 'https://cdn.brandmetrics.com/survey/script/'
+    const file = scriptId + '.js'
+    const url = path + file
+
+    loadExternalScript(url, MODULE_CODE)
+  }
+}
+
+/**
+ * Merges a provided config with default values
+ * @param {Object} customConfig
+ * @returns
+ */
+function getMergedConfig(customConfig) {
+  return mergeDeep({
+    waitForIt: false,
+    params: {
+      bidders: [],
+      scriptId: undefined,
+    }
+  }, customConfig)
+}
+
+/** @type {RtdSubmodule} */
+export const brandmetricsSubmodule = {
+  name: MODULE_NAME,
+  getBidRequestData: function (reqBidsConfigObj, callback, customConfig) {
+    try {
+      const moduleConfig = getMergedConfig(customConfig)
+      if (moduleConfig.waitForIt) {
+        processBrandmetricsEvents(reqBidsConfigObj, moduleConfig, callback)
+      } else {
+        callback()
+      }
+    } catch (e) {
+      logError(e)
+    }
+  },
+  init: init
+}
+
+submodule('realTimeData', brandmetricsSubmodule)

package/modules/brandmetricsRtdProvider.md

@@ -0,0 +1,40 @@
+# Brandmetrics Real-time Data Submodule
+This module is intended to be used by brandmetrics (https://brandmetrics.com) partners and sets targeting keywords to bids if the browser is eligeble to see a brandmetrics survey.
+The module hooks in to brandmetrics events and requires a brandmetrics script to be running. The module can optionally load and initialize brandmetrics by providing the 'scriptId'- parameter.
+
+## Usage
+Compile the Brandmetrics RTD module into your Prebid build:
+```
+gulp build --modules=rtdModule,brandmetricsRtdProvider
+```
+
+> Note that the global RTD module, `rtdModule`, is a prerequisite of the Brandmetrics RTD module.
+
+Enable the Brandmetrics RTD in your Prebid configuration, using the below format:
+
+```javascript
+pbjs.setConfig({
+  ...,
+  realTimeData: {
+    auctionDelay: 500, // auction delay
+    dataProviders: [{
+      name: 'brandmetrics',
+      waitForIt: true // should be true if there's an `auctionDelay`,
+      params: {
+        scriptId: '00000000-0000-0000-0000-000000000000',
+        bidders: ['ozone']
+      }
+    }]
+  },
+  ...
+})
+```
+
+## Parameters
+| Name              | Type                 | Description        | Default        |
+| ----------------- | -------------------- | ------------------ | ------------------ |
+| name              | String               | This should always be `brandmetrics` | - |
+| waitForIt         | Boolean              | Should be `true` if there's an `auctionDelay` defined (recommended) | `false` |
+| params            | Object               |                 | - |
+| params.bidders    | String[]             | An array of bidders which should receive targeting keys. | `[]` |
+| params.scriptId   | String               | A script- id GUID if the brandmetrics- script should be initialized. | `undefined` |

package/modules/criteoBidAdapter.js

@@ -281,6 +281,7 @@ function checkNativeSendId(bidRequest) {
  */
 function buildCdbRequest(context, bidRequests, bidderRequest) {
   let networkId;
+  let schain;
   const request = {
     publisher: {
       url: context.url,
@@ -288,6 +289,7 @@ function buildCdbRequest(context, bidRequests, bidderRequest) {
     },
     slots: bidRequests.map(bidRequest => {
       networkId = bidRequest.params.networkId || networkId;
+      schain = bidRequest.schain || schain;
       const slot = {
         impid: bidRequest.adUnitCode,
         transactionid: bidRequest.transactionId,
@@ -344,6 +346,13 @@ function buildCdbRequest(context, bidRequests, bidderRequest) {
   if (networkId) {
     request.publisher.networkid = networkId;
   }
+  if (schain) {
+    request.source = {
+      ext: {
+        schain: schain
+      }
+    }
+  };
   request.user = {
     ext: bidderRequest.userExt
   };

package/modules/currency.js

@@ -20,6 +20,25 @@ export var currencyRates = {};
 var bidderCurrencyDefault = {};
 var defaultRates;
 
+export const ready = (() => {
+  let isDone, resolver, promise;
+  function reset() {
+    isDone = false;
+    resolver = null;
+    promise = new Promise((resolve) => {
+      resolver = resolve;
+      if (isDone) resolve();
+    })
+  }
+  function done() {
+    isDone = true;
+    if (resolver != null) { resolver() }
+  }
+  reset();
+
+  return {done, reset, promise: () => promise}
+})();
+
 /**
  * Configuration function for currency
  * @param  {string} [config.adServerCurrency = 'USD']
@@ -138,11 +157,15 @@ function initCurrency(url) {
             logInfo('currencyRates set to ' + JSON.stringify(currencyRates));
             currencyRatesLoaded = true;
             processBidResponseQueue();
+            ready.done();
           } catch (e) {
             errorSettingsRates('Failed to parse currencyRates response: ' + response);
           }
         },
-        error: errorSettingsRates
+        error: function (...args) {
+          errorSettingsRates(...args);
+          ready.done();
+        }
       }
     );
   }
@@ -197,6 +220,8 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
   bidResponseQueue.push(wrapFunction(fn, this, [adUnitCode, bid]));
   if (!currencySupportEnabled || currencyRatesLoaded) {
     processBidResponseQueue();
+  } else {
+    fn.bail(ready.promise());
   }
 }
 

package/modules/displayioBidAdapter.js

@@ -0,0 +1,157 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+
+const BIDDER_VERSION = '1.0.0';
+const BIDDER_CODE = 'displayio';
+const GVLID = 999;
+const BID_TTL = 300;
+const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
+const DEFAULT_CURRENCY = 'USD';
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+  isBidRequestValid: function(bid) {
+    return !!(bid.params && bid.params.placementId && bid.params.siteId &&
+      bid.params.adsSrvDomain && bid.params.cdnDomain);
+  },
+  buildRequests: function (bidRequests, bidderRequest) {
+    return bidRequests.map(bid => {
+      let url = '//' + bid.params.adsSrvDomain + '/srv?method=getPlacement&app=' +
+        bid.params.siteId + '&placement=' + bid.params.placementId;
+      const data = this._getPayload(bid, bidderRequest);
+      return {
+        method: 'POST',
+        headers: {'Content-Type': 'application/json;charset=utf-8'},
+        url,
+        data
+      };
+    });
+  },
+  interpretResponse: function (serverResponse, serverRequest) {
+    const ads = serverResponse.body.data.ads;
+    const bidResponses = [];
+    const { data } = serverRequest.data;
+    if (ads.length) {
+      const adData = ads[0].ad.data;
+      const bidResponse = {
+        requestId: data.id,
+        cpm: adData.ecpm,
+        width: adData.w,
+        height: adData.h,
+        netRevenue: true,
+        ttl: BID_TTL,
+        creativeId: adData.adId || 0,
+        currency: DEFAULT_CURRENCY,
+        referrer: data.data.ref,
+        mediaType: ads[0].ad.subtype,
+        ad: adData.markup,
+        placement: data.placement,
+        adData: adData
+      };
+      if (bidResponse.vastUrl === 'videoVast') {
+        bidResponse.vastUrl = adData.videos[0].url
+      }
+      bidResponses.push(bidResponse);
+    }
+    return bidResponses;
+  },
+  _getPayload: function (bid, bidderRequest) {
+    const connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection;
+    const userSession = 'us_web_xxxxxxxxxxxx'.replace(/[x]/g, c => {
+      let r = Math.random() * 16 | 0;
+      let v = c === 'x' ? r : (r & 0x3 | 0x8);
+      return v.toString(16);
+    });
+    const { params } = bid;
+    const { siteId, placementId } = params;
+    const { refererInfo, uspConsent, gdprConsent } = bidderRequest;
+    const mediation = {consent: '-1', gdpr: '-1'};
+    if (gdprConsent) {
+      if (gdprConsent.consentString !== undefined) {
+        mediation.consent = gdprConsent.consentString;
+      }
+      if (gdprConsent.gdprApplies !== undefined) {
+        mediation.gdpr = gdprConsent.gdprApplies ? '1' : '0';
+      }
+    }
+    const payload = {
+      userSession,
+      data: {
+        id: bid.bidId,
+        action: 'getPlacement',
+        app: siteId,
+        placement: placementId,
+        data: {
+          pagecat: params.pageCategory ? params.pageCategory.split(',').map(k => k.trim()) : [],
+          keywords: params.keywords ? params.keywords.split(',').map(k => k.trim()) : [],
+          lang_content: document.documentElement.lang,
+          lang: window.navigator.language,
+          domain: window.location.hostname,
+          page: window.location.href,
+          ref: refererInfo.referer,
+          userids: _getUserIDs(),
+          geo: '',
+        },
+        complianceData: {
+          child: '-1',
+          us_privacy: uspConsent,
+          dnt: window.navigator.doNotTrack,
+          iabConsent: {},
+          mediation: {
+            consent: mediation.consent,
+            gdpr: mediation.gdpr,
+          }
+        },
+        integration: 'JS',
+        omidpn: 'Displayio',
+        mediationPlatform: 0,
+        prebidVersion: BIDDER_VERSION,
+        device: {
+          w: window.screen.width,
+          h: window.screen.height,
+          connection_type: connection ? connection.effectiveType : '',
+        }
+      }
+    }
+    if (navigator.permissions) {
+      navigator.permissions.query({ name: 'geolocation' })
+        .then((result) => {
+          if (result.state === 'granted') {
+            payload.data.data.geo = _getGeoData();
+          }
+        });
+    }
+    return payload
+  }
+};
+
+function _getUserIDs () {
+  let ids = {};
+  try {
+    ids = window.owpbjs.getUserIdsAsEids();
+  } catch (e) {}
+  return ids;
+}
+
+async function _getGeoData () {
+  let geoData = null;
+  const getCurrentPosition = () => {
+    return new Promise((resolve, reject) =>
+      navigator.geolocation.getCurrentPosition(resolve, reject)
+    );
+  }
+  try {
+    const position = await getCurrentPosition();
+    let {latitude, longitude, accuracy} = position.coords;
+    geoData = {
+      'lat': latitude,
+      'lng': longitude,
+      'precision': accuracy
+    };
+  } catch (e) {}
+  return geoData
+}
+
+registerBidder(spec);