prebid.js 9.0.0 → 9.2.0

package/libraries/autoplayDetection/autoplay.js

@@ -22,6 +22,12 @@ const autoplayVideoUrl =
   'data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1wNDEAAAAIZnJlZQAAADxtZGF0AAAAMGWIhAAV//73ye/Apuvb3rW/k89I/Cy3PsIqP39atohOSV14BYa1heKCYgALQC5K4QAAAwZtb292AAAAbG12aGQAAAAAAAAAAAAAAAAAAAPoAAAD6AABAAABAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAAACMHRyYWsAAABcdGtoZAAAAAMAAAAAAAAAAAAAAAEAAAAAAAAD6AAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAEAAAAAAoAAAAFoAAAAAACRlZHRzAAAAHGVsc3QAAAAAAAAAAQAAA+gAAAAAAAEAAAAAAahtZGlhAAAAIG1kaGQAAAAAAAAAAAAAAAAAAEAAAABAAFXEAAAAAAAtaGRscgAAAAAAAAAAdmlkZQAAAAAAAAAAAAAAAFZpZGVvSGFuZGxlcgAAAAFTbWluZgAAABR2bWhkAAAAAQAAAAAAAAAAAAAAJGRpbmYAAAAcZHJlZgAAAAAAAAABAAAADHVybCAAAAABAAABE3N0YmwAAACvc3RzZAAAAAAAAAABAAAAn2F2YzEAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAoABaAEgAAABIAAAAAAAAAAEVTGF2YzYwLjMxLjEwMiBsaWJ4MjY0AAAAAAAAAAAAAAAY//8AAAA1YXZjQwFkAAr/4QAYZ2QACqzZQo35IQAAAwABAAADAAIPEiWWAQAGaOvjyyLA/fj4AAAAABRidHJ0AAAAAAAAAaAAAAGgAAAAGHN0dHMAAAAAAAAAAQAAAAEAAEAAAAAAHHN0c2MAAAAAAAAAAQAAAAEAAAABAAAAAQAAABRzdHN6AAAAAAAAADQAAAABAAAAFHN0Y28AAAAAAAAAAQAAADAAAABidWR0YQAAAFptZXRhAAAAAAAAACFoZGxyAAAAAAAAAABtZGlyYXBwbAAAAAAAAAAAAAAAAC1pbHN0AAAAJal0b28AAAAdZGF0YQAAAAEAAAAATGF2ZjYwLjE2LjEwMA==';
 
 function startDetection() {
+  const version = navigator.userAgent.match(/iPhone OS (\d+)_(\d+)/)
+  if (version !== null && parseInt(version[1]) < 17 && !navigator.userAgent.includes('Safari')) {
+    // skip autodetection on iOS 16 WebView
+    return
+  }
+
   // we create an HTMLVideoElement muted and not displayed in which we try to play a one frame video
   const videoElement = document.createElement('video');
   videoElement.src = autoplayVideoUrl;
@@ -32,7 +38,8 @@ function startDetection() {
     .play()
     .then(() => {
       autoplayEnabled = true;
-      videoElement.pause();
+      // if the video is played on a WebView with playsinline = false, this stops the video, to prevent it from being displayed fullscreen
+      videoElement.src = '';
     })
     .catch(() => {
       autoplayEnabled = false;

package/libraries/ortbConverter/converter.js

@@ -117,7 +117,7 @@ export function ortbConverter({
         throw new Error('ortbRequest passed to `fromORTB` must be the same object returned by `toORTB`')
       }
       function augmentContext(ctx, extraParams = {}) {
-        return Object.assign(ctx, {ortbRequest: request}, extraParams, ctx);
+        return Object.assign(ctx, {ortbRequest: request}, extraParams);
       }
       const impsById = Object.fromEntries((request.imp || []).map(imp => [imp.id, imp]));
       const bidResponses = (response.seatbid || []).flatMap(seatbid =>

package/libraries/teqblazeUtils/bidderUtils.js

@@ -0,0 +1,253 @@
+import { BANNER, NATIVE, VIDEO } from '../../src/mediaTypes.js';
+import { deepAccess } from '../../src/utils.js';
+import { config } from '../../src/config.js';
+
+const PROTOCOL_PATTERN = /^[a-z0-9.+-]+:/i;
+
+const isBidResponseValid = (bid) => {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId || !bid.ttl || !bid.currency) {
+    return false;
+  }
+
+  switch (bid.mediaType) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad);
+    case VIDEO:
+      return Boolean(bid.vastUrl || bid.vastXml);
+    case NATIVE:
+      return Boolean(bid.native && bid.native.impressionTrackers && bid.native.impressionTrackers.length);
+    default:
+      return false;
+  }
+};
+
+const getBidFloor = (bid) => {
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+
+    return bidFloor.floor;
+  } catch (err) {
+    return 0;
+  }
+};
+
+const createBasePlacement = (bid) => {
+  const { bidId, mediaTypes, transactionId, userIdAsEids } = bid;
+  const schain = bid.schain || {};
+  const bidfloor = getBidFloor(bid);
+
+  const placement = {
+    bidId,
+    schain,
+    bidfloor
+  };
+
+  if (mediaTypes && mediaTypes[BANNER]) {
+    placement.adFormat = BANNER;
+    placement.sizes = mediaTypes[BANNER].sizes;
+  } else if (mediaTypes && mediaTypes[VIDEO]) {
+    placement.adFormat = VIDEO;
+    placement.playerSize = mediaTypes[VIDEO].playerSize;
+    placement.minduration = mediaTypes[VIDEO].minduration;
+    placement.maxduration = mediaTypes[VIDEO].maxduration;
+    placement.mimes = mediaTypes[VIDEO].mimes;
+    placement.protocols = mediaTypes[VIDEO].protocols;
+    placement.startdelay = mediaTypes[VIDEO].startdelay;
+    placement.placement = mediaTypes[VIDEO].placement;
+    placement.plcmt = mediaTypes[VIDEO].plcmt;
+    placement.skip = mediaTypes[VIDEO].skip;
+    placement.skipafter = mediaTypes[VIDEO].skipafter;
+    placement.minbitrate = mediaTypes[VIDEO].minbitrate;
+    placement.maxbitrate = mediaTypes[VIDEO].maxbitrate;
+    placement.delivery = mediaTypes[VIDEO].delivery;
+    placement.playbackmethod = mediaTypes[VIDEO].playbackmethod;
+    placement.api = mediaTypes[VIDEO].api;
+    placement.linearity = mediaTypes[VIDEO].linearity;
+  } else if (mediaTypes && mediaTypes[NATIVE]) {
+    placement.native = mediaTypes[NATIVE];
+    placement.adFormat = NATIVE;
+  }
+
+  if (transactionId) {
+    placement.ext = placement.ext || {};
+    placement.ext.tid = transactionId;
+  }
+
+  if (userIdAsEids && userIdAsEids.length) {
+    placement.eids = userIdAsEids;
+  }
+
+  return placement;
+};
+
+const defaultPlacementType = (bid, bidderRequest, placement) => {
+  const { placementId, endpointId } = bid.params;
+
+  if (placementId) {
+    placement.placementId = placementId;
+    placement.type = 'publisher';
+  } else if (endpointId) {
+    placement.endpointId = endpointId;
+    placement.type = 'network';
+  }
+};
+
+const checkIfObjectHasKey = (keys, obj, mode = 'some') => {
+  for (let i = 0; i < keys.length; i++) {
+    const key = keys[i];
+    const val = obj[key];
+
+    if (mode === 'some' && val) return true;
+    if (!val) return false;
+  }
+
+  return mode === 'every';
+}
+
+export const isBidRequestValid = (keys = ['placementId', 'endpointId'], mode) => (bid = {}) => {
+  const { params, bidId, mediaTypes } = bid;
+  let valid = Boolean(bidId && params && checkIfObjectHasKey(keys, params, mode));
+
+  if (mediaTypes && mediaTypes[BANNER]) {
+    valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);
+  } else if (mediaTypes && mediaTypes[VIDEO]) {
+    valid = valid && Boolean(mediaTypes[VIDEO] && mediaTypes[VIDEO].playerSize);
+  } else if (mediaTypes && mediaTypes[NATIVE]) {
+    valid = valid && Boolean(mediaTypes[NATIVE]);
+  } else {
+    valid = false;
+  }
+
+  return valid;
+};
+
+/**
+ * @param {{ adUrl, validBidRequests, bidderRequest, placementProcessingFunction }} config
+ * @returns {function}
+ */
+export const buildRequestsBase = (config) => {
+  const { adUrl, validBidRequests, bidderRequest } = config;
+  const placementProcessingFunction = config.placementProcessingFunction || buildPlacementProcessingFunction();
+  const device = deepAccess(bidderRequest, 'ortb2.device');
+  const page = deepAccess(bidderRequest, 'refererInfo.page', '');
+
+  const proto = PROTOCOL_PATTERN.exec(page);
+  const protocol = proto?.[0];
+
+  const placements = [];
+  const request = {
+    deviceWidth: device?.w || 0,
+    deviceHeight: device?.h || 0,
+    language: device?.language?.split('-')[0] || '',
+    secure: protocol === 'https:' ? 1 : 0,
+    host: deepAccess(bidderRequest, 'refererInfo.domain', ''),
+    page,
+    placements,
+    coppa: deepAccess(bidderRequest, 'ortb2.regs.coppa') ? 1 : 0,
+    tmax: bidderRequest.timeout
+  };
+
+  if (bidderRequest.uspConsent) {
+    request.ccpa = bidderRequest.uspConsent;
+  }
+
+  if (bidderRequest.gdprConsent) {
+    request.gdpr = {
+      consentString: bidderRequest.gdprConsent.consentString
+    };
+  }
+
+  if (bidderRequest.gppConsent) {
+    request.gpp = bidderRequest.gppConsent.gppString;
+    request.gpp_sid = bidderRequest.gppConsent.applicableSections;
+  } else if (bidderRequest.ortb2?.regs?.gpp) {
+    request.gpp = bidderRequest.ortb2.regs.gpp;
+    request.gpp_sid = bidderRequest.ortb2.regs.gpp_sid;
+  }
+
+  const len = validBidRequests.length;
+  for (let i = 0; i < len; i++) {
+    const bid = validBidRequests[i];
+    placements.push(placementProcessingFunction(bid, bidderRequest));
+  }
+
+  return {
+    method: 'POST',
+    url: adUrl,
+    data: request
+  };
+};
+
+export const buildRequests = (adUrl) => (validBidRequests = [], bidderRequest = {}) => {
+  const placementProcessingFunction = buildPlacementProcessingFunction();
+
+  return buildRequestsBase({ adUrl, validBidRequests, bidderRequest, placementProcessingFunction });
+};
+
+export const interpretResponse = (serverResponse) => {
+  let response = [];
+  for (let i = 0; i < serverResponse.body.length; i++) {
+    let resItem = serverResponse.body[i];
+    if (isBidResponseValid(resItem)) {
+      const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
+      resItem.meta = { ...resItem.meta, advertiserDomains };
+
+      response.push(resItem);
+    }
+  }
+
+  return response;
+};
+
+export const getUserSyncs = (syncUrl) => (syncOptions, serverResponses, gdprConsent, uspConsent, gppConsent) => {
+  const type = syncOptions.iframeEnabled ? 'iframe' : 'image';
+  let url = syncUrl + `/${type}?pbjs=1`;
+
+  if (gdprConsent && gdprConsent.consentString) {
+    if (typeof gdprConsent.gdprApplies === 'boolean') {
+      url += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+    } else {
+      url += `&gdpr=0&gdpr_consent=${gdprConsent.consentString}`;
+    }
+  }
+
+  if (uspConsent && uspConsent.consentString) {
+    url += `&ccpa_consent=${uspConsent.consentString}`;
+  }
+
+  if (gppConsent?.gppString && gppConsent?.applicableSections?.length) {
+    url += '&gpp=' + gppConsent.gppString;
+    url += '&gpp_sid=' + gppConsent.applicableSections.join(',');
+  }
+
+  const coppa = config.getConfig('coppa') ? 1 : 0;
+  url += `&coppa=${coppa}`;
+
+  return [{
+    type,
+    url
+  }];
+};
+
+/**
+ *
+ * @param {{ addPlacementType?: function, addCustomFieldsToPlacement?: function }} [config]
+ * @returns {function(object, object): object}
+ */
+export const buildPlacementProcessingFunction = (config) => (bid, bidderRequest) => {
+  const addPlacementType = config?.addPlacementType ?? defaultPlacementType;
+
+  const placement = createBasePlacement(bid);
+
+  addPlacementType(bid, bidderRequest, placement);
+
+  if (config?.addCustomFieldsToPlacement) {
+    config.addCustomFieldsToPlacement(bid, bidderRequest, placement);
+  }
+
+  return placement;
+};

package/modules/.submodules.json

@@ -60,6 +60,7 @@
       "1plusXRtdProvider",
       "a1MediaRtdProvider",
       "aaxBlockmeterRtdProvider",
+      "adagioRtdProvider",
       "adlooxRtdProvider",
       "adnuntiusRtdProvider",
       "airgridRtdProvider",

package/modules/acuityadsBidAdapter.js

@@ -1,217 +1,19 @@
-import { isFn, deepAccess, logMessage, logError } from '../src/utils.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
-
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { config } from '../src/config.js';
+import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
 
 const BIDDER_CODE = 'acuityads';
 const AD_URL = 'https://prebid.admanmedia.com/pbjs';
 const SYNC_URL = 'https://cs.admanmedia.com';
 
-function isBidResponseValid(bid) {
-  if (!bid.requestId || !bid.cpm || !bid.creativeId || !bid.ttl || !bid.currency) {
-    return false;
-  }
-
-  switch (bid.mediaType) {
-    case BANNER:
-      return Boolean(bid.width && bid.height && bid.ad);
-    case VIDEO:
-      return Boolean(bid.vastUrl || bid.vastXml);
-    case NATIVE:
-      return Boolean(bid.native && bid.native.impressionTrackers && bid.native.impressionTrackers.length);
-    default:
-      return false;
-  }
-}
-
-function getPlacementReqData(bid) {
-  const { params, bidId, mediaTypes } = bid;
-  const schain = bid.schain || {};
-  const { placementId } = params;
-  const bidfloor = getBidFloor(bid);
-
-  const placement = {
-    bidId,
-    schain,
-    bidfloor
-  };
-
-  placement.placementId = placementId;
-  placement.type = 'publisher';
-
-  if (mediaTypes && mediaTypes[BANNER]) {
-    placement.adFormat = BANNER;
-    placement.sizes = mediaTypes[BANNER].sizes;
-  } else if (mediaTypes && mediaTypes[VIDEO]) {
-    placement.adFormat = VIDEO;
-    placement.playerSize = mediaTypes[VIDEO].playerSize;
-    placement.minduration = mediaTypes[VIDEO].minduration;
-    placement.maxduration = mediaTypes[VIDEO].maxduration;
-    placement.mimes = mediaTypes[VIDEO].mimes;
-    placement.protocols = mediaTypes[VIDEO].protocols;
-    placement.startdelay = mediaTypes[VIDEO].startdelay;
-    placement.placement = mediaTypes[VIDEO].placement;
-    placement.plcmt = mediaTypes[VIDEO].plcmt;
-    placement.skip = mediaTypes[VIDEO].skip;
-    placement.skipafter = mediaTypes[VIDEO].skipafter;
-    placement.minbitrate = mediaTypes[VIDEO].minbitrate;
-    placement.maxbitrate = mediaTypes[VIDEO].maxbitrate;
-    placement.delivery = mediaTypes[VIDEO].delivery;
-    placement.playbackmethod = mediaTypes[VIDEO].playbackmethod;
-    placement.api = mediaTypes[VIDEO].api;
-    placement.linearity = mediaTypes[VIDEO].linearity;
-  } else if (mediaTypes && mediaTypes[NATIVE]) {
-    placement.native = mediaTypes[NATIVE];
-    placement.adFormat = NATIVE;
-  }
-
-  return placement;
-}
-
-function getBidFloor(bid) {
-  if (!isFn(bid.getFloor)) {
-    return deepAccess(bid, 'params.bidfloor', 0);
-  }
-
-  try {
-    const bidFloor = bid.getFloor({
-      currency: 'USD',
-      mediaType: '*',
-      size: '*',
-    });
-    return bidFloor.floor;
-  } catch (err) {
-    logError(err);
-    return 0;
-  }
-}
-
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
 
-  isBidRequestValid: (bid = {}) => {
-    const { params, bidId, mediaTypes } = bid;
-    let valid = Boolean(bidId && params && params.placementId);
-
-    if (mediaTypes && mediaTypes[BANNER]) {
-      valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);
-    } else if (mediaTypes && mediaTypes[VIDEO]) {
-      valid = valid && Boolean(mediaTypes[VIDEO] && mediaTypes[VIDEO].playerSize);
-    } else if (mediaTypes && mediaTypes[NATIVE]) {
-      valid = valid && Boolean(mediaTypes[NATIVE]);
-    } else {
-      valid = false;
-    }
-    return valid;
-  },
-
-  buildRequests: (validBidRequests = [], bidderRequest = {}) => {
-    // convert Native ORTB definition to old-style prebid native definition
-    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
-
-    let deviceWidth = 0;
-    let deviceHeight = 0;
-
-    let winLocation;
-    try {
-      const winTop = window.top;
-      deviceWidth = winTop.screen.width;
-      deviceHeight = winTop.screen.height;
-      winLocation = winTop.location;
-    } catch (e) {
-      logMessage(e);
-      winLocation = window.location;
-    }
-
-    const refferUrl = bidderRequest.refererInfo && bidderRequest.refererInfo.page;
-    let refferLocation;
-    try {
-      refferLocation = refferUrl && new URL(refferUrl);
-    } catch (e) {
-      logMessage(e);
-    }
-    // TODO: does the fallback make sense here?
-    let location = refferLocation || winLocation;
-    const language = (navigator && navigator.language) ? navigator.language.split('-')[0] : '';
-    const host = location.host;
-    const page = location.pathname;
-    const secure = location.protocol === 'https:' ? 1 : 0;
-    const placements = [];
-    const request = {
-      deviceWidth,
-      deviceHeight,
-      language,
-      secure,
-      host,
-      page,
-      placements,
-      coppa: config.getConfig('coppa') === true ? 1 : 0,
-      ccpa: bidderRequest.uspConsent || undefined,
-      gdpr: bidderRequest.gdprConsent || undefined,
-      tmax: bidderRequest.timeout
-    };
-
-    // Add GPP consent
-    if (bidderRequest.gppConsent) {
-      request.gpp = bidderRequest.gppConsent.gppString;
-      request.gpp_sid = bidderRequest.gppConsent.applicableSections;
-    } else if (bidderRequest.ortb2?.regs?.gpp) {
-      request.gpp = bidderRequest.ortb2.regs.gpp;
-      request.gpp_sid = bidderRequest.ortb2.regs.gpp_sid;
-    }
-
-    const len = validBidRequests.length;
-    for (let i = 0; i < len; i++) {
-      const bid = validBidRequests[i];
-      placements.push(getPlacementReqData(bid));
-    }
-
-    return {
-      method: 'POST',
-      url: AD_URL,
-      data: request
-    };
-  },
-
-  interpretResponse: (serverResponse) => {
-    let response = [];
-    for (let i = 0; i < serverResponse.body.length; i++) {
-      let resItem = serverResponse.body[i];
-      if (isBidResponseValid(resItem)) {
-        const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
-        resItem.meta = { ...resItem.meta, advertiserDomains };
-
-        response.push(resItem);
-      }
-    }
-    return response;
-  },
-
-  getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
-    let syncType = syncOptions.iframeEnabled ? 'iframe' : 'image';
-    let syncUrl = SYNC_URL + `/${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}`;
-      }
-    }
-    if (uspConsent && uspConsent.consentString) {
-      syncUrl += `&ccpa_consent=${uspConsent.consentString}`;
-    }
-
-    const coppa = config.getConfig('coppa') ? 1 : 0;
-    syncUrl += `&coppa=${coppa}`;
-
-    return [{
-      type: syncType,
-      url: syncUrl
-    }];
-  }
+  isBidRequestValid: isBidRequestValid(['placementId']),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
 };
 
 registerBidder(spec);

package/modules/adagioBidAdapter.js

@@ -7,13 +7,11 @@ import {
   generateUUID,
   getDNT,
   getWindowSelf,
-  getWindowTop,
   isArray,
   isArrayOfNums,
   isFn,
   isInteger,
   isNumber,
-  isSafeFrameWindow,
   isStr,
   logError,
   logInfo,
@@ -26,6 +24,7 @@ import { config } from '../src/config.js';
 import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
 import { find } from '../src/polyfill.js';
 import { getGptSlotInfoForAdUnitCode } from '../libraries/gptUtils/gptUtils.js';
+import { _ADAGIO } from '../libraries/adagioUtils/adagioUtils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { userSync } from '../src/userSync.js';
 
@@ -78,21 +77,6 @@ export const ORTB_VIDEO_PARAMS = {
  * Returns the window.ADAGIO global object used to store Adagio data.
  * This object is created in window.top if possible, otherwise in window.self.
  */
-const _ADAGIO = (function() {
-  const w = (canAccessWindowTop()) ? getWindowTop() : getWindowSelf();
-
-  w.ADAGIO = w.ADAGIO || {};
-  w.ADAGIO.pageviewId = w.ADAGIO.pageviewId || generateUUID();
-  w.ADAGIO.adUnits = w.ADAGIO.adUnits || {};
-  w.ADAGIO.pbjsAdUnits = w.ADAGIO.pbjsAdUnits || [];
-  w.ADAGIO.queue = w.ADAGIO.queue || [];
-  w.ADAGIO.versions = w.ADAGIO.versions || {};
-  w.ADAGIO.versions.pbjs = '$prebid.version$';
-  w.ADAGIO.isSafeFrameWindow = isSafeFrameWindow();
-
-  return w.ADAGIO;
-})();
-
 function getDevice() {
   const language = navigator.language ? 'language' : 'userLanguage';
   return {