prebid.js 7.25.0 → 7.26.0

package/modules/admaticBidAdapter.js

@@ -1,94 +1,93 @@
 import { getValue, logError, deepAccess, getBidIdParameter, isArray } from '../src/utils.js';
-import { loadExternalScript } from '../src/adloader.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-
-const ENDPOINT_URL = 'https://layer.serve.admatic.com.tr/pb';
-const SYNC_URL = 'https://cdn.serve.admatic.com.tr/showad/sync.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+const SYNC_URL = 'https://cdn.serve.admatic.com.tr/showad/sync.html';
 const BIDDER_CODE = 'admatic';
-
 export const spec = {
-  code: 'admatic',
-  supportedMediaTypes: ['video', 'banner'],
-  /**
-   * Determines whether or not the given bid request is valid.
-   *
-   * @param {BidRequest} bid The bid params to validate.
-   * @return boolean True if this is a valid bid, and false otherwise.
+  code: BIDDER_CODE,
+  aliases: [
+    {code: 'pixad'}
+  ],
+  supportedMediaTypes: [BANNER, VIDEO],
+  /** f
+   * @param {object} bid
+   * @return {boolean}
    */
-  isBidRequestValid: function(bid) {
+  isBidRequestValid: (bid) => {
     let isValid = false;
-    if (typeof bid.params !== 'undefined') {
-      let isValidNetworkId = _validateId(getValue(bid.params, 'networkId'));
-      isValid = isValidNetworkId;// && isValidTypeId;
+    if (bid?.params) {
+      const isValidNetworkId = _validateId(getValue(bid.params, 'networkId'));
+      const isValidHost = _validateString(getValue(bid.params, 'host'));
+      isValid = isValidNetworkId && isValidHost;
     }
 
     if (!isValid) {
-      logError('AdMatic networkId parameters are required. Bid aborted.');
+      logError(`${bid.bidder} networkId and host parameters are required. Bid aborted.`);
     }
     return isValid;
   },
+
   /**
-   * Make a server request from the list of BidRequests.
-   *
-   * @param {validBidRequests[]} an array of bids
-   * @return ServerRequest Info describing the request to the server.
+   * @param {BidRequest[]} validBidRequests
+   * @return {ServerRequest}
    */
-  buildRequests: function(validBidRequests, bidderRequest) {
+  buildRequests: (validBidRequests, bidderRequest) => {
     const bids = validBidRequests.map(buildRequestObject);
     const networkId = getValue(validBidRequests[0].params, 'networkId');
+    const host = getValue(validBidRequests[0].params, 'host');
     const currency = getValue(validBidRequests[0].params, 'currency') || 'TRY';
-
-    setTimeout(() => {
-      loadExternalScript(SYNC_URL, BIDDER_CODE);
-    }, bidderRequest.timeout);
+    const bidderName = validBidRequests[0].bidder;
 
     const payload = {
-      'user': {
-        'ua': navigator.userAgent
+      user: {
+        ua: navigator.userAgent
       },
-      'blacklist': [],
-      'site': {
-        'page': location.href,
-        'ref': location.origin,
-        'publisher': {
-          'name': location.hostname,
-          'publisherId': networkId
+      blacklist: [],
+      site: {
+        page: location.href,
+        ref: location.origin,
+        publisher: {
+          name: location.hostname,
+          publisherId: networkId
         }
       },
       imp: bids,
       ext: {
-        'cur': currency,
-        'type': 'admatic'
+        cur: currency,
+        bidder: bidderName
       }
     };
 
-    const payloadString = JSON.stringify(payload);
-    return {
-      method: 'POST',
-      url: ENDPOINT_URL,
-      data: payloadString,
-      options: {
-        contentType: 'application/json'
-      }
-    };
+    if (payload) {
+      return { method: 'POST', url: `https://${host}/pb?bidder=${bidderName}`, data: payload, options: { contentType: 'application/json' } };
+    }
+  },
+
+  getUserSyncs: function (syncOptions, responses) {
+    if (syncOptions.iframeEnabled) {
+      return [{
+        type: 'iframe',
+        url: SYNC_URL
+      }];
+    }
   },
+
   /**
-   * Unpack the response from the server into a list of bids.
-   *
-   * @param {*} serverResponse A successful response from the server.
-   * @return {Bid[]} An array of bids which were nested inside the server.
+   * @param {*} response
+   * @param {ServerRequest} request
+   * @return {Bid[]}
    */
   interpretResponse: (response, request) => {
     const body = response.body || response;
     const bidResponses = [];
-    if (body.data.length > 0) {
-      body.data.forEach(function (bid) {
+    if (body && body?.data && isArray(body.data)) {
+      body.data.forEach(bid => {
         const resbid = {
           requestId: bid.id,
           cpm: bid.price,
           width: bid.width,
           height: bid.height,
-          currency: body.cur,
+          currency: body.cur || 'TRY',
           netRevenue: true,
           ad: bid.party_tag,
           creativeId: bid.creative_id,
@@ -96,22 +95,68 @@ export const spec = {
             advertiserDomains: bid && bid.adomain ? bid.adomain : []
           },
           ttl: 360,
-          bidder: 'admatic',
-          timeToRespond: 1,
-          requestTimestamp: 1
+          bidder: bid.bidder
         };
+
         bidResponses.push(resbid);
       });
-    };
+    }
     return bidResponses;
   }
 };
 
+function enrichSlotWithFloors(slot, bidRequest) {
+  try {
+    const slotFloors = {};
+
+    if (bidRequest.getFloor) {
+      if (bidRequest.mediaTypes?.banner) {
+        slotFloors.banner = {};
+        const bannerSizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.banner.sizes'))
+        bannerSizes.forEach(bannerSize => slotFloors.banner[parseSize(bannerSize).toString()] = bidRequest.getFloor({ size: bannerSize, mediaType: BANNER }));
+      }
+
+      if (bidRequest.mediaTypes?.video) {
+        slotFloors.video = {};
+        const videoSizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'))
+        videoSizes.forEach(videoSize => slotFloors.video[parseSize(videoSize).toString()] = bidRequest.getFloor({ size: videoSize, mediaType: VIDEO }));
+      }
+
+      if (Object.keys(slotFloors).length > 0) {
+        if (!slot) {
+          slot = {}
+        }
+        Object.assign(slot, {
+          floors: slotFloors
+        });
+      }
+    }
+  } catch (e) {
+    logError('Could not parse floors from Prebid: ' + e);
+  }
+}
+
+function parseSizes(sizes, parser = s => s) {
+  if (sizes == undefined) {
+    return [];
+  }
+  if (Array.isArray(sizes[0])) { // is there several sizes ? (ie. [[728,90],[200,300]])
+    return sizes.map(size => parser(size));
+  }
+  return [parser(sizes)]; // or a single one ? (ie. [728,90])
+}
+
+function parseSize(size) {
+  return size[0] + 'x' + size[1];
+}
+
 function buildRequestObject(bid) {
   const reqObj = {};
   reqObj.size = getSizes(bid);
   reqObj.id = getBidIdParameter('bidId', bid);
-  reqObj.floor = getValue(bid.params, 'floor') || 0.01;
+
+  enrichSlotWithFloors(reqObj, bid);
+
   return reqObj;
 }
 
@@ -144,4 +189,8 @@ function _validateId(id) {
   return (parseInt(id) > 0);
 }
 
+function _validateString(str) {
+  return (typeof str == 'string');
+}
+
 registerBidder(spec);

package/modules/admaticBidAdapter.md

@@ -19,7 +19,7 @@ Use `admatic` as bidder.
           bidder: 'admatic',
           params: { 
               networkId: 12345,
-              floor: 0.5
+              host: 'layer.serve.admatic.com.tr'
           }
       }]
     },{
@@ -29,7 +29,7 @@ Use `admatic` as bidder.
           bidder: 'admatic',
           params: { 
               networkId: 12345,
-              floor: 0.5
+              host: 'layer.serve.admatic.com.tr'
           }
       }]
     }];

package/modules/beopBidAdapter.js

@@ -1,4 +1,4 @@
-import { deepAccess, isArray, logWarn, triggerPixel, buildUrl, logInfo, getValue, getBidIdParameter } from '../src/utils.js';
+import { deepAccess, isArray, isStr, logWarn, triggerPixel, buildUrl, logInfo, getValue, getBidIdParameter } from '../src/utils.js';
 import { getRefererInfo } from '../src/refererDetection.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
@@ -40,6 +40,19 @@ export const spec = {
     const pageUrl = getPageUrl(bidderRequest.refererInfo, window);
     const gdpr = bidderRequest.gdprConsent;
     const firstSlot = slots[0];
+    const kwdsFromRequest = firstSlot.kwds;
+    let keywords = [];
+    if (kwdsFromRequest) {
+      if (isArray(kwdsFromRequest)) {
+        keywords = kwdsFromRequest;
+      } else if (isStr(kwdsFromRequest)) {
+        if (kwdsFromRequest.indexOf(',') != -1) {
+          keywords = kwdsFromRequest.split(',').map((e) => { return e.trim() });
+        } else {
+          keywords.push(kwdsFromRequest);
+        }
+      }
+    }
     const payloadObject = {
       at: new Date().toString(),
       nid: firstSlot.nid,
@@ -47,12 +60,13 @@ export const spec = {
       pid: firstSlot.pid,
       url: pageUrl,
       lang: (window.navigator.language || window.navigator.languages[0]),
-      kwds: bidderRequest.ortb2?.site?.keywords || [],
+      kwds: keywords,
       dbg: false,
       slts: slots,
       is_amp: deepAccess(bidderRequest, 'referrerInfo.isAmp'),
       tc_string: (gdpr && gdpr.gdprApplies) ? gdpr.consentString : null,
     };
+
     const payloadString = JSON.stringify(payloadObject);
     return {
       method: 'POST',
@@ -129,6 +143,7 @@ function beOpRequestSlotsMaker(bid) {
     sizes: isArray(bannerSizes) ? bannerSizes : bid.sizes,
     flr: floor,
     pid: getValue(bid.params, 'accountId'),
+    kwds: getValue(bid.params, 'keywords'),
     nid: getValue(bid.params, 'networkId'),
     nptnid: getValue(bid.params, 'networkPartnerId'),
     bid: getBidIdParameter('bidId', bid),

package/modules/captifyRtdProvider.js

@@ -0,0 +1,146 @@
+/**
+ * This module adds Captify real time data provider module
+ * The {@link module:modules/realTimeData} module is required
+ * The module will fetch segments (page-centric) from Captify live-classification server
+ * @module modules/captifyRtdProvider
+ * @requires module:modules/realTimeData
+ */
+import { submodule } from '../src/hook.js';
+import { getRefererInfo } from '../src/refererDetection.js';
+import { ajax } from '../src/ajax.js';
+import { config } from '../src/config.js';
+import {deepAccess, isArray, isEmptyStr, isNumber, logError} from '../src/utils.js';
+import {getGlobal} from '../src/prebidGlobal.js';
+
+const MODULE_NAME = 'realTimeData';
+const SUBMODULE_NAME = 'CaptifyRTDModule';
+const DEFAULT_LC_URL = 'https://live-classification.cpx.to/prebid-segments';
+
+const STATUS = {
+  SUCCESS: 200,
+  ACCEPTED: 202,
+};
+
+/**
+ * Set `appnexusAuctionKeywords` that appnexus bidder will read and send in request to Xandr
+ * @param {Array<number>} segments captify segments for Appnexus(Xandr) system, in form of [id1, id2, id3]
+ *                 where id1, id2, id3 - actual Xandr segment ids with keywords enabled
+ */
+export function setAppnexusSegments(segments) {
+  config.setConfig({
+    appnexusAuctionKeywords: {
+      'captify_segments': segments,
+    },
+  })
+}
+
+/**
+ * Function returns only bidders that contained both, in moduleConfig and at least one adUnit.
+ * @param {Array<string>} bidders Contains list of bidders, to set targeting for
+ * @param {Object} data Response of live-classification service
+ */
+export function addSegmentData(bidders, data) {
+  for (const bidder of bidders) {
+    if (bidder === 'appnexus') { setAppnexusSegments(data['xandr']) }
+  }
+}
+
+/**
+ * Function returns only bidders that contained in both, moduleConfig and at least one adUnit.
+ * @param {Object} moduleConfig Config object passed to the module
+ * @param {Object} reqBidsConfigObj Config object for the bidders; each adapter has its own entry
+ */
+export function getMatchingBidders(moduleConfig, reqBidsConfigObj) {
+  const biddersFromConf = deepAccess(moduleConfig, 'params.bidders');
+
+  const adUnitBidders = reqBidsConfigObj.adUnits
+    .flatMap(({bids}) => bids.map(({bidder}) => bidder))
+    .filter((e, i, a) => a.indexOf(e) === i);
+
+  if (!isArray(adUnitBidders) || !adUnitBidders.length) {
+    logError(SUBMODULE_NAME, 'Missing parameter bidders in bidRequestConfig');
+    return [];
+  }
+
+  return biddersFromConf.filter(bidder => adUnitBidders.includes(bidder));
+}
+
+/**
+ * Main function that sets Captify targeting for various bidders
+ * @param {Object} moduleConfig Config object passed to the module
+ * @param {Function} onDone callback function that executed when everything is done
+ * @param {Object} reqBidsConfigObj Config object for the bidders; each adapter has its own entry
+ * @param {Object} gcv contains data related to user consent, if applies
+ */
+export function setCaptifyTargeting(reqBidsConfigObj, onDone, moduleConfig, gcv) {
+  const pbjsVer = getGlobal();
+  const ref = getRefererInfo().referer;
+  const url = document.URL;
+  const pubId = moduleConfig.params.pubId;
+  const bidders = getMatchingBidders(moduleConfig, reqBidsConfigObj)
+  const requestBody = {
+    pubId,
+    ref,
+    url,
+    pbjsVer,
+    gcv
+  };
+  let requestUrl = moduleConfig.params.url;
+  if (!requestUrl || isEmptyStr(requestUrl)) {
+    requestUrl = DEFAULT_LC_URL;
+  }
+
+  if (!bidders.length) {
+    logError(SUBMODULE_NAME, 'There are no matched bidders to work with');
+    return;
+  }
+
+  ajax(requestUrl, {
+    success: function (response, req) {
+      if (req.status === STATUS.SUCCESS) {
+        try {
+          const data = JSON.parse(response);
+          if (data) {
+            addSegmentData(bidders, data);
+          }
+        } catch (e) {
+          logError(SUBMODULE_NAME, 'Unable to parse live-classification data' + e);
+        }
+      }
+      onDone();
+    },
+    error: function () {
+      onDone();
+      logError(SUBMODULE_NAME, 'Unable to get live-classification data');
+    }
+  },
+  JSON.stringify(requestBody),
+  {
+    contentType: 'application/json',
+    method: 'POST',
+  });
+}
+
+export function init(moduleConfig, userConsent) {
+  // Validate bidders
+  const biddersFromConf = deepAccess(moduleConfig, 'params.bidders');
+  if (!isArray(biddersFromConf) || !biddersFromConf.length) {
+    logError(SUBMODULE_NAME, 'Missing parameter bidders in moduleConfig');
+    return false
+  }
+  const publisherId = deepAccess(moduleConfig, 'params.pubId');
+  // Publisher Id
+  if (!isNumber(publisherId)) {
+    logError(SUBMODULE_NAME, 'Missing parameter pubId in moduleConfig');
+    return false
+  }
+  return true
+}
+
+export const captifySubmodule = {
+  name: SUBMODULE_NAME,
+  init: init,
+  setCaptifyTargeting
+};
+
+submodule(MODULE_NAME, captifySubmodule);

package/modules/captifyRtdProvider.md

@@ -0,0 +1,68 @@
+# Captify Real-Time Data Submodule
+
+# Overview
+
+    Module Name: Captify Rtd Provider
+    Module Type: Rtd Provider
+	Layout: integrationExamples/gpt/captifyRtdProvider_example.html
+    Maintainer: prebid@captify.tech
+
+# Description
+
+Captify uses publisher first-party on-site search data to power machine learning algorithms to create a suite of
+contextual based targeting solutions that activate in a cookieless environment.
+
+The RTD submodule allows bid requests to be classified by our live-classification service on the first ad call,
+maximising value for publishers by increasing scale for advertisers.
+
+Segments will be attached to bid request objects sent to different SSPs in order to optimize targeting.
+
+Contact prebid@captify.tech for information.
+
+### Publisher Usage
+
+Compile the Captify RTD module into your Prebid build:
+
+`npm ci && gulp build --modules=rtdModule,appnexusBidAdapter,captifyRtdProvider`
+
+Add the Captify RTD provider to your Prebid config.
+
+```javascript
+pbjs.setConfig({
+    realTimeData: {
+        auctionDelay: 1000,
+        dataProviders: [
+            {
+                name: "CaptifyRTDModule",
+                waitForIt: true,
+                params: {
+                    pubId: 123456,
+                    bidders: ['appnexus'],
+                }
+            }
+        ]
+    }
+});
+```
+
+### Parameter Description
+This module is configured as part of the `realTimeData.dataProviders` object.
+
+| Name           |Type           | Description                                                         |Mandatory | Notes  |
+| :------------- | :------------ | :------------------------------------------------------------------ |:---------|:------------ |
+| name           | String        | Real time data module name                                          | yes     | Always 'CaptifyRTDModule' |
+| waitForIt      | Boolean       | Should be `true` if there's an `auctionDelay` defined (recommended) | no      | Default `false` |
+| params         | Object        | |  | |
+| params.pubId   | Integer       | Partner ID, required to get results and provided by Captify         | yes      | Use 123456 for tests and speak to your Captify account manager to receive your pubId |
+| params.bidders | Array<String> | List of bidders for which you would like data to be set             | yes      | Currently only 'appnexus' supported |
+| params.url     | String        | Captify live-classification service url                             | no       | Defaults to `https://live-classification.cpx.to/prebid-segments`
+
+### Testing
+
+To view an example of available segments returned by Captify:
+
+`gulp serve --modules=rtdModule,captifyRtdProvider,appnexusBidAdapter`
+
+and then point your browser at:
+
+`http://localhost:9999/integrationExamples/gpt/captifyRtdProvider_example.html?pbjs_debug=true`

package/modules/discoveryBidAdapter.js

@@ -12,7 +12,8 @@ let itemMaps = {};
 const MEDIATYPE = [BANNER, NATIVE];
 
 /* ----- _ss_pp_id:start ------ */
-const COOKIE_KEY_MGUID = '_ss_pp_id';
+const COOKIE_KEY_SSPPID = '_ss_pp_id';
+const COOKIE_KEY_MGUID = '__mguid_';
 
 const NATIVERET = {
   id: 'id',
@@ -58,14 +59,20 @@ const NATIVERET = {
  * @return {string}
  */
 const getUserID = () => {
-  const i = storage.getCookie(COOKIE_KEY_MGUID);
+  let idd = storage.getCookie(COOKIE_KEY_SSPPID);
+  let idm = storage.getCookie(COOKIE_KEY_MGUID);
 
-  if (i === null) {
+  if (idd && !idm) {
+    idm = idd
+  } else if (idm && !idd) {
+    idd = idm
+  } else if (!idd && !idm) {
     const uuid = utils.generateUUID();
     storage.setCookie(COOKIE_KEY_MGUID, uuid);
+    storage.setCookie(COOKIE_KEY_SSPPID, uuid);
     return uuid;
   }
-  return i;
+  return idd;
 };
 
 /* ----- _ss_pp_id:end ------ */
@@ -80,7 +87,6 @@ function getKv(obj, ...keys) {
   let o = obj;
 
   for (let key of keys) {
-    // console.log(key, o);
     if (o && o[key]) {
       o = o[key];
     } else {
@@ -222,7 +228,7 @@ function getItems(validBidRequests, bidderRequest) {
     let id = '' + (i + 1);
 
     if (mediaTypes.native) {
-      ret = {...NATIVERET, ...{id, bidFloor}}
+      ret = { ...NATIVERET, ...{ id, bidFloor } }
     }
     // banner
     if (mediaTypes.banner) {
@@ -249,6 +255,7 @@ function getItems(validBidRequests, bidderRequest) {
           pos: 1,
         },
         ext: {},
+        tagid: globals['tagid'],
       };
     }
     itemMaps[id] = {
@@ -273,14 +280,19 @@ function getParam(validBidRequests, bidderRequest) {
   let auctionId = getKv(bidderRequest, 'auctionId');
   let items = getItems(validBidRequests, bidderRequest);
 
-  const location = utils.deepAccess(bidderRequest, 'refererInfo.referer');
-
   const timeout = bidderRequest.timeout || 2000;
 
+  const domain = utils.deepAccess(bidderRequest, 'refererInfo.domain') || document.domain;
+  const location = utils.deepAccess(bidderRequest, 'refererInfo.referer');
+  const page = utils.deepAccess(bidderRequest, 'refererInfo.page');
+  const referer = utils.deepAccess(bidderRequest, 'refererInfo.ref');
+
   if (items && items.length) {
     let c = {
       id: 'pp_hbjs_' + auctionId,
       at: 1,
+      bcat: globals['bcat'],
+      badv: globals['adv'],
       cur: ['USD'],
       device: {
         connectiontype: 0,
@@ -295,16 +307,16 @@ function getParam(validBidRequests, bidderRequest) {
       },
       tmax: timeout,
       site: {
-        name: globals['media'],
-        domain: globals['media'],
-        page: location,
-        ref: location,
+        name: domain,
+        domain: domain,
+        page: page || location,
+        ref: referer,
         mobile: isMobile,
         cat: [], // todo
         publisher: {
+          id: globals['publisher']
           // todo
-          id: globals['media'],
-          name: globals['media'],
+          // name: xxx
         },
       },
       imp: items,
@@ -329,10 +341,19 @@ export const spec = {
     if (bid.params.token) {
       globals['token'] = bid.params.token;
     }
-    if (bid.params.media) {
-      globals['media'] = bid.params.media;
+    if (bid.params.publisher) {
+      globals['publisher'] = bid.params.publisher;
+    }
+    if (bid.params.tagid) {
+      globals['tagid'] = bid.params.tagid;
+    }
+    if (bid.params.bcat) {
+      globals['bcat'] = Array.isArray(bid.params.bcat) ? bid.params.bcat : [];
+    }
+    if (bid.params.badv) {
+      globals['badv'] = Array.isArray(bid.params.badv) ? bid.params.badv : [];
     }
-    return !!(bid.params.token && bid.params.media);
+    return !!(bid.params.token && bid.params.publisher && bid.params.tagid);
   },
 
   /**

package/modules/discoveryBidAdapter.md

@@ -1,15 +1,15 @@
 # Overview
 
 ```
-Module Name: DiscoveryDSP Bid Adapter
+Module Name: discovery Bid Adapter
 Module Type: Bidder Adapter
 ```
 
 # Description
 
-Module that connects to popIn's demand sources
+Module that connects to popIn's demand sources.
 
-The DiscoveryDSP Bidding adapter requires setup before beginning. Please contact us at <media-support@popin.cc>
+The discovery Bidding adapter requires setup before beginning. Please contact us at <media-support@popin.cc>
 
 # Test Parameters
 ```
@@ -32,7 +32,8 @@ The DiscoveryDSP Bidding adapter requires setup before beginning. Please contact
             bidder: "discovery",
             params: {
               token: "a1b067897e4ae093d1f94261e0ddc6c9",
-              media: 'test_media' // your media host
+              tagid: 'test_tagid',
+              publisher: 'test_publisher'
             },
           },
         ],
@@ -45,13 +46,13 @@ The DiscoveryDSP Bidding adapter requires setup before beginning. Please contact
             sizes: [[300, 250]],
           },
         },
-        // Replace this object to test a new adapter!
         bids: [
           {
             bidder: "discovery",
             params: {
               token: "d0f4902b616cc5c38cbe0a08676d0ed9",
-              media: 'test_media' // your media host
+              tagid: 'test_tagid',
+              publisher: 'test_publisher'
             },
           },
         ],