prebid.js 6.24.0 → 6.26.0

package/modules/ixBidAdapter.md

@@ -70,10 +70,10 @@ object are detailed here.
 | siteId | Required | String | An IX-specific identifier that is associated with this ad unit. It will be associated to the single size, if the size is provided. This is similar to a placement ID or an ad unit ID that some other modules have. Examples: `'3723'`, `'6482'`, `'3639'`
 | size | Optional (Deprecated)| Number[] | The single size associated with the site ID. It should be one of the sizes listed in the ad unit under `adUnits[].sizes` or `adUnits[].mediaTypes.video.playerSize`. Examples: `[300, 250]`, `[300, 600]`
 | video | Optional | Hash | The video object will serve as the properties of the video ad. You can create any field under the video object that is mentioned in the `OpenRTB Spec v2.5`. Some fields like `mimes, protocols, minduration, maxduration` are required. Properties not defined at this level, will be pulled from the Adunit level.
-|video.w| Required | Integer | The video player size width in pixels that will be passed to demand partners.
-|video.h| Required | Integer | The video player size height in pixels that will be passed to demand partners.
-|video.playerSize| Optional* | Integer | The video player size that will be passed to demand partners. * In the absence of `video.w` and `video.h`, this field is required.
-| video.mimes | Required | String[] | Array list of content MIME types supported. Popular MIME types include, but are not limited to, `"video/x-ms- wmv"` for Windows Media and `"video/x-flv"` for Flash Video.
+|video.w| Required | Integer | The width of the video player in pixels that will be passed to demand partners.<br /> *If you are using Index’s outstream player and have placed the `video` object at the `bidder` level, this is a required field. You must define the size of the video player using the `video.w` and `video.h` parameters, with a minimum video player size of 300 x 250.
+|video.h| Required | Integer | The height of the video player in pixels that will be passed to demand partners. <br />*If you are using Index’s outstream player and have placed the `video` object at the `bidder` level, this is a required field. You must define the size of the video player using the `video.w` and `video.h` parameters, with a minimum video player size of 300 x 250.
+|video.playerSize| Optional* | Array[Integer,Integer] | The video player size that will be passed to demand partners.</br /> *If you are using Index’s outstream player and have placed the `video` object at the `adUnit` level, this is a required field. You must define the size of the video player using this parameter, with a minimum video player size of 300 x 250.
+| video.mimes | Required | String[] | If you are using Index’s outstream video player and want to learn more about what is supported, see [List of supported OpenRTB bid request fields for Sellers](https://kb.indexexchange.com/publishers/openrtb_integration/list_of_supported_openrtb_bid_request_fields_for_sellers.htm#Video).
 |video.minduration| Required | Integer | Minimum video ad duration in seconds.
 |video.maxduration| Required | Integer | Maximum video ad duration in seconds.
 |video.protocol / video.protocols| Required | Integer / Integer[] | Either a single protocol provided as an integer, or protocols provided as a list of integers. `2` - VAST 2.0, `3` - VAST 3.0, `5` - VAST 2.0 Wrapper, `6` - VAST 3.0 Wrapper
@@ -111,9 +111,7 @@ Both video and banner params will be read from the `adUnits[].mediaTypes.video`
 The examples in this guide assume the following starting configuration (you may remove banner or video, if either does not apply).
 
 
-In regards to video, `context` can either be `'instream'` or `'outstream'`. Note that `outstream` requires additional configuration on the adUnit.
-
-
+In regards to video, `context` can either be `'instream'` or `'outstream'`.
 
 ```javascript
 var adUnits = [{
@@ -195,9 +193,9 @@ var adUnits = [{
             context: 'instream',
             playerSize: [300, 250],
             mimes: [
-                    'video/mp4',
-                    'video/webm'
-                ],
+                'video/mp4',
+                'video/webm'
+            ],
             minduration: 0,
             maxduration: 60,
             protocols: [6]
@@ -224,45 +222,47 @@ Please note that you can re-use the existing `siteId` within the same flex
 position.
 
 **Video (Outstream):**
-Note that currently, outstream video rendering must be configured by the publisher. In the adUnit, a `renderer` object must be defined, which includes a `url` pointing to the video rendering script, and a `render` function for creating the video player. See http://prebid.org/dev-docs/show-outstream-video-ads.html for more information.
+
+Publishers have two options to receive outstream video demand from Index:
+* Using Index’s outstream video player
+* In an outstream video configuration set up by the publisher. For more information, see [Prebid’s documentation on how to show video ads.](https://docs.prebid.org/dev-docs/show-outstream-video-ads.html)
+
+**Index’s outstream video player**
+Publishers who are using Index as a bidding adapter in Prebid.js can show outstream video ads on their site from us by using Index’s outstream video player. This allows a video ad to display inside of a video player and can be placed anywhere on a publisher’s site, such as in-article, in-feed, and more.
+
+Define a new `video` object for our outstream video player at either the adUnit level or the `bidder` level. If you are setting it at the bidder level, define the size of the video player using the parameters `video.h` and `video.w`. If you are setting it at the `adUnit` level, define the size using video.playerSize.
+
+For more information on how to structure the `video` object, refer to the following code example:
+
 
 ```javascript
 var adUnits = [{
-    code: 'video-div-a',
+    code: 'div-gpt-ad-1571167646410-1',
     mediaTypes: {
         video: {
+            playerSize: [640, 360],
             context: 'outstream',
-            playerSize: [300, 250],
-            mimes: [
-                    'video/mp4',
-                    'video/webm'
-                ],
-            minduration: 0,
-            maxduration: 60,
-            protocols: [6]
-        }
-    },
-    renderer: {
-        url: 'https://test.com/my-video-player.js',
-        render: function (bid) {
-            ...
+            api: [2],
+            protocols: [2, 3, 5, 6],
+            minduration: 5,
+            maxduration: 30,
+            mimes: ['video/mp4', 'application/javascript'],
+            placement: 3
         }
     },
     bids: [{
         bidder: 'ix',
         params: {
-            siteId: '12345',
-            video: {
-                // If required, use this to override mediaTypes.video.XX properties   
-            }
+            siteId: '715964'
         }
     }]
 }];
 ```
+<em>Please note that your use of the outstream video player will be governed by and subject to the terms and conditions of i) any master services or license agreement entered into by you and Index Exchange; ii) the information provided on our knowledge base linked [here](https://kb.indexexchange.com/publishers/prebid_integration/outstream_video_prebidjs.htm) and [here](https://kb.indexexchange.com/publishers/guidelines/standard_contractual_clauses.htm), and iii) our [Privacy Policy](https://www.indexexchange.com/privacy/). Your use of Index’s outstream video player constitutes your acknowledgement and acceptance of the foregoing. </em>
 
 #### Video Caching
 
-Note that the IX adapter expects a client-side Prebid Cache to be enabled for video bidding.
+Note that the IX adapter expects a client-side Prebid Cache to be enabled for instream video bidding.
 
 ```
 pbjs.setConfig({
@@ -293,21 +293,21 @@ pbjs.setConfig({
 By default, the IX bidding adapter bids on all banner sizes available in the ad unit when configured to at least one banner size. If you want the IX bidding adapter to only bid on the banner size it’s configured to, switch off this feature using `detectMissingSizes`.
 ```
 pbjs.setConfig({
-                ix: {
-                    detectMissingSizes: false
-                }
-            });
+    ix: {
+        detectMissingSizes: false
+    }
+});
 ```
 OR
 ```
 pbjs.setBidderConfig({
-                bidders: ["ix"],
-                config: {
-                    ix: {
-                        detectMissingSizes: false
-                    }
-                }
-            });
+    bidders: ["ix"],
+    config: {
+        ix: {
+            detectMissingSizes: false
+        }
+    }
+});
 ```
 
 ### 2. Include `ixBidAdapter` in your build process

package/modules/jixieBidAdapter.js

@@ -184,6 +184,7 @@ export const spec = {
     let ids = fetchIds_();
     let eids = [];
     let miscDims = internal.getMiscDims();
+    let schain = deepAccess(validBidRequests[0], 'schain');
 
     // all available user ids are sent to our backend in the standard array layout:
     if (validBidRequests[0].userId) {
@@ -209,6 +210,7 @@ export const spec = {
       mkeywords: miscDims.mkeywords,
       bids: bids,
       eids: eids,
+      schain: schain,
       pricegranularity: pg,
       cfg: jixieCfgBlob
     }, ids);

package/modules/kargoBidAdapter.js

@@ -70,27 +70,42 @@ export const spec = {
     const bidResponses = [];
     for (let bidId in bids) {
       let adUnit = bids[bidId];
-      let meta;
+      let meta = {
+        mediaType: BANNER
+      };
+
       if (adUnit.metadata && adUnit.metadata.landingPageDomain) {
-        meta = {
-          clickUrl: adUnit.metadata.landingPageDomain[0],
-          advertiserDomains: adUnit.metadata.landingPageDomain
-        };
+        meta.clickUrl = adUnit.metadata.landingPageDomain[0];
+        meta.advertiserDomains = adUnit.metadata.landingPageDomain;
+      }
+
+      if (adUnit.mediaType && SUPPORTED_MEDIA_TYPES.includes(adUnit.mediaType)) {
+        meta.mediaType = adUnit.mediaType;
       }
-      bidResponses.push({
+
+      const bidResponse = {
         requestId: bidId,
         cpm: Number(adUnit.cpm),
         width: adUnit.width,
         height: adUnit.height,
-        ad: adUnit.adm,
         ttl: 300,
         creativeId: adUnit.id,
         dealId: adUnit.targetingCustom,
         netRevenue: true,
         currency: adUnit.currency || bidRequest.currency,
+        mediaType: meta.mediaType,
         meta: meta
-      });
+      };
+
+      if (meta.mediaType == VIDEO) {
+        bidResponse.vastXml = adUnit.adm;
+      } else {
+        bidResponse.ad = adUnit.adm;
+      }
+
+      bidResponses.push(bidResponse);
     }
+
     return bidResponses;
   },
   getUserSyncs: function(syncOptions, responses, gdprConsent, usPrivacy) {

package/modules/oguryBidAdapter.js

@@ -10,7 +10,29 @@ const DEFAULT_TIMEOUT = 1000;
 const BID_HOST = 'https://mweb-hb.presage.io/api/header-bidding-request';
 const TIMEOUT_MONITORING_HOST = 'https://ms-ads-monitoring-events.presage.io';
 const MS_COOKIE_SYNC_DOMAIN = 'https://ms-cookie-sync.presage.io';
-const ADAPTER_VERSION = '1.2.11';
+const ADAPTER_VERSION = '1.2.12';
+
+function getClientWidth() {
+  const documentElementClientWidth = window.top.document.documentElement.clientWidth
+    ? window.top.document.documentElement.clientWidth
+    : 0
+  const innerWidth = window.top.innerWidth ? window.top.innerWidth : 0
+  const outerWidth = window.top.outerWidth ? window.top.outerWidth : 0
+  const screenWidth = window.top.screen.width ? window.top.screen.width : 0
+
+  return documentElementClientWidth || innerWidth || outerWidth || screenWidth
+}
+
+function getClientHeight() {
+  const documentElementClientHeight = window.top.document.documentElement.clientHeight
+    ? window.top.document.documentElement.clientHeight
+    : 0
+  const innerHeight = window.top.innerHeight ? window.top.innerHeight : 0
+  const outerHeight = window.top.outerHeight ? window.top.outerHeight : 0
+  const screenHeight = window.top.screen.height ? window.top.screen.height : 0
+
+  return documentElementClientHeight || innerHeight || outerHeight || screenHeight
+}
 
 function isBidRequestValid(bid) {
   const adUnitSizes = getAdUnitSizes(bid);
@@ -60,6 +82,10 @@ function buildRequests(validBidRequests, bidderRequest) {
     ext: {
       adapterversion: ADAPTER_VERSION,
       prebidversion: '$prebid.version$'
+    },
+    device: {
+      w: getClientWidth(),
+      h: getClientHeight()
     }
   };
 

package/modules/trustpidSystem.js

@@ -4,7 +4,7 @@
  * @module modules/trustpidSystem
  * @requires module:modules/userId
  */
-import { logInfo, logError } from '../src/utils.js';
+import { logInfo } from '../src/utils.js';
 import { submodule } from '../src/hook.js';
 import { getStorageManager } from '../src/storageManager.js';
 
@@ -22,10 +22,9 @@ export const storage = getStorageManager({gvlid: null, moduleName: MODULE_NAME})
  * @param event
  */
 function messageHandler(event) {
-  let msg;
   try {
-    if (event && event.data && typeof event.data === 'string' && event.data) {
-      msg = JSON.parse(event.data);
+    if (event && event.data && typeof event.data === 'string') {
+      const msg = JSON.parse(event.data);
       if (msg.msgType === 'MNOSELECTOR' && msg.body && msg.body.url) {
         let URL = msg.body.url.split('//');
         let domainURL = URL[1].split('/');
@@ -35,7 +34,7 @@ function messageHandler(event) {
       }
     }
   } catch (e) {
-    logError(e);
+    logInfo(`${LOG_PREFIX}: Unsupported message caught. Origin: ${event.origin}, data: ${event.data}.`);
   }
 }
 
@@ -44,31 +43,13 @@ function messageHandler(event) {
  * @param domain
  */
 function getDomainAcronym(domain) {
-  let acronym = '';
   const prefix = '-';
-  switch (domain) {
-    case 'tmi.mno.link':
-      acronym = 'ndye';
-      break;
-    case 'tmi.vodafone.de':
-      acronym = 'pqnx';
-      break;
-    case 'tmi.telekom.de':
-      acronym = 'avgw';
-      break;
-    case 'tmi.tmid.es':
-      acronym = 'kjws';
-      break;
-    case 'uat.mno.link':
-      acronym = 'xxxx';
-      break;
-    case 'es.tmiservice.orange.com':
-      acronym = 'aplw';
-      break;
-    default:
-      return 'none';
+  const acronym = window.FC_CONF?.TELCO_ACRONYM?.[domain];
+  if (!acronym) {
+    logInfo(`${LOG_PREFIX}: No acronym found for domain: ${domain}`);
+    return;
   }
-  return mnoAcronym = prefix + acronym;
+  mnoAcronym = prefix + acronym;
 }
 
 // Set a listener to handle the iframe response message.

package/modules/trustpidSystem.md

@@ -5,41 +5,18 @@ trustpid User Id Module.
 First, make sure to add the trustpid submodule to your Prebid.js package with:
 
 ```
-gulp build --modules=userId,adfBidAdapter,trustpidSystem
-```
-
-The following configuration parameters are available:
-
-```
-pbjs.setConfig({
-  userSync: {
-    userIds: [
-      {
-        name: 'trustpid',
-        params: {
-          maxDelayTime: 1000, 
-        },
-        bidders: ["adf"],
-        storage: {
-          type: "html5",
-          name: "trustpid",
-          expires: 1, //days
-        },
-      }
-    ],
-  }
-});
+gulp build --modules=userId,adfBidAdapter,ixBidAdapter,prebidServerBidAdapter,trustpidSystem
 ```
 
 ## Parameter Descriptions
 
-| Param under userSync.userIds[] | Scope | Type | Description | Example |
-| --- | --- | --- | --- | --- |
-| name | Required | String | The name of the module | `"trustpid"`
-| params | Required | Object | Object with configuration parameters for trustpid User Id submodule | - |
-| params.maxDelayTime | Required | Integer | Max amount of time (in seconds) before looking into storage for data | 2500 |
-| bidders | Required | Array of Strings | An array of bidder codes to which this user ID may be sent. Currently required and supporting AdformOpenRTB | `["adf"]` |
-| storage | Required | Object | Local storage configuration object | - |
-| storage.type | Required | String | Type of the storage that would be used to store user ID. Must be `"html5"` to utilise HTML5 local storage. | `"html5"` |
-| storage.name | Required | String | The name of the key in local storage where the user ID will be stored. | `"trustpid"` |
-| storage.expires | Required | Integer | How long (in days) the user ID information will be stored. For safety reasons, this information is required.| `1` |
+| Params under userSync.userIds[] | Type | Description | Example |
+| --- | --- | --- | --- |
+| name | String | The name of the module | `"trustpid"` |
+| params | Object | Object with configuration parameters for trustpid User Id submodule | - |
+| params.maxDelayTime | Integer | Max amount of time (in seconds) before looking into storage for data | 2500 |
+| bidders | Array of Strings | An array of bidder codes to which this user ID may be sent. Currently required and supporting AdformOpenRTB | [`"adf"`, `"adformPBS"`, `"ix"`] |
+| storage | Object | Local storage configuration object | - |
+| storage.type | String | Type of the storage that would be used to store user ID. Must be `"html5"` to utilise HTML5 local storage. | `"html5"` |
+| storage.name | String | The name of the key in local storage where the user ID will be stored. | `"trustpid"` |
+| storage.expires | Integer | How long (in days) the user ID information will be stored. For safety reasons, this information is required.| `1` |

package/modules/userId/eids.js

@@ -314,6 +314,12 @@ export const USER_IDS_CONFIG = {
       return data.envelope;
     }
   },
+
+  // Gravito MP ID
+  'gravitompId': {
+    source: 'gravito.net',
+    atype: 1
+  },
 };
 
 // this function will create an eid object for the given UserId sub-module

package/modules/userId/index.js

@@ -131,7 +131,7 @@ import * as events from '../../src/events.js';
 import {getGlobal} from '../../src/prebidGlobal.js';
 import {gdprDataHandler} from '../../src/adapterManager.js';
 import CONSTANTS from '../../src/constants.json';
-import {hook, module} from '../../src/hook.js';
+import {hook, module, ready as hooksReady} from '../../src/hook.js';
 import {buildEidPermissions, createEidsArray, USER_IDS_CONFIG} from './eids.js';
 import {getCoreStorageManager} from '../../src/storageManager.js';
 import {
@@ -151,6 +151,8 @@ import {
   timestamp,
   isEmpty
 } from '../../src/utils.js';
+import {getPPID as coreGetPPID} from '../../src/adserver.js';
+import {promiseControls} from '../../src/utils/promise.js';
 
 const MODULE_NAME = 'User ID';
 const COOKIE = 'cookie';
@@ -528,42 +530,8 @@ function delayFor(ms) {
 const INIT_CANCELED = {};
 
 function idSystemInitializer({delay = delayFor} = {}) {
-  /**
-   * @returns a {promise, resolve, reject} trio where `promise` is resolved by calling `resolve` or `reject`.
-   */
-  function breakpoint() {
-    const [SUCCESS, FAIL, RESULT] = [0, 1, 2];
-    const status = {};
-
-    function finisher(slot) {
-      return function (val) {
-        if (status[slot] != null) {
-          status[slot](val);
-        } else {
-          status[slot] = true;
-          status[RESULT] = val;
-        }
-      }
-    }
-
-    return {
-      promise: new Promise((resolve, reject) => {
-        if (status[SUCCESS] != null) {
-          resolve(status[RESULT]);
-        } else if (status[FAIL] != null) {
-          reject(status[RESULT]);
-        } else {
-          status[SUCCESS] = resolve;
-          status[FAIL] = reject;
-        }
-      }),
-      resolve: finisher(SUCCESS),
-      reject: finisher(FAIL)
-    }
-  }
-
-  const startInit = breakpoint();
-  const startCallbacks = breakpoint();
+  const startInit = promiseControls();
+  const startCallbacks = promiseControls();
   let cancel;
   let initialized = false;
 
@@ -571,7 +539,7 @@ function idSystemInitializer({delay = delayFor} = {}) {
     if (cancel != null) {
       cancel.reject(INIT_CANCELED);
     }
-    cancel = breakpoint();
+    cancel = promiseControls();
     return Promise.race([promise, cancel.promise]);
   }
 
@@ -591,7 +559,7 @@ function idSystemInitializer({delay = delayFor} = {}) {
   }
 
   let done = cancelAndTry(
-    startInit.promise
+    Promise.all([hooksReady, startInit.promise])
       .then(() => gdprDataHandler.promise)
       .then(checkRefs((consentData) => {
         initSubmodules(initModules, allModules, consentData);
@@ -650,6 +618,19 @@ function idSystemInitializer({delay = delayFor} = {}) {
 
 let initIdSystem;
 
+function getPPID() {
+  // userSync.ppid should be one of the 'source' values in getUserIdsAsEids() eg pubcid.org or id5-sync.com
+  const matchingUserId = ppidSource && (getUserIdsAsEids() || []).find(userID => userID.source === ppidSource);
+  if (matchingUserId && typeof deepAccess(matchingUserId, 'uids.0.id') === 'string') {
+    const ppidValue = matchingUserId.uids[0].id.replace(/[\W_]/g, '');
+    if (ppidValue.length >= 32 && ppidValue.length <= 150) {
+      return ppidValue;
+    } else {
+      logWarn(`User ID - Googletag Publisher Provided ID for ${ppidSource} is not between 32 and 150 characters - ${ppidValue}`);
+    }
+  }
+}
+
 /**
  * Hook is executed before adapters, but after consentManagement. Consent data is requied because
  * this module requires GDPR consent with Purpose #1 to save data locally.
@@ -666,23 +647,16 @@ export function requestBidsHook(fn, reqBidsConfigObj, {delay = delayFor} = {}) {
   ]).then(() => {
     // pass available user id data to bid adapters
     addIdDataToAdUnitBids(reqBidsConfigObj.adUnits || getGlobal().adUnits, initializedSubmodules);
-
-    // userSync.ppid should be one of the 'source' values in getUserIdsAsEids() eg pubcid.org or id5-sync.com
-    const matchingUserId = ppidSource && (getUserIdsAsEids() || []).find(userID => userID.source === ppidSource);
-    if (matchingUserId && typeof deepAccess(matchingUserId, 'uids.0.id') === 'string') {
-      const ppidValue = matchingUserId.uids[0].id.replace(/[\W_]/g, '');
-      if (ppidValue.length >= 32 && ppidValue.length <= 150) {
-        if (isGptPubadsDefined()) {
-          window.googletag.pubads().setPublisherProvidedId(ppidValue);
-        } else {
-          window.googletag = window.googletag || {};
-          window.googletag.cmd = window.googletag.cmd || [];
-          window.googletag.cmd.push(function() {
-            window.googletag.pubads().setPublisherProvidedId(ppidValue);
-          });
-        }
+    const ppid = getPPID();
+    if (ppid) {
+      if (isGptPubadsDefined()) {
+        window.googletag.pubads().setPublisherProvidedId(ppid);
       } else {
-        logWarn(`User ID - Googletag Publisher Provided ID for ${ppidSource} is not between 32 and 150 characters - ${ppidValue}`);
+        window.googletag = window.googletag || {};
+        window.googletag.cmd = window.googletag.cmd || [];
+        window.googletag.cmd.push(function() {
+          window.googletag.pubads().setPublisherProvidedId(ppid);
+        });
       }
     }
 
@@ -980,6 +954,7 @@ function updateSubmodules() {
   if (!addedUserIdHook && submodules.length) {
     // priority value 40 will load after consentManagement with a priority of 50
     getGlobal().requestBids.before(requestBidsHook, 40);
+    coreGetPPID.after((next) => next(getPPID()));
     logInfo(`${MODULE_NAME} - usersync config updated for ${submodules.length} submodules: `, submodules.map(a => a.submodule.name));
     addedUserIdHook = true;
   }

package/modules/userId/userId.md

@@ -166,6 +166,9 @@ pbjs.setConfig({
                   },
         {
              name: "dacId"
+        }, 
+        {
+            name: "gravitompId"
         }
         ],
         syncDelay: 5000,
@@ -190,17 +193,6 @@ pbjs.setConfig({
             params: {
                 pid: "0010b00002GYU4eBAH" // Example ID
             }
-        }, {
-            name: 'trustpid',
-            params: {
-              maxDelayTime: 2500
-            },
-            bidders: ['adform'],
-            storage: {
-              type: 'html5',
-              name: 'trustpid',
-              expires: 60
-            }
         }, {
             name: "unifiedId",
             params: {