prebid.js 7.23.0 → 7.24.0

package/modules/ixBidAdapter.js

@@ -38,7 +38,6 @@ const BANNER_TIME_TO_LIVE = 300;
 const VIDEO_TIME_TO_LIVE = 3600; // 1hr
 const NATIVE_TIME_TO_LIVE = 3600; // Since native can have video, use ttl same as video
 const NET_REVENUE = true;
-const MAX_REQUEST_SIZE = 8000;
 const MAX_REQUEST_LIMIT = 4;
 const OUTSTREAM_MINIMUM_PLAYER_SIZE = [144, 144];
 const PRICE_TO_DOLLAR_FACTOR = {
@@ -159,7 +158,7 @@ const MEDIA_TYPES = {
  * @return {object}     A impression object that will be sent to ad server.
  */
 function bidToBannerImp(bid) {
-  const imp = bidToImp(bid);
+  const imp = bidToImp(bid, BANNER);
   imp.banner = {};
   const impSize = deepAccess(bid, 'params.size');
   if (impSize) {
@@ -181,7 +180,7 @@ function bidToBannerImp(bid) {
  * @return {object}     A impression object that will be sent to ad server.
  */
 function bidToVideoImp(bid) {
-  const imp = bidToImp(bid);
+  const imp = bidToImp(bid, VIDEO);
   const videoAdUnitRef = deepAccess(bid, 'mediaTypes.video');
   const videoParamRef = deepAccess(bid, 'params.video');
   const videoParamErrors = checkVideoParams(videoAdUnitRef, videoParamRef);
@@ -249,7 +248,7 @@ function bidToVideoImp(bid) {
  * @return {object}     A impression object that will be sent to ad server.
  */
 function bidToNativeImp(bid) {
-  const imp = bidToImp(bid);
+  const imp = bidToImp(bid, NATIVE);
 
   const request = bid.nativeOrtbRequest
   request.eventtrackers = [{
@@ -276,13 +275,28 @@ function bidToNativeImp(bid) {
  * @param {object} bid   PBJS bid object
  * @returns {object}     IX impression object
  */
-function bidToImp(bid) {
+function bidToImp(bid, mediaType) {
   const imp = {};
 
   imp.id = bid.bidId;
 
   imp.ext = {};
-  imp.ext.siteID = bid.params.siteId.toString();
+
+  if (deepAccess(bid, `params.${mediaType}.siteId`) && !isNaN(Number(bid.params[mediaType].siteId))) {
+    switch (mediaType) {
+      case BANNER:
+        imp.ext.siteID = bid.params.banner.siteId.toString();
+        break;
+      case VIDEO:
+        imp.ext.siteID = bid.params.video.siteId.toString();
+        break;
+      case NATIVE:
+        imp.ext.siteID = bid.params.native.siteId.toString();
+        break;
+    }
+  } else {
+    imp.ext.siteID = bid.params.siteId.toString();
+  }
 
   // populate imp level sid
   if (bid.params.hasOwnProperty('id') && (typeof bid.params.id === 'string' || typeof bid.params.id === 'number')) {
@@ -586,6 +600,12 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   let userEids = eidInfo.toSend;
   const pageUrl = deepAccess(bidderRequest, 'refererInfo.page');
 
+  let MAX_REQUEST_SIZE = 8000;
+  // Modify request size limit if its FT is enabeld.
+  if (FEATURE_TOGGLES.isFeatureEnabled('pbjs_use_32kb_size_limit')) {
+    MAX_REQUEST_SIZE = 32000
+  }
+
   // RTI ids will be included in the bid request if the function getIdentityInfo() is loaded
   // and if the data for the partner exist
   if (window.headertag && typeof window.headertag.getIdentityInfo === 'function') {
@@ -642,6 +662,9 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
     r.ext.ixdiag.err = cachedErrors;
   }
 
+  // Add number of available imps to ixDiag.
+  r.ext.ixdiag.imps = Object.keys(impressions).length;
+
   // set source.tid to auctionId for outgoing request to Exchange.
   r.source = {
     tid: validBidRequests[0].auctionId,
@@ -1418,7 +1441,7 @@ export const spec = {
 
     // Step 1: Create impresssions from IX params
     validBidRequests.forEach((validBidRequest) => {
-      const adUnitMediaTypes = Object.keys(deepAccess(validBidRequest, 'mediaTypes', {}))
+      const adUnitMediaTypes = Object.keys(deepAccess(validBidRequest, 'mediaTypes', {}));
 
       for (const type in adUnitMediaTypes) {
         switch (adUnitMediaTypes[type]) {

package/modules/kueezRtbBidAdapter.js

@@ -0,0 +1,278 @@
+import { _each, deepAccess, parseSizesInput, parseUrl, uniques, isFn } from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { getStorageManager } from '../src/storageManager.js';
+
+const GVLID = 1165;
+const DEFAULT_SUB_DOMAIN = 'exchange';
+const BIDDER_CODE = 'kueezrtb';
+const BIDDER_VERSION = '1.0.0';
+const CURRENCY = 'USD';
+const TTL_SECONDS = 60 * 5;
+const UNIQUE_DEAL_ID_EXPIRY = 1000 * 60 * 15;
+export const SUPPORTED_ID_SYSTEMS = {
+  'britepoolid': 1,
+  'criteoId': 1,
+  'id5id': 1,
+  'idl_env': 1,
+  'lipb': 1,
+  'netId': 1,
+  'parrableId': 1,
+  'pubcid': 1,
+  'tdid': 1,
+  'pubProvidedId': 1
+};
+const storage = getStorageManager({ gvlid: GVLID, bidderCode: BIDDER_CODE });
+
+function getTopWindowQueryParams() {
+  try {
+    const parsedUrl = parseUrl(window.top.document.URL, { decodeSearchAsString: true });
+    return parsedUrl.search;
+  } catch (e) {
+    return '';
+  }
+}
+
+export function createDomain(subDomain = DEFAULT_SUB_DOMAIN) {
+  return `https://${subDomain}.kueezrtb.com`;
+}
+
+export function extractCID(params) {
+  return params.cId || params.CID || params.cID || params.CId || params.cid || params.ciD || params.Cid || params.CiD;
+}
+
+export function extractPID(params) {
+  return params.pId || params.PID || params.pID || params.PId || params.pid || params.piD || params.Pid || params.PiD;
+}
+
+export function extractSubDomain(params) {
+  return params.subDomain || params.SubDomain || params.Subdomain || params.subdomain || params.SUBDOMAIN || params.subDOMAIN;
+}
+
+function isBidRequestValid(bid) {
+  const params = bid.params || {};
+  return !!(extractCID(params) && extractPID(params));
+}
+
+function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
+  const { params, bidId, userId, adUnitCode, schain } = bid;
+  let { bidFloor, ext } = params;
+  const hashUrl = hashCode(topWindowUrl);
+  const uniqueDealId = getUniqueDealId(hashUrl);
+  const cId = extractCID(params);
+  const pId = extractPID(params);
+  const subDomain = extractSubDomain(params);
+
+  if (isFn(bid.getFloor)) {
+    const floorInfo = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*'
+    });
+
+    if (floorInfo.currency === 'USD') {
+      bidFloor = floorInfo.floor;
+    }
+  }
+
+  let data = {
+    url: encodeURIComponent(topWindowUrl),
+    uqs: getTopWindowQueryParams(),
+    cb: Date.now(),
+    bidFloor: bidFloor,
+    bidId: bidId,
+    referrer: bidderRequest.refererInfo.ref,
+    adUnitCode: adUnitCode,
+    publisherId: pId,
+    sizes: sizes,
+    uniqueDealId: uniqueDealId,
+    bidderVersion: BIDDER_VERSION,
+    prebidVersion: '$prebid.version$',
+    res: `${screen.width}x${screen.height}`,
+    schain: schain
+  };
+
+  appendUserIdsToRequestPayload(data, userId);
+
+  if (bidderRequest.gdprConsent) {
+    if (bidderRequest.gdprConsent.consentString) {
+      data.gdprConsent = bidderRequest.gdprConsent.consentString;
+    }
+    if (bidderRequest.gdprConsent.gdprApplies !== undefined) {
+      data.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
+    }
+  }
+  if (bidderRequest.uspConsent) {
+    data.usPrivacy = bidderRequest.uspConsent;
+  }
+
+  const dto = {
+    method: 'POST',
+    url: `${createDomain(subDomain)}/prebid/multi/${cId}`,
+    data: data
+  };
+
+  _each(ext, (value, key) => {
+    dto.data['ext.' + key] = value;
+  });
+
+  return dto;
+}
+
+function appendUserIdsToRequestPayload(payloadRef, userIds) {
+  let key;
+  _each(userIds, (userId, idSystemProviderName) => {
+    if (SUPPORTED_ID_SYSTEMS[idSystemProviderName]) {
+      key = `uid.${idSystemProviderName}`;
+
+      switch (idSystemProviderName) {
+        case 'digitrustid':
+          payloadRef[key] = deepAccess(userId, 'data.id');
+          break;
+        case 'lipb':
+          payloadRef[key] = userId.lipbid;
+          break;
+        case 'parrableId':
+          payloadRef[key] = userId.eid;
+          break;
+        case 'id5id':
+          payloadRef[key] = userId.uid;
+          break;
+        default:
+          payloadRef[key] = userId;
+      }
+    }
+  });
+}
+
+function buildRequests(validBidRequests, bidderRequest) {
+  const topWindowUrl = bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation;
+  const requests = [];
+  validBidRequests.forEach(validBidRequest => {
+    const sizes = parseSizesInput(validBidRequest.sizes);
+    const request = buildRequest(validBidRequest, topWindowUrl, sizes, bidderRequest);
+    requests.push(request);
+  });
+  return requests;
+}
+
+function interpretResponse(serverResponse, request) {
+  if (!serverResponse || !serverResponse.body) {
+    return [];
+  }
+  const { bidId } = request.data;
+  const { results } = serverResponse.body;
+
+  let output = [];
+
+  try {
+    results.forEach(result => {
+      const { creativeId, ad, price, exp, width, height, currency, advertiserDomains } = result;
+      if (!ad || !price) {
+        return;
+      }
+      output.push({
+        requestId: bidId,
+        cpm: price,
+        width: width,
+        height: height,
+        creativeId: creativeId,
+        currency: currency || CURRENCY,
+        netRevenue: true,
+        ttl: exp || TTL_SECONDS,
+        ad: ad,
+        meta: {
+          advertiserDomains: advertiserDomains || []
+        }
+      })
+    });
+    return output;
+  } catch (e) {
+    return [];
+  }
+}
+
+function getUserSyncs(syncOptions, responses, gdprConsent = {}, uspConsent = '') {
+  let syncs = [];
+  const { iframeEnabled, pixelEnabled } = syncOptions;
+  const { gdprApplies, consentString = '' } = gdprConsent;
+
+  const cidArr = responses.filter(resp => deepAccess(resp, 'body.cid')).map(resp => resp.body.cid).filter(uniques);
+  const params = `?cid=${encodeURIComponent(cidArr.join(','))}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${encodeURIComponent(consentString || '')}&us_privacy=${encodeURIComponent(uspConsent || '')}`
+  if (iframeEnabled) {
+    syncs.push({
+      type: 'iframe',
+      url: `https://sync.kueezrtb.com/api/sync/iframe/${params}`
+    });
+  }
+  if (pixelEnabled) {
+    syncs.push({
+      type: 'image',
+      url: `https://sync.kueezrtb.com/api/sync/image/${params}`
+    });
+  }
+  return syncs;
+}
+
+export function hashCode(s, prefix = '_') {
+  const l = s.length;
+  let h = 0
+  let i = 0;
+  if (l > 0) {
+    while (i < l) { h = (h << 5) - h + s.charCodeAt(i++) | 0; }
+  }
+  return prefix + h;
+}
+
+export function getUniqueDealId(key, expiry = UNIQUE_DEAL_ID_EXPIRY) {
+  const storageKey = `u_${key}`;
+  const now = Date.now();
+  const data = getStorageItem(storageKey);
+  let uniqueId;
+
+  if (!data || !data.value || now - data.created > expiry) {
+    uniqueId = `${key}_${now.toString()}`;
+    setStorageItem(storageKey, uniqueId);
+  } else {
+    uniqueId = data.value;
+  }
+
+  return uniqueId;
+}
+
+export function getStorageItem(key) {
+  try {
+    return tryParseJSON(storage.getDataFromLocalStorage(key));
+  } catch (e) { }
+
+  return null;
+}
+
+export function setStorageItem(key, value, timestamp) {
+  try {
+    const created = timestamp || Date.now();
+    const data = JSON.stringify({ value, created });
+    storage.setDataInLocalStorage(key, data);
+  } catch (e) { }
+}
+
+export function tryParseJSON(value) {
+  try {
+    return JSON.parse(value);
+  } catch (e) {
+    return value;
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  version: BIDDER_VERSION,
+  gvlid: GVLID,
+  supportedMediaTypes: [BANNER],
+  isBidRequestValid,
+  buildRequests,
+  interpretResponse,
+  getUserSyncs
+};
+
+registerBidder(spec);

package/modules/kueezRtbBidAdapter.md

@@ -0,0 +1,35 @@
+# Overview
+
+**Module Name:** Kueez RTB Bidder Adapter
+
+**Module Type:** Bidder Adapter
+
+**Maintainer:** rtb@kueez.com
+
+# Description
+
+Module that connects to Kueez's demand sources.
+ 
+# Test Parameters
+```js
+var adUnits = [
+  {
+    code: 'test-ad',
+    sizes: [[300, 250]],
+    bids: [
+      {
+        bidder: 'kueezrtb',
+        params: {
+          cId: '562524b21b1c1f08117fc7f9',
+          pId: '59ac17c192832d0011283fe3',
+          bidFloor: 0.0001,
+          ext: {
+            param1: 'loremipsum',
+            param2: 'dolorsitamet'
+          }
+        }
+      }
+    ]
+  }
+];
+```

package/modules/magniteAnalyticsAdapter.js

@@ -254,9 +254,14 @@ export const parseBidResponse = (bid, previousBidResponse) => {
       const validAdomains = Array.isArray(adomains) && adomains.filter(domain => typeof domain === 'string');
       return validAdomains && validAdomains.length > 0 ? validAdomains.slice(0, 10) : undefined
     },
+    'networkId', () => {
+      const networkId = deepAccess(bid, 'meta.networkId');
+      // if not a valid after this, set to undefined so it gets filtered out
+      return (networkId && networkId.toString()) || undefined;
+    },
     'conversionError', conversionError => conversionError === true || undefined, // only pass if exactly true
     'ogCurrency',
-    'ogPrice'
+    'ogPrice',
   ]);
 }
 

package/modules/mgidRtdProvider.js

@@ -0,0 +1,190 @@
+import { submodule } from '../src/hook.js';
+import {ajax} from '../src/ajax.js';
+import {deepAccess, logError, logInfo, mergeDeep} from '../src/utils.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {getRefererInfo} from '../src/refererDetection.js';
+
+const MODULE_NAME = 'realTimeData';
+const SUBMODULE_NAME = 'mgid';
+const MGID_RTD_API_URL = 'https://servicer.mgid.com/sda';
+const MGUID_LOCAL_STORAGE_KEY = 'mguid';
+const ORTB2_NAME = 'www.mgid.com'
+
+const GVLID = 358;
+/** @type {?Object} */
+export const storage = getStorageManager({
+  gvlid: GVLID,
+  moduleName: SUBMODULE_NAME
+});
+
+function init(moduleConfig) {
+  if (!moduleConfig?.params?.clientSiteId) {
+    logError('Mgid clientSiteId is not set!');
+    return false;
+  }
+  return true;
+}
+
+function getBidRequestData(reqBidsConfigObj, onDone, moduleConfig, userConsent) {
+  let mguid;
+  try {
+    mguid = storage.getDataFromLocalStorage(MGUID_LOCAL_STORAGE_KEY);
+  } catch (e) {
+    logInfo(`Can't get mguid from localstorage`);
+  }
+
+  const params = [
+    {
+      name: 'gdprApplies',
+      data: typeof userConsent?.gdpr?.gdprApplies !== 'undefined' ? userConsent?.gdpr?.gdprApplies + '' : undefined,
+    },
+    {
+      name: 'consentData',
+      data: userConsent?.gdpr?.consentString,
+    },
+    {
+      name: 'uspString',
+      data: userConsent?.usp,
+    },
+    {
+      name: 'cxurl',
+      data: encodeURIComponent(getContextUrl()),
+    },
+    {
+      name: 'muid',
+      data: mguid,
+    },
+    {
+      name: 'clientSiteId',
+      data: moduleConfig?.params?.clientSiteId,
+    },
+    {
+      name: 'cxlang',
+      data: deepAccess(reqBidsConfigObj.ortb2Fragments.global, 'site.content.language'),
+    },
+  ];
+
+  const url = MGID_RTD_API_URL + '?' + params.filter((p) => p.data).map((p) => p.name + '=' + p.data).join('&');
+
+  let isDone = false;
+
+  ajax(url, {
+    success: (response, req) => {
+      if (req.status === 200) {
+        try {
+          const data = JSON.parse(response);
+          const ortb2 = reqBidsConfigObj?.ortb2Fragments?.global || {};
+
+          mergeDeep(ortb2, getDataForMerge(data));
+
+          if (data?.muid) {
+            try {
+              mguid = storage.setDataInLocalStorage(MGUID_LOCAL_STORAGE_KEY, data.muid);
+            } catch (e) {
+              logInfo(`Can't set mguid to localstorage`);
+            }
+          }
+
+          onDone();
+          isDone = true;
+        } catch (e) {
+          onDone();
+          isDone = true;
+
+          logError('Unable to parse Mgid RTD data', e);
+        }
+      } else {
+        onDone();
+        isDone = true;
+
+        logError('Mgid RTD wrong response status');
+      }
+    },
+    error: () => {
+      onDone();
+      isDone = true;
+
+      logError('Unable to get Mgid RTD data');
+    }
+  },
+  null, {
+    method: 'GET',
+    withCredentials: false,
+  });
+
+  setTimeout(function () {
+    if (!isDone) {
+      onDone();
+      logInfo('Mgid RTD timeout');
+      isDone = true;
+    }
+  }, moduleConfig.params.timeout || 1000);
+}
+
+function getContextUrl() {
+  const refererInfo = getRefererInfo();
+
+  let resultUrl = refererInfo.canonicalUrl || refererInfo.topmostLocation;
+
+  const metaElements = document.getElementsByTagName('meta');
+  for (let i = 0; i < metaElements.length; i++) {
+    if (metaElements[i].getAttribute('property') === 'og:url') {
+      resultUrl = metaElements[i].content;
+    }
+  }
+
+  return resultUrl;
+}
+
+function getDataForMerge(responseData) {
+  let siteData = {
+    name: ORTB2_NAME
+  };
+  let userData = {
+    name: ORTB2_NAME
+  };
+
+  if (responseData.siteSegments) {
+    siteData.segment = responseData.siteSegments.map((segmentId) => ({ id: segmentId }));
+  }
+  if (responseData.siteSegtax) {
+    siteData.ext = {
+      segtax: responseData.siteSegtax
+    }
+  }
+
+  if (responseData.userSegments) {
+    userData.segment = responseData.userSegments.map((segmentId) => ({ id: segmentId }));
+  }
+  if (responseData.userSegtax) {
+    userData.ext = {
+      segtax: responseData.userSegtax
+    }
+  }
+
+  let result = {};
+  if (siteData.segment || siteData.ext) {
+    result.site = {
+      content: {
+        data: [siteData],
+      }
+    }
+  }
+
+  if (userData.segment || userData.ext) {
+    result.user = {
+      data: [userData],
+    }
+  }
+
+  return result;
+}
+
+/** @type {RtdSubmodule} */
+export const mgidSubmodule = {
+  name: SUBMODULE_NAME,
+  init: init,
+  getBidRequestData: getBidRequestData,
+};
+
+submodule(MODULE_NAME, mgidSubmodule);

package/modules/mgidRtdProvider.md

@@ -0,0 +1,51 @@
+# Overview
+
+```
+Module Name: Mgid RTD Provider
+Module Type: RTD Provider
+Maintainer: prebid@mgid.com
+```
+
+# Description
+
+Mgid RTD module allows you to enrich bid data with contextual and audience signals, based on IAB taxonomies.
+
+## Configuration
+
+This module is configured as part of the `realTimeData.dataProviders` object.
+
+{: .table .table-bordered .table-striped }
+| Name       | Scope    | Description                            | Example       | Type     |
+|------------|----------|----------------------------------------|---------------|----------|
+| `name `     | required | Real time data module name | `'mgid'`   | `string` |
+| `params`      | required |  | | `Object` |
+| `params.clientSiteId`      | required | The client site id provided by Mgid. | `'123456'` | `string` |
+| `params.timeout`      | optional | Maximum amount of milliseconds allowed for module to finish working | `1000` | `number` |
+
+#### Example
+
+```javascript
+pbjs.setConfig({
+    realTimeData: {
+        dataProviders: [{
+            name: 'mgid',
+            params: {
+              clientSiteId: '123456'
+            }
+        }]
+    }
+});
+```
+
+## Integration
+To install the module, follow these instructions:
+
+#### Step 1: Prepare the base Prebid file
+
+- Option 1: Use Prebid [Download](/download.html) page to build the prebid package. Ensure that you do check *Mgid Realtime Module* module
+
+- Option 2: From the command line, run `gulp build --modules=mgidRtdProvider,...`
+
+#### Step 2: Set configuration
+
+Enable Mgid Real Time Module using `pbjs.setConfig`. Example is provided in Configuration section.

package/modules/permutiveRtdProvider.js

@@ -238,7 +238,8 @@ function getDefaultBidderFn (bidder) {
         deepSetValue(bid, 'params.visitor.p_standard', data.ac)
       }
       if (data.rubicon && data.rubicon.length) {
-        deepSetValue(bid, 'params.visitor.permutive', data.rubicon)
+        const rubiconCohorts = deepAccess(bid, 'params.video') ? data.rubicon.map(String) : data.rubicon
+        deepSetValue(bid, 'params.visitor.permutive', rubiconCohorts)
       }
 
       return bid