prebid.js 9.2.0 → 9.4.0

package/modules/kueezRtbBidAdapter.js

@@ -1,338 +1,43 @@
-import {_each, deepAccess, parseSizesInput, parseUrl, uniques, isFn} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {getStorageManager} from '../src/storageManager.js';
-import {config} from '../src/config.js';
+import {
+  createBuildRequestsFn,
+  createInterpretResponseFn,
+  createUserSyncGetter,
+  isBidRequestValid
+} from '../libraries/vidazooUtils/bidderUtils.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;
-const storage = getStorageManager({bidderCode: BIDDER_CODE});
-
-function getTopWindowQueryParams() {
-  try {
-    const parsedUrl = parseUrl(window.top.document.URL, {decodeSearchAsString: true});
-    return parsedUrl.search;
-  } catch (e) {
-    return '';
-  }
-}
+export const storage = getStorageManager({bidderCode: BIDDER_CODE});
 
 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, bidderTimeout) {
+function createUniqueRequestData(hashUrl, bid) {
   const {
-    params,
-    bidId,
-    userId,
-    adUnitCode,
-    schain,
-    mediaTypes,
     auctionId,
     transactionId,
-    bidderRequestId,
-    bidRequestsCount,
-    bidderRequestsCount,
-    bidderWinsCount
   } = 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);
-
-  const gpid = deepAccess(bid, 'ortb2Imp.ext.gpid') || deepAccess(bid, 'ortb2Imp.ext.data.pbadslot', '');
-
-  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,
-    mediaTypes: mediaTypes,
-    gpid: gpid,
-    // TODO: fix auctionId/transactionId leak: https://github.com/prebid/Prebid.js/issues/9781
-    auctionId: auctionId,
-    transactionId: transactionId,
-    bidderRequestId: bidderRequestId,
-    bidRequestsCount: bidRequestsCount,
-    bidderRequestsCount: bidderRequestsCount,
-    bidderWinsCount: bidderWinsCount,
-    bidderTimeout: bidderTimeout
-  };
-
-  appendUserIdsToRequestPayload(data, userId);
-
-  const sua = deepAccess(bidderRequest, 'ortb2.device.sua');
-
-  if (sua) {
-    data.sua = sua;
-  }
-
-  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;
-  }
-
-  if (bidderRequest.gppConsent) {
-    data.gppString = bidderRequest.gppConsent.gppString;
-    data.gppSid = bidderRequest.gppConsent.applicableSections;
-  } else if (bidderRequest.ortb2?.regs?.gpp) {
-    data.gppString = bidderRequest.ortb2.regs.gpp;
-    data.gppSid = bidderRequest.ortb2.regs.gpp_sid;
-  }
-
-  const dto = {
-    method: 'POST',
-    url: `${createDomain(subDomain)}/prebid/multi/${cId}`,
-    data: data
+  return {
+    auctionId,
+    transactionId,
   };
-
-  _each(ext, (value, key) => {
-    dto.data['ext.' + key] = value;
-  });
-
-  return dto;
 }
 
-function appendUserIdsToRequestPayload(payloadRef, userIds) {
-  let key;
-  _each(userIds, (userId, idSystemProviderName) => {
-    key = `uid.${idSystemProviderName}`;
+const buildRequests = createBuildRequestsFn(createDomain, createUniqueRequestData, storage, BIDDER_CODE, BIDDER_VERSION, false);
 
-    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;
-    }
-  });
-}
+const interpretResponse = createInterpretResponseFn(BIDDER_CODE, false);
 
-function buildRequests(validBidRequests, bidderRequest) {
-  const topWindowUrl = bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation;
-  const bidderTimeout = bidderRequest.timeout ?? config.getConfig('bidderTimeout');
-  const requests = [];
-  validBidRequests.forEach(validBidRequest => {
-    const sizes = parseSizesInput(validBidRequest.sizes);
-    const request = buildRequest(validBidRequest, topWindowUrl, sizes, bidderRequest, bidderTimeout);
-    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,
-        metaData,
-        advertiserDomains,
-        mediaType = BANNER
-      } = result;
-      if (!ad || !price) {
-        return;
-      }
-
-      const response = {
-        requestId: bidId,
-        cpm: price,
-        width: width,
-        height: height,
-        creativeId: creativeId,
-        currency: currency || CURRENCY,
-        netRevenue: true,
-        ttl: exp || TTL_SECONDS,
-      };
-
-      if (metaData) {
-        Object.assign(response, {
-          meta: metaData
-        })
-      } else {
-        Object.assign(response, {
-          meta: {
-            advertiserDomains: advertiserDomains || []
-          }
-        })
-      }
-
-      if (mediaType === BANNER) {
-        Object.assign(response, {
-          ad: ad,
-        });
-      } else {
-        Object.assign(response, {
-          vastXml: ad,
-          mediaType: VIDEO
-        });
-      }
-      output.push(response);
-    });
-    return output;
-  } catch (e) {
-    return [];
-  }
-}
-
-function getUserSyncs(syncOptions, responses, gdprConsent = {}, uspConsent = '', gppConsent = {}) {
-  let syncs = [];
-  const {iframeEnabled, pixelEnabled} = syncOptions;
-  const {gdprApplies, consentString = ''} = gdprConsent;
-  const {gppString, applicableSections} = gppConsent;
-
-  const cidArr = responses.filter(resp => deepAccess(resp, 'body.cid')).map(resp => resp.body.cid).filter(uniques);
-  let params = `?cid=${encodeURIComponent(cidArr.join(','))}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${encodeURIComponent(consentString || '')}&us_privacy=${encodeURIComponent(uspConsent || '')}`
-
-  if (gppString && applicableSections?.length) {
-    params += '&gpp=' + encodeURIComponent(gppString);
-    params += '&gpp_sid=' + encodeURIComponent(applicableSections.join(','));
-  }
-
-  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;
-  }
-}
+const getUserSyncs = createUserSyncGetter({
+  iframeSyncUrl: 'https://sync.kueezrtb.com/api/sync/iframe',
+  imageSyncUrl: 'https://sync.kueezrtb.com/api/sync/image'
+});
 
 export const spec = {
   code: BIDDER_CODE,

package/modules/liveIntentIdSystem.js

@@ -20,7 +20,7 @@ import { getRefererInfo } from '../src/refererDetection.js';
  * @typedef {import('../modules/userId/index.js').SubmoduleConfig} SubmoduleConfig
  * @typedef {import('../modules/userId/index.js').IdResponse} IdResponse
  */
-
+const GVLID = 148;
 const DEFAULT_AJAX_TIMEOUT = 5000;
 const EVENTS_TOPIC = 'pre_lips';
 const MODULE_NAME = 'liveIntentId';
@@ -185,7 +185,7 @@ export const liveIntentIdSubmodule = {
    * @type {string}
    */
   name: MODULE_NAME,
-
+  gvlid: GVLID,
   setModuleMode(mode) {
     this.moduleMode = mode;
   },

package/modules/luponmediaBidAdapter.js

@@ -9,7 +9,9 @@ import {
   logError,
   logMessage,
   logWarn,
-  parseSizesInput
+  parseSizesInput,
+  sizeTupleToRtbSize,
+  sizesToSizeTuples
 } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
@@ -271,16 +273,8 @@ function newOrtbBidRequest(bidRequest, bidderRequest, currentImps) {
   let bannerSizes = [];
 
   if (bannerParams && bannerParams.sizes) {
-    const sizes = parseSizesInput(bannerParams.sizes);
-
     // get banner sizes in form [{ w: <int>, h: <int> }, ...]
-    const format = sizes.map(size => {
-      const [ width, height ] = size.split('x');
-      const w = parseInt(width, 10);
-      const h = parseInt(height, 10);
-      return { w, h };
-    });
-
+    const format = sizesToSizeTuples(bannerParams.sizes).map(sizeTupleToRtbSize);
     bannerSizes = format;
   }
 

package/modules/mabidderBidAdapter.js

@@ -1,6 +1,5 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
-import { getGlobal } from '../src/prebidGlobal.js';
 import { ortbConverter } from '../libraries/ortbConverter/converter.js';
 
 const BIDDER_CODE = 'mabidder';
@@ -39,7 +38,7 @@ export const spec = {
       url: baseUrl,
       method: 'POST',
       data: {
-        v: getGlobal().version,
+        v: 'v' + '$prebid.version$',
         bids: bids,
         url: bidderRequest.refererInfo.page || '',
         referer: bidderRequest.refererInfo.ref || '',

package/modules/medianetAnalyticsAdapter.js

@@ -36,8 +36,7 @@ const PRICE_GRANULARITY = {
 };
 
 const MEDIANET_BIDDER_CODE = 'medianet';
-// eslint-disable-next-line no-undef
-const PREBID_VERSION = getGlobal().version;
+const PREBID_VERSION = '$prebid.version$'
 const ERROR_CONFIG_JSON_PARSE = 'analytics_config_parse_fail';
 const ERROR_CONFIG_FETCH = 'analytics_config_ajax_fail';
 const ERROR_WINNING_BID_ABSENT = 'winning_bid_absent';

package/modules/medianetBidAdapter.js

@@ -186,7 +186,7 @@ function extParams(bidRequest, bidderRequests) {
   const coppaApplies = !!(config.getConfig('coppa'));
   return Object.assign({},
     { customer_id: params.cid },
-    { prebid_version: getGlobal().version },
+    { prebid_version: 'v' + '$prebid.version$' },
     { gdpr_applies: gdprApplies },
     (gdprApplies) && { gdpr_consent_string: gdpr.consentString || '' },
     { usp_applies: uspApplies },

package/modules/mgidBidAdapter.js

@@ -12,7 +12,7 @@ import {
   isFn,
   isNumber,
   isBoolean,
-  isInteger, deepSetValue, getBidIdParameter,
+  isInteger, deepSetValue, getBidIdParameter, setOnAny
 } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, NATIVE} from '../src/mediaTypes.js';
@@ -431,15 +431,6 @@ export const spec = {
 
 registerBidder(spec);
 
-function setOnAny(collection, key) {
-  for (let i = 0, result; i < collection.length; i++) {
-    result = deepAccess(collection[i], key);
-    if (result) {
-      return result;
-    }
-  }
-}
-
 /**
  * Unpack the Server's Bid into a Prebid-compatible one.
  * @param serverBid

package/modules/orakiBidAdapter.js

@@ -0,0 +1,19 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
+
+const BIDDER_CODE = 'oraki';
+const AD_URL = 'https://eu1.oraki.io/pbjs';
+const SYNC_URL = 'https://sync.oraki.io';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: isBidRequestValid(),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
+};
+
+registerBidder(spec);

package/modules/orakiBidAdapter.md

@@ -0,0 +1,79 @@
+# Overview
+
+```
+Module Name: Oraki Bidder Adapter
+Module Type: Oraki Bidder Adapter
+Maintainer: ben@oraki.io
+```
+
+# Description
+
+Connects to Oraki exchange for bids.
+Oraki bid adapter supports Banner, Video (instream and outstream) and Native.
+
+# Test Parameters
+```
+    var adUnits = [
+                // Will return static test banner
+                {
+                    code: 'adunit1',
+                    mediaTypes: {
+                        banner: {
+                            sizes: [ [300, 250], [320, 50] ],
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'oraki',
+                            params: {
+                                placementId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit2',
+                    mediaTypes: {
+                        video: {
+                            playerSize: [ [640, 480] ],
+                            context: 'instream',
+                            minduration: 5,
+                            maxduration: 60,
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'oraki',
+                            params: {
+                                placementId: 'testVideo',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit3',
+                    mediaTypes: {
+                        native: {
+                            title: {
+                                required: true
+                            },
+                            body: {
+                                required: true
+                            },
+                            icon: {
+                                required: true,
+                                size: [64, 64]
+                            }
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'oraki',
+                            params: {
+                                placementId: 'testNative',
+                            }
+                        }
+                    ]
+                }
+            ];
+```

package/modules/orbidderBidAdapter.js

@@ -3,7 +3,6 @@ import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { getStorageManager } from '../src/storageManager.js';
 import { BANNER, NATIVE } from '../src/mediaTypes.js';
 import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
-import { getGlobal } from '../src/prebidGlobal.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
@@ -93,6 +92,9 @@ export const spec = {
       if (bidderRequest && bidderRequest.refererInfo) {
         referer = bidderRequest.refererInfo.page || '';
       }
+      if (bidRequest?.mediaTypes?.video) {
+        delete bidRequest.mediaTypes.video;
+      }
 
       bidRequest.params.bidfloor = getBidFloor(bidRequest);
 
@@ -101,7 +103,7 @@ export const spec = {
         method: 'POST',
         options: { withCredentials: true },
         data: {
-          v: getGlobal().version,
+          v: 'v' + '$prebid.version$',
           pageUrl: referer,
           ...bidRequest // get all data provided by bid request
         }

package/modules/outbrainBidAdapter.js

@@ -5,7 +5,7 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 import { getStorageManager } from '../src/storageManager.js';
 import {OUTSTREAM} from '../src/video.js';
-import {_map, deepAccess, deepSetValue, isArray, logWarn, replaceAuctionPrice} from '../src/utils.js';
+import {_map, deepAccess, deepSetValue, logWarn, replaceAuctionPrice, setOnAny, parseGPTSingleSizeArrayToRtbSize} from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
 import {config} from '../src/config.js';
 import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
@@ -94,7 +94,7 @@ export const spec = {
         imp.video = getVideoAsset(bid);
       } else {
         imp.banner = {
-          format: transformSizes(bid.sizes)
+          format: bid.sizes?.map((size) => parseGPTSingleSizeArrayToRtbSize(size))
         }
       }
 
@@ -111,7 +111,7 @@ export const spec = {
     const request = {
       id: bidderRequest.bidderRequestId,
       site: { page, publisher },
-      device: { ua },
+      device: ortb2?.device || { ua },
       source: { fd: 1 },
       cur: [cur],
       tmax: timeout,
@@ -174,7 +174,7 @@ export const spec = {
     }
     const { seatbid, cur } = serverResponse.body;
 
-    const bidResponses = flatten(seatbid.map(seat => seat.bid)).reduce((result, bid) => {
+    const bidResponses = seatbid.map(seat => seat.bid).flat().reduce((result, bid) => {
       result[bid.impid - 1] = bid;
       return result;
     }, []);
@@ -288,19 +288,6 @@ function parseNative(bid) {
   return result;
 }
 
-function setOnAny(collection, key) {
-  for (let i = 0, result; i < collection.length; i++) {
-    result = deepAccess(collection[i], key);
-    if (result) {
-      return result;
-    }
-  }
-}
-
-function flatten(arr) {
-  return [].concat(...arr);
-}
-
 function getNativeAssets(bid) {
   return _map(bid.nativeParams, (bidParams, key) => {
     const props = NATIVE_PARAMS[key];
@@ -319,7 +306,7 @@ function getNativeAssets(bid) {
       }
 
       if (bidParams.sizes) {
-        const sizes = flatten(bidParams.sizes);
+        const sizes = bidParams.sizes.flat();
         w = parseInt(sizes[0], 10);
         h = parseInt(sizes[1], 10);
       }
@@ -339,7 +326,7 @@ function getNativeAssets(bid) {
 }
 
 function getVideoAsset(bid) {
-  const sizes = flatten(bid.mediaTypes.video.playerSize);
+  const sizes = bid.mediaTypes.video.playerSize.flat();
   return {
     w: parseInt(sizes[0], 10),
     h: parseInt(sizes[1], 10),
@@ -354,34 +341,12 @@ function getVideoAsset(bid) {
     minduration: bid.mediaTypes.video.minduration,
     maxduration: bid.mediaTypes.video.maxduration,
     startdelay: bid.mediaTypes.video.startdelay,
-    placement: bid.mediaTypes.video.plcmt ?? bid.mediaTypes.video.placement,
+    placement: bid.mediaTypes.video.placement,
+    plcmt: bid.mediaTypes.video.plcmt,
     linearity: bid.mediaTypes.video.linearity
   };
 }
 
-/* Turn bid request sizes into ut-compatible format */
-function transformSizes(requestSizes) {
-  if (!isArray(requestSizes)) {
-    return [];
-  }
-
-  if (requestSizes.length === 2 && !isArray(requestSizes[0])) {
-    return [{
-      w: parseInt(requestSizes[0], 10),
-      h: parseInt(requestSizes[1], 10)
-    }];
-  } else if (isArray(requestSizes[0])) {
-    return requestSizes.map(item =>
-      ({
-        w: parseInt(item[0], 10),
-        h: parseInt(item[1], 10)
-      })
-    );
-  }
-
-  return [];
-}
-
 function _getFloor(bid, type) {
   const floorInfo = bid.getFloor({
     currency: CURRENCY,