prebid.js 9.1.0 → 9.2.0

package/modules/qtBidAdapter.js

@@ -1,238 +1,19 @@
-import { logMessage, deepAccess } 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 = 'qt';
 const AD_URL = 'https://endpoint1.qt.io/pbjs';
 const SYNC_URL = 'https://cs.qt.io';
 
-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, transactionId, userIdAsEids } = bid;
-  const schain = bid.schain || {};
-  const { placementId, endpointId } = params;
-  const bidfloor = getBidFloor(bid);
-
-  const placement = {
-    bidId,
-    schain,
-    bidfloor
-  };
-
-  if (placementId) {
-    placement.placementId = placementId;
-    placement.type = 'publisher';
-  } else if (endpointId) {
-    placement.endpointId = endpointId;
-    placement.type = 'network';
-  }
-
-  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.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;
-}
-
-function getBidFloor(bid) {
-  try {
-    const bidFloor = bid.getFloor({
-      currency: 'USD',
-      mediaType: '*',
-      size: '*',
-    });
-    return bidFloor.floor;
-  } catch (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 || params.endpointId));
-
-    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);
-    }
-
-    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: 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(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, gppConsent) => {
-    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}`;
-    }
-
-    if (gppConsent?.gppString && gppConsent?.applicableSections?.length) {
-      syncUrl += '&gpp=' + gppConsent.gppString;
-      syncUrl += '&gpp_sid=' + gppConsent.applicableSections.join(',');
-    }
-
-    const coppa = config.getConfig('coppa') ? 1 : 0;
-    syncUrl += `&coppa=${coppa}`;
-
-    return [{
-      type: syncType,
-      url: syncUrl
-    }];
-  }
+  isBidRequestValid: isBidRequestValid(),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
 };
 
 registerBidder(spec);

package/modules/raynRtdProvider.js

@@ -14,6 +14,7 @@ import { deepAccess, deepSetValue, logError, logMessage, mergeDeep } from '../sr
 const MODULE_NAME = 'realTimeData';
 const SUBMODULE_NAME = 'rayn';
 const RAYN_TCF_ID = 1220;
+const RAYN_PERSONA_TAXONOMY_ID = 103015;
 const LOG_PREFIX = 'RaynJS: ';
 export const SEGMENTS_RESOLVER = 'rayn.io';
 export const RAYN_LOCAL_STORAGE_KEY = 'rayn-segtax';
@@ -77,6 +78,32 @@ export function generateOrtbDataObject(segtax, segment, maxTier) {
   };
 }
 
+/**
+ * Create and return ORTB2 object with segtax and personaIds
+ * @param {number} segtax
+ * @param {Array} personaIds
+ * @return {Array}
+ */
+export function generatePersonaOrtbDataObject(segtax, personaIds) {
+  const segmentIds = [];
+
+  try {
+    segmentIds.push(...personaIds.map((id) => {
+      return { id };
+    }))
+  } catch (error) {
+    logError(LOG_PREFIX, error);
+  }
+
+  return {
+    name: SEGMENTS_RESOLVER,
+    ext: {
+      segtax,
+    },
+    segment: segmentIds,
+  };
+}
+
 /**
  * Generates checksum
  * @param {string} url
@@ -127,8 +154,14 @@ export function setSegmentsAsBidderOrtb2(bidConfig, bidders, integrationConfig,
     deepSetValue(raynOrtb2, 'site.content.data', raynContentData);
   }
 
+  const raynUserData = [];
   if (integrationConfig.iabAudienceCategories.v1_1.enabled && segments[4]) {
-    const raynUserData = [generateOrtbDataObject(4, segments[4], integrationConfig.iabAudienceCategories.v1_1.tier)];
+    raynUserData.push(generateOrtbDataObject(4, segments[4], integrationConfig.iabAudienceCategories.v1_1.tier));
+  }
+  if (segments[RAYN_PERSONA_TAXONOMY_ID]) {
+    raynUserData.push(generatePersonaOrtbDataObject(RAYN_PERSONA_TAXONOMY_ID, segments[RAYN_PERSONA_TAXONOMY_ID]));
+  }
+  if (raynUserData.length > 0) {
     deepSetValue(raynOrtb2, 'user.data', raynUserData);
   }
 
@@ -163,8 +196,8 @@ function alterBidRequests(reqBidsConfigObj, callback, config, userConsent) {
       segments[checksum] || (segments[4] &&
         integrationConfig.iabAudienceCategories.v1_1.enabled &&
         !integrationConfig.iabContentCategories.v2_2.enabled &&
-        !integrationConfig.iabContentCategories.v3_0.enabled
-      )
+        !integrationConfig.iabContentCategories.v3_0.enabled) ||
+      segments[RAYN_PERSONA_TAXONOMY_ID]
     )) {
       logMessage(LOG_PREFIX, `Segtax data from localStorage: ${JSON.stringify(segments)}`);
       setSegmentsAsBidderOrtb2(reqBidsConfigObj, bidders, integrationConfig, segments, checksum);

package/modules/seedtagBidAdapter.js

@@ -119,6 +119,7 @@ function buildBidRequest(validBidRequest) {
   const bidRequest = {
     id: validBidRequest.bidId,
     transactionId: validBidRequest.ortb2Imp?.ext?.tid,
+    gpid: validBidRequest.ortb2Imp?.ext?.gpid,
     sizes: validBidRequest.sizes,
     supplyTypes: mediaTypes,
     adUnitId: params.adUnitId,

package/modules/setupadBidAdapter.js

@@ -1,14 +1,14 @@
 import {
   _each,
-  createTrackPixelHtml,
-  deepAccess,
   isStr,
   getBidIdParameter,
   triggerPixel,
   logWarn,
+  deepSetValue,
 } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
 
 const BIDDER_CODE = 'setupad';
 const ENDPOINT = 'https://prebid.setupad.io/openrtb2/auction';
@@ -16,11 +16,39 @@ const SYNC_ENDPOINT = 'https://cookie.stpd.cloud/sync?';
 const REPORT_ENDPOINT = 'https://adapter-analytics.setupad.io/api/adapter-analytics?';
 const GVLID = 1241;
 const TIME_TO_LIVE = 360;
-const biddersCreativeIds = {};
-
-function getEids(bidRequest) {
-  if (deepAccess(bidRequest, 'userIdAsEids')) return bidRequest.userIdAsEids;
-}
+export const biddersCreativeIds = {}; // export only for tests
+const NET_REVENUE = true;
+const TEST_REQUEST = 0; // used only for testing
+
+const converter = ortbConverter({
+  context: {
+    netRevenue: NET_REVENUE,
+    ttl: TIME_TO_LIVE,
+  },
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    deepSetValue(
+      imp,
+      'ext.prebid.storedrequest.id',
+      getBidIdParameter('placement_id', bidRequest.params)
+    );
+    return imp;
+  },
+  request(buildRequest, imps, bidderRequest, context) {
+    const request = buildRequest(imps, bidderRequest, context);
+    deepSetValue(request, 'test', TEST_REQUEST);
+    deepSetValue(
+      request,
+      'ext.prebid.storedrequest.id',
+      getBidIdParameter(
+        'account_id',
+        bidderRequest.bids.find((bid) => bid.hasOwnProperty('params')).params
+      )
+    );
+    deepSetValue(request, 'setupad', 'adapter');
+    return request;
+  },
+});
 
 export const spec = {
   code: BIDDER_CODE,
@@ -37,97 +65,17 @@ export const spec = {
   },
 
   buildRequests: function (validBidRequests, bidderRequest) {
-    const requests = [];
-
-    _each(validBidRequests, function (bid) {
-      const id = getBidIdParameter('placement_id', bid.params);
-      const accountId = getBidIdParameter('account_id', bid.params);
-      const auctionId = bid.auctionId;
-      const bidId = bid.bidId;
-      const eids = getEids(bid) || undefined;
-      let sizes = bid.sizes;
-      if (sizes && !Array.isArray(sizes[0])) sizes = [sizes];
-
-      const site = {
-        page: bidderRequest?.refererInfo?.page,
-        ref: bidderRequest?.refererInfo?.ref,
-        domain: bidderRequest?.refererInfo?.domain,
-      };
-      const device = {
-        w: bidderRequest?.ortb2?.device?.w,
-        h: bidderRequest?.ortb2?.device?.h,
-      };
-
-      const payload = {
-        id: bid?.bidderRequestId,
-        ext: {
-          prebid: {
-            storedrequest: {
-              id: accountId || 'default',
-            },
-          },
-        },
-        user: { ext: { eids } },
-        device,
-        site,
-        imp: [],
-      };
-
-      const imp = {
-        id: bid.adUnitCode,
-        ext: {
-          prebid: {
-            storedrequest: { id },
-          },
-        },
-      };
-
-      if (deepAccess(bid, 'mediaTypes.banner')) {
-        imp.banner = {
-          format: (sizes || []).map((s) => {
-            return { w: s[0], h: s[1] };
-          }),
-        };
-      }
-
-      payload.imp.push(imp);
-
-      const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
-      const uspConsent = bidderRequest && bidderRequest.uspConsent;
-
-      if (gdprConsent || uspConsent) {
-        payload.regs = { ext: {} };
-
-        if (uspConsent) payload.regs.ext.us_privacy = uspConsent;
-
-        if (gdprConsent) {
-          if (typeof gdprConsent.gdprApplies !== 'undefined') {
-            payload.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
-          }
-
-          if (typeof gdprConsent.consentString !== 'undefined') {
-            payload.user.ext.consent = gdprConsent.consentString;
-          }
-        }
-      }
-      const params = bid.params;
-
-      requests.push({
-        method: 'POST',
-        url: ENDPOINT,
-        data: JSON.stringify(payload),
-        options: {
-          contentType: 'text/plain',
-          withCredentials: true,
-        },
-
-        bidId,
-        params,
-        auctionId,
-      });
-    });
-
-    return requests;
+    const data = converter.toORTB({ validBidRequests, bidderRequest });
+
+    return {
+      method: 'POST',
+      url: ENDPOINT,
+      data,
+      options: {
+        contentType: 'text/plain',
+        withCredentials: true,
+      },
+    };
   },
 
   interpretResponse: function (serverResponse, bidRequest) {
@@ -141,40 +89,22 @@ export const spec = {
       return [];
     }
 
-    const serverBody = serverResponse.body;
-    const bidResponses = [];
-
-    _each(serverBody.seatbid, (res) => {
+    // set a seat for creativeId for triggerPixel url
+    _each(serverResponse.body.seatbid, (res) => {
       _each(res.bid, (bid) => {
-        const requestId = bidRequest.bidId;
-        const params = bidRequest.params;
-        const { ad, adUrl } = getAd(bid);
-
-        const bidResponse = {
-          requestId,
-          params,
-          cpm: bid.price,
-          width: bid.w,
-          height: bid.h,
-          creativeId: bid.id,
-          currency: serverBody.cur,
-          netRevenue: true,
-          ttl: TIME_TO_LIVE,
-          meta: {
-            advertiserDomains: bid.adomain || [],
-          },
-        };
-
-        // set a seat for creativeId for triggerPixel url
-        biddersCreativeIds[bidResponse.creativeId] = res.seat;
-
-        bidResponse.ad = ad;
-        bidResponse.adUrl = adUrl;
-        bidResponses.push(bidResponse);
+        biddersCreativeIds[bid.crid] = res.seat;
       });
     });
 
-    return bidResponses;
+    // used for a test case "should update biddersCreativeIds correctly" to return early and not throw ORTB error
+    if (serverResponse.testCase === 1) return;
+
+    const bids = converter.fromORTB({
+      response: serverResponse.body,
+      request: bidRequest.data,
+    }).bids;
+
+    return bids;
   },
 
   getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent) {
@@ -261,16 +191,4 @@ function getBidders(serverResponse) {
   }
 }
 
-function getAd(bid) {
-  const { adm, nurl } = bid;
-  let ad = adm;
-
-  if (nurl) {
-    const trackingPixel = createTrackPixelHtml(decodeURIComponent(nurl));
-    ad += trackingPixel;
-  }
-
-  return { ad };
-}
-
 registerBidder(spec);

package/modules/smartytechBidAdapter.js

@@ -127,14 +127,19 @@ export const spec = {
       creativeId: response.creativeId,
       netRevenue: true,
       currency: response.currency,
-      mediaType: BANNER
-    }
+      mediaType: BANNER,
+      meta: {}
+    };
 
     if (response.mediaType === VIDEO) {
       bidObject.vastXml = response.ad;
       bidObject.mediaType = VIDEO;
     }
 
+    if (response.meta) {
+      bidObject.meta = response.meta;
+    }
+
     return bidObject;
   },
 

package/modules/topicsFpdModule.js

@@ -130,7 +130,7 @@ export function processFpd(config, {global}, {data = topicsData} = {}) {
 export function getCachedTopics() {
   let cachedTopicData = [];
   const topics = config.getConfig('userSync.topics');
-  const bidderList = topics.bidders || [];
+  const bidderList = topics?.bidders || [];
   let storedSegments = new Map(safeJSONParse(coreStorage.getDataFromLocalStorage(topicStorageName)));
   storedSegments && storedSegments.forEach((value, cachedBidder) => {
     // Check bidder exist in config for cached bidder data and then only retrieve the cached data

package/modules/uid2IdSystem.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 /**
  * This module adds uid2 ID support to the User ID module
  * The {@link module:modules/userId} module is required.

package/modules/uid2IdSystem_shared.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import { ajax } from '../src/ajax.js';
 import { cyrb53Hash } from '../src/utils.js';