prebid.js 7.17.0 → 7.19.0

package/modules/growthCodeIdSystem.js

@@ -0,0 +1,164 @@
+/**
+ * This module adds GrowthCodeId to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/growthCodeIdSystem
+ * @requires module:modules/userId
+ */
+
+import {logError, logInfo, tryAppendQueryString} from '../src/utils.js';
+import {ajax} from '../src/ajax.js';
+import { submodule } from '../src/hook.js'
+import { getStorageManager } from '../src/storageManager.js';
+
+const GCID_EXPIRY = 45;
+const MODULE_NAME = 'growthCodeId';
+const GC_DATA_KEY = '_gc_data';
+const ENDPOINT_URL = 'https://p2.gcprivacy.com/v1/pb?'
+
+export const storage = getStorageManager({ gvlid: undefined, moduleName: MODULE_NAME });
+
+/**
+ * Read GrowthCode data from cookie or local storage
+ * @param key
+ * @return {string}
+ */
+export function readData(key) {
+  try {
+    if (storage.hasLocalStorage()) {
+      return storage.getDataFromLocalStorage(key);
+    }
+    if (storage.cookiesAreEnabled()) {
+      return storage.getCookie(key);
+    }
+  } catch (error) {
+    logError(error);
+  }
+}
+
+/**
+ * Store GrowthCode data in either cookie or local storage
+ * expiration date: 45 days
+ * @param key
+ * @param {string} value
+ */
+function storeData(key, value) {
+  try {
+    logInfo(MODULE_NAME + ': storing data: key=' + key + ' value=' + value);
+
+    if (value) {
+      if (storage.hasLocalStorage()) {
+        storage.setDataInLocalStorage(key, value);
+      }
+      const expiresStr = (new Date(Date.now() + (GCID_EXPIRY * (60 * 60 * 24 * 1000)))).toUTCString();
+      if (storage.cookiesAreEnabled()) {
+        storage.setCookie(key, value, expiresStr, 'LAX');
+      }
+    }
+  } catch (error) {
+    logError(error);
+  }
+}
+
+/**
+ * Parse json if possible, else return null
+ * @param data
+ * @param {object|null}
+ */
+function tryParse(data) {
+  try {
+    return JSON.parse(data);
+  } catch (err) {
+    logError(err);
+    return null;
+  }
+}
+
+/** @type {Submodule} */
+export const growthCodeIdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {{string}} value
+   * @returns {{growthCodeId: {string}}|undefined}
+   */
+  decode(value) {
+    return value && value !== '' ? { 'growthCodeId': value } : 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, consentData) {
+    const configParams = (config && config.params) || {};
+    if (!configParams || typeof configParams.pid !== 'string') {
+      logError('User ID - GrowthCodeID submodule requires a valid Partner ID to be defined');
+      return;
+    }
+
+    const gdpr = (consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies) ? 1 : 0;
+    const consentString = gdpr ? consentData.consentString : '';
+    if (gdpr && !consentString) {
+      logInfo('Consent string is required to call GrowthCode id.');
+      return;
+    }
+
+    let publisherId = configParams.publisher_id ? configParams.publisher_id : '_sharedID';
+
+    let sharedId;
+    if (configParams.publisher_id_storage === 'html5') {
+      sharedId = storage.getDataFromLocalStorage(publisherId, null) ? (storage.getDataFromLocalStorage(publisherId, null)) : null;
+    } else {
+      sharedId = storage.getCookie(publisherId, null) ? (storage.getCookie(publisherId, null)) : null;
+    }
+    if (!sharedId) {
+      logError('User ID - Publisher ID is not correctly setup.');
+    }
+
+    const resp = function(callback) {
+      let gcData = tryParse(readData(GC_DATA_KEY));
+      if (gcData) {
+        callback(gcData);
+      } else {
+        let segment = window.location.pathname.substr(1).replace(/\/+$/, '');
+        if (segment === '') {
+          segment = 'home';
+        }
+
+        let url = configParams.url ? configParams.url : ENDPOINT_URL;
+        url = tryAppendQueryString(url, 'pid', configParams.pid);
+        url = tryAppendQueryString(url, 'uid', sharedId);
+        url = tryAppendQueryString(url, 'u', window.location.href);
+        url = tryAppendQueryString(url, 'h', window.location.hostname);
+        url = tryAppendQueryString(url, 's', segment);
+        url = tryAppendQueryString(url, 'r', document.referrer);
+
+        ajax(url, {
+          success: response => {
+            let respJson = tryParse(response);
+            // If response is a valid json and should save is true
+            if (respJson) {
+              storeData(GC_DATA_KEY, JSON.stringify(respJson))
+              callback(respJson);
+            } else {
+              callback();
+            }
+          },
+          error: error => {
+            logError(MODULE_NAME + ': ID fetch encountered an error', error);
+            callback();
+          }
+        }, undefined, {method: 'GET', withCredentials: true})
+      }
+    };
+    return { callback: resp };
+  }
+};
+
+submodule('userId', growthCodeIdSubmodule);

package/modules/growthCodeIdSystem.md

@@ -0,0 +1,37 @@
+## GrowthCode User ID Submodule
+
+GrowthCode provides Id Enrichment for requests. 
+
+## Building Prebid with GrowthCode Support
+
+First, make sure to add the GrowthCode submodule to your Prebid.js package with:
+
+```
+gulp build --modules=growthCodeIdSystem,userId
+```
+
+The following configuration parameters are available:
+
+```javascript
+pbjs.setConfig({
+  userSync: {
+    userIds: [{
+      name: 'growthCodeId',
+      params: {
+          pid: 'TEST01', // Set your Partner ID here for production (obtained from Growthcode)
+          publisher_id: '_sharedID',
+          publisher_id_storage: 'html5'
+      }
+    }]
+  }
+});
+```
+
+| Param under userSync.userIds[] | Scope    | Type   | Description | Example         |
+|--------------------------------|----------|--------| --- |-----------------|
+| name                           | Required | String | The name of this module. | `"growthCodeId"` |
+| params                         | Required | Object | Details of module params. |                 |
+| params.pid                     | Required | String | This is the Parter ID value obtained from GrowthCode | `"TEST01"`        |
+| params.url | Optional | String | Custom URL for server | |
+| params.publisher_id | Optional | String | Name if the variable that holds your publisher ID | `"_sharedID"` |
+| params.publisher_id_storage | Optional | String | Publisher ID storage (cookie, html5) | `"html5"` |

package/modules/improvedigitalBidAdapter.js

@@ -307,10 +307,10 @@ const ID_REQUEST = {
     }
     // In the single request mode, split imps between those going to the ad server and those going to extend server
     if (extendImps.length) {
-      requests.push(formatRequest(extendImps, null, true));
+      requests.push(formatRequest(extendImps, bidderRequest.auctionId, true));
     }
     if (adServerImps.length) {
-      requests.push(formatRequest(adServerImps, null, false));
+      requests.push(formatRequest(adServerImps, bidderRequest.auctionId, false));
     }
 
     return requests;

package/modules/ixBidAdapter.js

@@ -13,7 +13,8 @@ import {
   logError,
   logWarn,
   mergeDeep,
-  parseQueryStringParameters
+  parseQueryStringParameters,
+  safeJSONParse
 } from '../src/utils.js';
 import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
 import {config} from '../src/config.js';
@@ -99,8 +100,46 @@ const VIDEO_PARAMS_ALLOW_LIST = [
   'playerSize', 'w', 'h'
 ];
 const LOCAL_STORAGE_KEY = 'ixdiag';
+export const LOCAL_STORAGE_FEATURE_TOGGLES_KEY = `${BIDDER_CODE}_features`;
 let hasRegisteredHandler = false;
 export const storage = getStorageManager({gvlid: GLOBAL_VENDOR_ID, bidderCode: BIDDER_CODE});
+export const FEATURE_TOGGLES = {
+  featureToggles: {},
+  isFeatureEnabled: function(ft) {
+    return deepAccess(this.featureToggles, `features.${ft}.activated`)
+  },
+  getFeatureToggles: function() {
+    if (storage.localStorageIsEnabled()) {
+      const parsedToggles = safeJSONParse(storage.getDataFromLocalStorage(LOCAL_STORAGE_FEATURE_TOGGLES_KEY));
+      if (deepAccess(parsedToggles, 'expiry') && parsedToggles.expiry >= new Date().getTime()) {
+        this.featureToggles = parsedToggles
+      } else {
+        this.clearFeatureToggles();
+      }
+    }
+  },
+  setFeatureToggles: function(serverResponse) {
+    const responseBody = serverResponse.body;
+    const expiryTime = new Date();
+    const toggles = deepAccess(responseBody, 'ext.features');
+
+    if (toggles) {
+      this.featureToggles = {
+        expiry: expiryTime.setHours(expiryTime.getHours() + 1),
+        features: toggles
+      }
+      if (storage.localStorageIsEnabled()) {
+        storage.setDataInLocalStorage(LOCAL_STORAGE_FEATURE_TOGGLES_KEY, JSON.stringify(this.featureToggles));
+      }
+    }
+  },
+  clearFeatureToggles: function() {
+    this.featureToggles = {};
+    if (storage.localStorageIsEnabled()) {
+      storage.removeDataFromLocalStorage(LOCAL_STORAGE_FEATURE_TOGGLES_KEY);
+    }
+  }
+};
 let siteID = 0;
 let gdprConsent = '';
 let usPrivacy = '';
@@ -578,6 +617,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   r.ext = {};
   r.ext.source = 'prebid';
   r.ext.ixdiag = {};
+  r.ext.ixdiag.ls = storage.localStorageIsEnabled();
   r.imp = [];
   r.at = 1;
 
@@ -602,13 +642,15 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
     r.ext.ixdiag.err = cachedErrors;
   }
 
+  // set source.tid to auctionId for outgoing request to Exchange.
+  r.source = {
+    tid: validBidRequests[0].auctionId,
+  }
+
   // if an schain is provided, send it along
   if (validBidRequests[0].schain) {
-    r.source = {
-      ext: {
-        schain: validBidRequests[0].schain
-      }
-    };
+    r.source.ext = {};
+    r.source.ext.schain = validBidRequests[0].schain;
   }
 
   if (userEids.length > 0) {
@@ -665,14 +707,17 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   // Use the siteId in the first bid request as the main siteId.
   siteID = validBidRequests[0].params.siteId;
   payload.s = siteID;
-  if (version) {
-    payload.v = version;
-  }
-  payload.ac = 'j';
-  payload.sd = 1;
 
-  if (version === VIDEO_ENDPOINT_VERSION) {
-    payload.nf = 1;
+  if (!FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+    if (version) {
+      payload.v = version;
+    }
+    payload.ac = 'j';
+    payload.sd = 1;
+
+    if (version === VIDEO_ENDPOINT_VERSION) {
+      payload.nf = 1;
+    }
   }
 
   // Parse additional runtime configs.
@@ -718,9 +763,11 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
       }
     }
 
-    // Create t in payload if timeout is configured.
-    if (typeof otherIxConfig.timeout === 'number') {
-      payload.t = otherIxConfig.timeout;
+    if (!FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+      // Create t in payload if timeout is configured.
+      if (typeof otherIxConfig.timeout === 'number') {
+        payload.t = otherIxConfig.timeout;
+      }
     }
   }
 
@@ -866,12 +913,27 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
       requestSequenceNumber++;
       clonedPayload.r = JSON.stringify(r);
 
-      requests.push({
-        method: 'GET',
-        url: baseUrl,
-        data: clonedPayload,
-        validBidRequests
-      });
+      let requestData;
+
+      if (FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+        requestData = {
+          method: 'POST',
+          url: baseUrl + '?s=' + payload.s,
+          data: deepClone(r),
+          option: {
+            contentType: 'text/plain',
+          },
+          validBidRequests
+        }
+      } else {
+        requestData = {
+          method: 'GET',
+          url: baseUrl,
+          data: clonedPayload,
+          validBidRequests
+        }
+      }
+      requests.push(requestData);
 
       currentRequestSize = baseRequestSize;
       r.imp = [];
@@ -1381,6 +1443,7 @@ export const spec = {
     const videoImps = {}; // Stores created video impressions
     const nativeImps = {}; // Stores created native impressions
     const missingBannerSizes = {}; // To capture the missing sizes i.e not configured for ix
+    FEATURE_TOGGLES.getFeatureToggles();
 
     // Step 1: Create impresssions from IX params
     validBidRequests.forEach((validBidRequest) => {
@@ -1451,6 +1514,7 @@ export const spec = {
     let bid = null;
 
     if (!serverResponse.hasOwnProperty('body') || !serverResponse.body.hasOwnProperty('seatbid')) {
+      FEATURE_TOGGLES.setFeatureToggles(serverResponse);
       return bids;
     }
 
@@ -1463,7 +1527,13 @@ export const spec = {
 
       // Transform rawBid in bid response to the format that will be accepted by prebid.
       const innerBids = seatbid[i].bid;
-      let requestBid = JSON.parse(bidderRequest.data.r);
+      let requestBid;
+
+      if (FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+        requestBid = bidderRequest.data;
+      } else {
+        requestBid = safeJSONParse(bidderRequest.data.r);
+      }
 
       for (let j = 0; j < innerBids.length; j++) {
         const bidRequest = getBidRequest(innerBids[j].impid, requestBid.imp, bidderRequest.validBidRequests);
@@ -1491,6 +1561,7 @@ export const spec = {
       }
     }
 
+    FEATURE_TOGGLES.setFeatureToggles(serverResponse);
     return bids;
   },
 

package/modules/liveIntentIdSystem.js

@@ -14,6 +14,7 @@ import { MinimalLiveConnect } from 'live-connect-js/esm/minimal-live-connect.js'
 
 const MODULE_NAME = 'liveIntentId';
 export const storage = getStorageManager({gvlid: null, moduleName: MODULE_NAME});
+const defaultRequestedAttributes = {'nonId': true}
 const calls = {
   ajaxGet: (url, onSuccess, onError, timeout) => {
     ajaxBuilder(timeout)(
@@ -57,6 +58,23 @@ function parseLiveIntentCollectorConfig(collectConfig) {
   return config;
 }
 
+/**
+ * Create requestedAttributes array to pass to liveconnect
+ * @function
+ * @param {Object} overrides - object with boolean values that will override defaults { 'foo': true, 'bar': false }
+ * @returns {Array}
+ */
+function parseRequestedAttributes(overrides) {
+  function createParameterArray(config) {
+    return Object.entries(config).flatMap(([k, v]) => (typeof v === 'boolean' && v) ? [k] : []);
+  }
+  if (typeof overrides === 'object') {
+    return createParameterArray({...defaultRequestedAttributes, ...overrides})
+  } else {
+    return createParameterArray(defaultRequestedAttributes);
+  }
+}
+
 function initializeLiveConnect(configParams) {
   configParams = configParams || {};
   if (liveConnect) {
@@ -66,7 +84,8 @@ function initializeLiveConnect(configParams) {
   const publisherId = configParams.publisherId || 'any';
   const identityResolutionConfig = {
     source: 'prebid',
-    publisherId: publisherId
+    publisherId: publisherId,
+    requestedAttributes: parseRequestedAttributes(configParams.requestedAttributesOverrides)
   };
   if (configParams.url) {
     identityResolutionConfig.url = configParams.url
@@ -136,9 +155,24 @@ export const liveIntentIdSubmodule = {
   decode(value, config) {
     const configParams = (config && config.params) || {};
     function composeIdObject(value) {
-      const base = { 'lipbid': value.unifiedId };
-      delete value.unifiedId;
-      return { 'lipb': { ...base, ...value } };
+      const result = {};
+
+      // old versions stored lipbid in unifiedId. Ensure that we can still read the data.
+      const lipbid = value.nonId || value.unifiedId
+      if (lipbid) {
+        value.lipbid = lipbid
+        delete value.unifiedId
+        result.lipb = value
+      }
+
+      // Lift usage of uid2 by exposing uid2 if we were asked to resolve it.
+      // As adapters are applied in lexicographical order, we will always
+      // be overwritten by the 'proper' uid2 module if it is present.
+      if (value.uid2) {
+        result.uid2 = { 'id': value.uid2 }
+      }
+
+      return result
     }
 
     if (!liveConnect) {
@@ -146,7 +180,7 @@ export const liveIntentIdSubmodule = {
     }
     tryFireEvent();
 
-    return (value && typeof value['unifiedId'] === 'string') ? composeIdObject(value) : undefined;
+    return composeIdObject(value);
   },
 
   /**

package/modules/mediakeysBidAdapter.js

@@ -572,7 +572,12 @@ function nativeBidResponseHandler(bid) {
           native.impressionTrackers.push(tracker.url);
           break;
         case 2:
-          native.javascriptTrackers = `<script src=\"${tracker.url}\"></script>`;
+          const script = `<script async src=\"${tracker.url}\"></script>`;
+          if (!native.javascriptTrackers) {
+            native.javascriptTrackers = script;
+          } else {
+            native.javascriptTrackers += `\n${script}`;
+          }
           break;
       }
     });

package/modules/mediakeysBidAdapter.md

@@ -14,9 +14,10 @@ Connects to Mediakeys demand source to fetch bids.
 
 ## Banner only Ad Unit
 
-```
-var adUnits = [
-{
+The Mediakeys adapter accepts any valid OpenRTB Spec 2.5 property.
+
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         banner: {
@@ -27,20 +28,26 @@ var adUnits = [
         bidder: 'mediakeys',
         params: {} // no params required.
     }]
-},
+}]
 ```
 
 ## Native only Ad Unit
 
 The Mediakeys adapter accepts two optional params for native requests. Please see the [OpenRTB Native Ads Specification](https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) for valid values.
 
-```
-var adUnits = [
-{
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         native: {
-            type: 'image',
+            title: {
+                required: true,
+                len: 120
+            },
+            image: {
+                required: true,
+                sizes: [300, 250]
+            }
         }
     },
     bids: [{
@@ -52,7 +59,7 @@ var adUnits = [
             }
         }
     }]
-},
+}]
 ```
 
 ## Video only Ad Unit
@@ -61,63 +68,65 @@ The Mediakeys adapter accepts any valid openRTB 2.5 video property. Properties c
 
 ### Outstream context
 
-```
-var adUnits = [
-{
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         video: {
             context: 'outstream',
-            playerSize: [300, 250],
+            playerSize: [1280, 720],
             // additional OpenRTB video params
             // placement: 2,
             // api: [1],
             // …
+            mimes: ['video/mp4'],
+            protocols: [2, 3],
+            skip: 0
         }
     },
     renderer: {
         url: 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js',
+        // the render method must fetch the vast xml document before displaying video
         render: function (bid) {
-            var bidReqConfig = pbjs.adUnits.find(bidReq => bidReq.bidId === bid.impid);
-
-            if (bidReqConfig && bidReqConfig.mediaTypes && bidReqConfig.mediaTypes.video && bidReqConfig.mediaTypes.video.context === 'outstream') {
-                var adResponse = fetch(bid.vastUrl).then(resp => resp.text()).then(text => ({
-                    ad: {
-                        video: {
-                            content: text,
-                            player_width: bid.width || bidReqConfig.mediaTypes.video.playerSize[0],
-                            player_height: bid.height || bidReqConfig.mediaTypes.video.playerSize[1],
-                        }
+            var adResponse = fetch(bid.vastUrl).then(resp => resp.text()).then(text => ({
+                ad: {
+                    video: {
+                        content: text,
+                        player_height: bid.playerHeight,
+                        player_width: bid.playerWidth
                     }
-                }))
-
-                adResponse.then((ad) => {
-                    bid.renderer.push(() => {
-                        ANOutstreamVideo.renderAd({
-                            targetId: bid.adUnitCode,
-                            adResponse: ad
-                        });
+                }
+            }))
+
+            adResponse.then((content) => {
+                bid.renderer.push(() => {
+                    ANOutstreamVideo.renderAd({
+                        targetId: bid.adUnitCode,
+                        adResponse: content
                     });
-                })
-            }
+                });
+            })
         }
     },
     bids: [{
         bidder: 'mediakeys',
         params: {
             video: {
-                // additional OpenRTB video params. Will be merged with params defined at mediaTypes level
+                // additional OpenRTB video params.
+                // will be merged with params defined at mediaTypes level
+                api: [1]
             }
         }
     }]
-},
+}]
 ```
 
 ### Instream context
 
-```
-var adUnits = [
-{
+For Instream Video, you have to enable the Instream Tracking Module to have Prebid emit the onBidWon required event.
+
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         video: {
@@ -132,8 +141,9 @@ var adUnits = [
     bids: [{
         bidder: 'mediakeys',
         params: {
-            // additional OpenRTB video params. Will be merged with params defined at mediaTypes level
+            // additional OpenRTB video params.
+            // will be merged with params defined at mediaTypes level
         }
     }]
-},
+}]
 ```

package/modules/nativoBidAdapter.js

@@ -145,7 +145,7 @@ export const spec = {
         'params.url',
       )
       if (pageUrl == undefined || pageUrl === '') {
-        pageUrl = bidderRequest.refererInfo.page
+        pageUrl = bidderRequest.refererInfo.location
       }
 
       placementId = deepAccess(bidRequest, 'params.placementId')
@@ -465,8 +465,9 @@ export function parseFloorPriceData(bidRequest) {
     // Setup price floor data per media type
     let mediaTypeData = bidMediaTypes[mediaType]
     let mediaTypeFloorPriceData = {}
+    let mediaTypeSizes = mediaTypeData.sizes || mediaTypeData.playerSize || [];
     // Step through each size of the media type so we can get floor data for each size per media type
-    mediaTypeData.sizes.forEach((size) => {
+    mediaTypeSizes.forEach((size) => {
       // Get floor price data per the getFloor method and respective media type / size combination
       const priceFloorData = bidRequest.getFloor({
         currency: FLOOR_PRICE_CURRENCY,