prebid.js 6.5.0 → 6.6.0

package/modules/.submodules.json

@@ -35,7 +35,8 @@
     "uid2IdSystem",
     "unifiedIdSystem",
     "verizonMediaIdSystem",
-    "zeotapIdPlusIdSystem"
+    "zeotapIdPlusIdSystem",
+    "adqueryIdSystem"
   ],
   "adpod": [
     "freeWheelAdserverVideo",

package/modules/adkernelBidAdapter.js

@@ -77,7 +77,8 @@ export const spec = {
     {code: 'unibots'},
     {code: 'catapultx'},
     {code: 'ergadx'},
-    {code: 'turktelekom'}
+    {code: 'turktelekom'},
+    {code: 'felixads'}
   ],
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
 

package/modules/admanBidAdapter.js

@@ -1,10 +1,11 @@
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import { isFn, deepAccess, logMessage } from '../src/utils.js';
+import {config} from '../src/config.js';
 
 const BIDDER_CODE = 'adman';
 const AD_URL = 'https://pub.admanmedia.com/?c=o&m=multi';
-const URL_SYNC = 'https://pub.admanmedia.com/?c=o&m=sync';
+const URL_SYNC = 'https://pub.admanmedia.com';
 
 function isBidResponseValid(bid) {
   if (!bid.requestId || !bid.cpm || !bid.creativeId ||
@@ -152,19 +153,24 @@ export const spec = {
   },
 
   getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
-    let syncUrl = URL_SYNC
+    let syncType = syncOptions.iframeEnabled ? 'iframe' : 'image';
+    let syncUrl = URL_SYNC + `/${syncType}?pbjs=1`;
     if (gdprConsent && gdprConsent.consentString) {
       if (typeof gdprConsent.gdprApplies === 'boolean') {
         syncUrl += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
       } else {
-        syncUrl += `&gdpr==0&gdpr_consent=${gdprConsent.consentString}`;
+        syncUrl += `&gdpr=0&gdpr_consent=${gdprConsent.consentString}`;
       }
     }
     if (uspConsent && uspConsent.consentString) {
       syncUrl += `&ccpa_consent=${uspConsent.consentString}`;
     }
+
+    const coppa = config.getConfig('coppa') ? 1 : 0;
+    syncUrl += `&coppa=${coppa}`;
+
     return [{
-      type: 'image',
+      type: syncType,
       url: syncUrl
     }];
   }

package/modules/adomikAnalyticsAdapter.js

@@ -14,6 +14,8 @@ const bidWon = CONSTANTS.EVENTS.BID_WON;
 const bidTimeout = CONSTANTS.EVENTS.BID_TIMEOUT;
 const ua = navigator.userAgent;
 
+var _sampled = true;
+
 let adomikAdapter = Object.assign(adapter({}),
   {
     // Track every event needed
@@ -81,6 +83,7 @@ adomikAdapter.sendTypedEvent = function() {
     uid: adomikAdapter.currentContext.uid,
     ahbaid: adomikAdapter.currentContext.id,
     hostname: window.location.hostname,
+    sampling: adomikAdapter.currentContext.sampling,
     eventsByPlacementCode: groupedTypedEvents.map(function(typedEventsByType) {
       let sizes = [];
       const eventKeys = ['request', 'response', 'winner'];
@@ -203,19 +206,28 @@ adomikAdapter.adapterEnableAnalytics = adomikAdapter.enableAnalytics;
 
 adomikAdapter.enableAnalytics = function (config) {
   adomikAdapter.currentContext = {};
-
   const initOptions = config.options;
-  if (initOptions) {
-    adomikAdapter.currentContext = {
-      uid: initOptions.id,
-      url: initOptions.url,
-      testId: initOptions.testId,
-      testValue: initOptions.testValue,
-      id: '',
-      timeouted: false,
+
+  _sampled = typeof config === 'undefined' ||
+             typeof config.sampling === 'undefined' ||
+             Math.random() < parseFloat(config.sampling);
+
+  if (_sampled) {
+    if (initOptions) {
+      adomikAdapter.currentContext = {
+        uid: initOptions.id,
+        url: initOptions.url,
+        testId: initOptions.testId,
+        testValue: initOptions.testValue,
+        id: '',
+        timeouted: false,
+        sampling: config.sampling
+      }
+      logInfo('Adomik Analytics enabled with config', initOptions);
+      adomikAdapter.adapterEnableAnalytics(config);
     }
-    logInfo('Adomik Analytics enabled with config', initOptions);
-    adomikAdapter.adapterEnableAnalytics(config);
+  } else {
+    logInfo('Adomik Analytics ignored for sampling', config.sampling);
   }
 };
 

package/modules/adqueryIdSystem.js

@@ -0,0 +1,103 @@
+/**
+ * This module adds Adquery QID to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/adqueryIdSystem
+ * @requires module:modules/userId
+ */
+
+import {ajax} from '../src/ajax.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {submodule} from '../src/hook.js';
+import * as utils from '../src/utils.js';
+
+const MODULE_NAME = 'qid';
+const AU_GVLID = 902;
+
+export const storage = getStorageManager(AU_GVLID, 'qid');
+
+/**
+ * Param or default.
+ * @param {String} param
+ * @param {String} defaultVal
+ */
+function paramOrDefault(param, defaultVal, arg) {
+  if (utils.isFn(param)) {
+    return param(arg);
+  } else if (utils.isStr(param)) {
+    return param;
+  }
+  return defaultVal;
+}
+
+/** @type {Submodule} */
+export const adqueryIdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+
+  /**
+   * IAB TCF Vendor ID
+   * @type {string}
+   */
+  gvlid: AU_GVLID,
+
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {{value:string}} value
+   * @returns {{qid:Object}}
+   */
+  decode(value) {
+    let qid = storage.getDataFromLocalStorage('qid');
+    if (utils.isStr(qid)) {
+      return {qid: qid};
+    }
+    return (value && typeof value['qid'] === 'string') ? { 'qid': value['qid'] } : undefined;
+  },
+  /**
+   * performs action to obtain id and return a value in the callback's response argument
+   * @function
+   * @param {SubmoduleConfig} [config]
+   * @returns {IdResponse|undefined}
+   */
+  getId(config) {
+    if (!utils.isPlainObject(config.params)) {
+      config.params = {};
+    }
+    const url = paramOrDefault(config.params.url,
+      `https://bidder.adquery.io/prebid/qid`,
+      config.params.urlArg);
+
+    const resp = function (callback) {
+      let qid = storage.getDataFromLocalStorage('qid');
+      if (utils.isStr(qid)) {
+        const responseObj = {qid: qid};
+        callback(responseObj);
+      } else {
+        const callbacks = {
+          success: response => {
+            let responseObj;
+            if (response) {
+              try {
+                responseObj = JSON.parse(response);
+              } catch (error) {
+                utils.logError(error);
+              }
+            }
+            callback(responseObj);
+          },
+          error: error => {
+            utils.logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+            callback();
+          }
+        };
+        ajax(url, callbacks, undefined, {method: 'GET'});
+      }
+    };
+    return {callback: resp};
+  }
+};
+
+submodule('userId', adqueryIdSubmodule);

package/modules/adqueryIdSystem.md

@@ -0,0 +1,35 @@
+# Adquery QID
+
+Adquery QID Module. For assistance setting up your module please contact us at [prebid@adquery.io](prebid@adquery.io).
+
+### Prebid Params
+
+Individual params may be set for the Adquery ID Submodule. At least one identifier must be set in the params.
+
+```
+pbjs.setConfig({
+    usersync: {
+        userIds: [{
+            name: 'qid',
+            storage: {
+                name: 'qid',
+                type: 'html5'
+            }
+        }]
+    }
+});
+```
+## Parameter Descriptions for the `usersync` Configuration Section
+The below parameters apply only to the Adquery User ID Module integration.
+
+| Param under usersync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | ID value for the Adquery ID module - `"qid"` | `"qid"` |
+| storage | Required | Object | The publisher must specify the local storage in which to store the results of the call to get the user ID. | |
+| storage.type | Required | String | This is where the results of the user ID will be stored. The recommended method is `localStorage` by specifying `html5`. | `"html5"` |
+| storage.name | Required | String | The name of the html5 local storage where the user ID will be stored. | `"qid"` |
+| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. | `365` |
+| value | Optional | Object | Used only if the page has a separate mechanism for storing the Adquery ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage | `{"qid": "2abf9f001fcd81241b67"}` |
+| params | Optional | Object | Used to store params for the id system |
+| params.url | Optional | String | Set an alternate GET url for qid with this parameter |
+| params.urlArg | Optional | Object | Optional url parameter for params.url |

package/modules/bliinkBidAdapter.js

@@ -1,7 +1,6 @@
 // eslint-disable-next-line prebid/validate-imports
 // eslint-disable-next-line prebid/validate-imports
 import {registerBidder} from '../src/adapters/bidderFactory.js'
-
 export const BIDDER_CODE = 'bliink'
 export const BLIINK_ENDPOINT_ENGINE = 'https://engine.bliink.io/delivery'
 export const BLIINK_ENDPOINT_ENGINE_VAST = 'https://engine.bliink.io/vast'
@@ -174,6 +173,8 @@ export const buildRequests = (_, bidderRequest) => {
     pageUrl: bidderRequest.refererInfo.referer,
     pageDescription: getMetaValue(META_DESCRIPTION),
     keywords: getKeywords().join(','),
+    gdpr: false,
+    gdpr_consent: '',
     pageTitle: document.title,
   }
 

package/modules/compassBidAdapter.js

@@ -28,16 +28,23 @@ function isBidResponseValid(bid) {
 function getPlacementReqData(bid) {
   const { params, bidId, mediaTypes } = bid;
   const schain = bid.schain || {};
-  const { placementId } = params;
+  const { placementId, endpointId } = params;
   const bidfloor = getBidFloor(bid);
 
   const placement = {
-    placementId,
     bidId,
     schain,
     bidfloor
   };
 
+  if (placementId) {
+    placement.placementId = placementId;
+    placement.type = 'publisher';
+  } else if (endpointId) {
+    placement.endpointId = endpointId;
+    placement.type = 'network';
+  }
+
   if (mediaTypes && mediaTypes[BANNER]) {
     placement.adFormat = BANNER;
     placement.sizes = mediaTypes[BANNER].sizes;

package/modules/criteoBidAdapter.js

@@ -24,7 +24,7 @@ const LOG_PREFIX = 'Criteo: ';
   Unminified source code can be found in the privately shared repo: https://github.com/Prebid-org/prebid-js-external-js-criteo/blob/master/dist/prod.js
 */
 const FAST_BID_VERSION_PLACEHOLDER = '%FAST_BID_VERSION%';
-export const FAST_BID_VERSION_CURRENT = 116;
+export const FAST_BID_VERSION_CURRENT = 117;
 const FAST_BID_VERSION_LATEST = 'latest';
 const FAST_BID_VERSION_NONE = 'none';
 const PUBLISHER_TAG_URL_TEMPLATE = 'https://static.criteo.net/js/ld/publishertag.prebid' + FAST_BID_VERSION_PLACEHOLDER + '.js';

package/modules/criteoIdSystem.js

@@ -33,15 +33,37 @@ function getFromAllStorages(key) {
   return storage.getCookie(key) || storage.getDataFromLocalStorage(key);
 }
 
-function saveOnAllStorages(key, value) {
+function saveOnAllStorages(key, value, hostname) {
   if (key && value) {
-    storage.setCookie(key, value, expirationString);
     storage.setDataInLocalStorage(key, value);
+    setCookieOnAllDomains(key, value, expirationString, hostname, true);
   }
 }
 
-function deleteFromAllStorages(key) {
-  storage.setCookie(key, '', pastDateString);
+function setCookieOnAllDomains(key, value, expiration, hostname, stopOnSuccess) {
+  const subDomains = hostname.split('.');
+  for (let i = 0; i < subDomains.length; ++i) {
+    // Try to write the cookie on this subdomain (we want it to be stored only on the TLD+1)
+    const domain = subDomains.slice(subDomains.length - i - 1, subDomains.length).join('.');
+
+    try {
+      storage.setCookie(key, value, expiration, null, '.' + domain);
+
+      if (stopOnSuccess) {
+        // Try to read the cookie to check if we wrote it
+        const ck = storage.getCookie(key);
+        if (ck && ck === value) {
+          break;
+        }
+      }
+    } catch (error) {
+
+    }
+  }
+}
+
+function deleteFromAllStorages(key, hostname) {
+  setCookieOnAllDomains(key, '', pastDateString, hostname, true);
   storage.removeDataFromLocalStorage(key);
 }
 
@@ -89,15 +111,15 @@ function callCriteoUserSync(parsedCriteoData, gdprString, callback) {
         const urlsToCall = typeof jsonResponse.acwsUrl === 'string' ? [jsonResponse.acwsUrl] : jsonResponse.acwsUrl;
         urlsToCall.forEach(url => triggerPixel(url));
       } else if (jsonResponse.bundle) {
-        saveOnAllStorages(bundleStorageKey, jsonResponse.bundle);
+        saveOnAllStorages(bundleStorageKey, jsonResponse.bundle, domain);
       }
 
       if (jsonResponse.bidId) {
-        saveOnAllStorages(bididStorageKey, jsonResponse.bidId);
+        saveOnAllStorages(bididStorageKey, jsonResponse.bidId, domain);
         const criteoId = { criteoId: jsonResponse.bidId };
         callback(criteoId);
       } else {
-        deleteFromAllStorages(bididStorageKey);
+        deleteFromAllStorages(bididStorageKey, domain);
         callback();
       }
     },

package/modules/glimpseBidAdapter.js

@@ -40,28 +40,21 @@ export const spec = {
    * @returns {ServerRequest}
    */
   buildRequests: (validBidRequests, bidderRequest) => {
-    const demo = config.getConfig('glimpse.demo') || false
-    const account = config.getConfig('glimpse.account') || -1
-    const demand = config.getConfig('glimpse.demand') || 'glimpse'
-    const keywords = config.getConfig('glimpse.keywords') || {}
-
     const auth = getVaultJwt()
     const referer = getReferer(bidderRequest)
     const gdprConsent = getGdprConsentChoice(bidderRequest)
-    const bids = validBidRequests.map((bidRequest) => {
-      return processBidRequest(bidRequest, keywords)
-    })
+    const bidRequests = validBidRequests.map(processBidRequest)
+    const firstPartyData = getFirstPartyData()
 
     const data = {
       auth,
       data: {
-        bidderCode: spec.code,
-        demo,
-        account,
-        demand,
         referer,
         gdprConsent,
-        bids,
+        bidRequests,
+        site: firstPartyData.site,
+        user: firstPartyData.user,
+        bidderCode: spec.code,
       }
     }
 
@@ -91,35 +84,12 @@ export const spec = {
   },
 }
 
-function processBidRequest(bidRequest, globalKeywords) {
-  const sizes = normalizeSizes(bidRequest.sizes)
-  const bidKeywords = bidRequest.params.keywords || {}
-  const keywords = {
-    ...globalKeywords,
-    ...bidKeywords,
-  }
-
-  return {
-    unitCode: bidRequest.adUnitCode,
-    bidId: bidRequest.bidId,
-    placementId: bidRequest.params.placementId,
-    keywords,
-    sizes,
-  }
+function setVaultJwt(auth) {
+  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.vault.jwt, auth)
 }
 
-function normalizeSizes(sizes) {
-  const isSingleSize =
-    isArray(sizes) &&
-    sizes.length === 2 &&
-    !isArray(sizes[0]) &&
-    !isArray(sizes[1])
-
-  if (isSingleSize) {
-    return [sizes]
-  }
-
-  return sizes
+function getVaultJwt() {
+  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.vault.jwt) || ''
 }
 
 function getReferer(bidderRequest) {
@@ -158,12 +128,64 @@ function getGdprConsentChoice(bidderRequest) {
   }
 }
 
-function setVaultJwt(auth) {
-  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.vault.jwt, auth)
+function processBidRequest(bidRequest) {
+  const demand = bidRequest.params.demand || 'glimpse'
+  const sizes = normalizeSizes(bidRequest.sizes)
+  const keywords = bidRequest.params.keywords || {}
+
+  return {
+    demand,
+    sizes,
+    keywords,
+    bidId: bidRequest.bidId,
+    placementId: bidRequest.params.placementId,
+    unitCode: bidRequest.adUnitCode,
+  }
 }
 
-function getVaultJwt() {
-  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.vault.jwt) || ''
+function normalizeSizes(sizes) {
+  const isSingleSize =
+    isArray(sizes) &&
+    sizes.length === 2 &&
+    !isArray(sizes[0]) &&
+    !isArray(sizes[1])
+
+  if (isSingleSize) {
+    return [sizes]
+  }
+
+  return sizes
+}
+
+function getFirstPartyData() {
+  const siteKeywords = parseGlobalKeywords('site')
+  const userKeywords = parseGlobalKeywords('user')
+
+  const siteAttributes = getConfig('ortb2.site.ext.data', {})
+  const userAttributes = getConfig('ortb2.user.ext.data', {})
+
+  return {
+    site: {
+      keywords: siteKeywords,
+      attributes: siteAttributes,
+    },
+    user: {
+      keywords: userKeywords,
+      attributes: userAttributes,
+    },
+  }
+}
+
+function parseGlobalKeywords(scope) {
+  const keywords = getConfig(`ortb2.${scope}.keywords`, '')
+
+  return keywords
+    .split(', ')
+    .filter((keyword) => keyword !== '')
+}
+
+function getConfig(path, defaultValue) {
+  return config.getConfig(path) || defaultValue
 }
 
 function isValidBidResponse(bidResponse) {

package/modules/idImportLibrary.js

@@ -9,6 +9,7 @@ let conf;
 const LOG_PRE_FIX = 'ID-Library: ';
 const CONF_DEFAULT_OBSERVER_DEBOUNCE_MS = 250;
 const CONF_DEFAULT_FULL_BODY_SCAN = false;
+const CONF_DEFAULT_INPUT_SCAN = false;
 const OBSERVER_CONFIG = {
   subtree: true,
   attributes: true,
@@ -78,7 +79,13 @@ function targetAction(mutations, observer) {
   }
 }
 
-function addInputElementsElementListner(conf) {
+function addInputElementsElementListner() {
+  if (doesInputElementsHaveEmail()) {
+    _logInfo('Email found in input elements ' + email);
+    _logInfo('Post data on email found in target without');
+    postData();
+    return;
+  }
   _logInfo('Adding input element listeners');
   const inputs = document.querySelectorAll('input[type=text], input[type=email]');
 
@@ -89,6 +96,19 @@ function addInputElementsElementListner(conf) {
   }
 }
 
+function addFormInputElementsElementListner(id) {
+  _logInfo('Adding input element listeners');
+  if (doesFormInputElementsHaveEmail(id)) {
+    _logInfo('Email found in input elements ' + email);
+    postData();
+    return;
+  }
+  _logInfo('Adding input element listeners');
+  const input = document.getElementById(id);
+  input.addEventListener('change', event => processInputChange(event));
+  input.addEventListener('blur', event => processInputChange(event));
+}
+
 function removeInputElementsElementListner() {
   _logInfo('Removing input element listeners');
   const inputs = document.querySelectorAll('input[type=text], input[type=email]');
@@ -149,12 +169,6 @@ function handleTargetElement() {
 }
 
 function handleBodyElements() {
-  if (doesInputElementsHaveEmail()) {
-    _logInfo('Email found in input elements ' + email);
-    _logInfo('Post data on email found in target without');
-    postData();
-    return;
-  }
   email = getEmail(document.body.innerHTML);
   if (email !== null) {
     _logInfo('Email found in body ' + email);
@@ -162,7 +176,7 @@ function handleBodyElements() {
     postData();
     return;
   }
-  addInputElementsElementListner();
+
   if (conf.fullscan === true) {
     const bodyObserver = new MutationObserver(debounce(bodyAction, conf.debounce, false));
     bodyObserver.observe(document.body, OBSERVER_CONFIG);
@@ -182,6 +196,17 @@ function doesInputElementsHaveEmail() {
   return false;
 }
 
+function doesFormInputElementsHaveEmail(formElementId) {
+  const input = document.getElementById(formElementId);
+  if (input) {
+    email = getEmail(input.value);
+    if (email !== null) {
+      return true;
+    }
+  }
+  return false;
+}
+
 function syncCallback() {
   return {
     success: function () {
@@ -213,6 +238,10 @@ function associateIds() {
   if (window.MutationObserver || window.WebKitMutationObserver) {
     if (conf.target) {
       handleTargetElement();
+    } else if (conf.formElementId) {
+      addFormInputElementsElementListner(conf.formElementId);
+    } else if (conf.inputscan) {
+      addInputElementsElementListner();
     } else {
       handleBodyElements();
     }
@@ -236,6 +265,14 @@ export function setConfig(config) {
     config.fullscan = CONF_DEFAULT_FULL_BODY_SCAN;
     _logInfo('Set default fullscan ' + CONF_DEFAULT_FULL_BODY_SCAN);
   }
+  if (typeof config.inputscan !== 'boolean') {
+    config.inputscan = CONF_DEFAULT_INPUT_SCAN;
+    _logInfo('Set default input scan ' + CONF_DEFAULT_INPUT_SCAN);
+  }
+
+  if (typeof config.formElementId == 'string') {
+    _logInfo('Looking for formElementId ' + config.formElementId);
+  }
   conf = config;
   associateIds();
 }

package/modules/idImportLibrary.md

@@ -8,6 +8,8 @@
 | `url`      | Yes      | String  | N/A     | URL endpoint used to post the hashed email and user IDs. |
 | `debounce` | No       | Number  | 250     | Time in milliseconds before the email and IDs are fetched. |
 | `fullscan` | No       | Boolean | false   | Enable/disable a full page body scan to get email. |
+| `formElementId`   | No      | String  | N/A     | ID attribute of the input (type=text/email)  from which the email can be read. |
+| `inputscan`   | No      | Boolean  | N/A     | Enable/disable a input element (type=text/email) scan to get email. |
 
 ## Example
 
@@ -18,5 +20,7 @@ pbjs.setConfig({
         url: 'https://example.com',
         debounce: 250,
         fullscan: false,
+        inputscan: false,
+        formElementId: "userid"
     },
 });