prebid.js 7.10.0 → 7.13.0

package/modules/mediagoBidAdapter.js

@@ -0,0 +1,462 @@
+/**
+ * gulp serve --modules=mediagoBidAdapter,pubCommonId --nolint   --notest
+ */
+
+import * as utils from '../src/utils.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+// import { config } from '../src/config.js';
+// import { isPubcidEnabled } from './pubCommonId.js';
+
+const BIDDER_CODE = 'mediago';
+// const PROTOCOL = window.document.location.protocol;
+const ENDPOINT_URL =
+  // ((PROTOCOL === 'https:') ? 'https' : 'http') +
+  'https://rtb-us.mediago.io/api/bid?tn=';
+const TIME_TO_LIVE = 500;
+// const ENDPOINT_URL = '/api/bid?tn=';
+const storage = getStorageManager();
+let globals = {};
+let itemMaps = {};
+
+/**
+ * 获取随机id
+ * @param  {number} a random number from 0 to 15
+ * @return {string}   random number or random string
+ */
+// function getRandomId(
+//   a // placeholder
+// ) {
+//   // if the placeholder was passed, return
+//   // a random number from 0 to 15
+//   return a
+//     ? (
+//       a ^ // unless b is 8,
+//         ((Math.random() * // in which case
+//           16) >> // a random number from
+//           (a / 4))
+//     ) // 8 to 11
+//       .toString(16) // in hexadecimal
+//     : ( // or otherwise a concatenated string:
+//       [1e7] + // 10000000 +
+//         1e3 + // -1000 +
+//         4e3 + // -4000 +
+//         8e3 + // -80000000 +
+//         1e11
+//     ) // -100000000000,
+//       .replace(
+//         // replacing
+//         /[018]/g, // zeroes, ones, and eights with
+//         getRandomId // random hex digits
+//       );
+// }
+
+/* ----- mguid:start ------ */
+const COOKIE_KEY_MGUID = '__mguid_';
+
+/**
+ * 获取用户id
+ * @return {string}
+ */
+const getUserID = () => {
+  const i = storage.getCookie(COOKIE_KEY_MGUID);
+
+  if (i === null) {
+    const uuid = utils.generateUUID();
+    storage.setCookie(COOKIE_KEY_MGUID, uuid);
+    return uuid;
+  }
+  return i;
+};
+
+/* ----- mguid:end ------ */
+
+/**
+ * 获取一个对象的某个值，如果没有则返回空字符串
+ * @param  {Object}    obj  对象
+ * @param  {...string} keys 键名
+ * @return {any}
+ */
+function getProperty(obj, ...keys) {
+  let o = obj;
+
+  for (let key of keys) {
+    // console.log(key, o);
+    if (o && o[key]) {
+      o = o[key];
+    } else {
+      return '';
+    }
+  }
+  return o;
+}
+
+/**
+ * 是不是移动设备或者平板
+ * @return {boolean}
+ */
+function isMobileAndTablet() {
+  let check = false;
+  (function (a) {
+    let reg1 = new RegExp(
+      [
+        '(android|bbd+|meego)',
+        '.+mobile|avantgo|bada/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)',
+        '|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone',
+        '|p(ixi|re)/|plucker|pocket|psp|series(4|6)0|symbian|treo|up.(browser|link)|vodafone|wap',
+        '|windows ce|xda|xiino|android|ipad|playbook|silk',
+      ].join(''),
+      'i'
+    );
+    let reg2 = new RegExp(
+      [
+        '1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)',
+        '|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )',
+        '|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55/|capi|ccwa|cdm-|cell',
+        '|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)',
+        '|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene',
+        '|gf-5|g-mo|go(.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c',
+        '|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|/)|ibro|idea|ig01|ikom',
+        '|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |/)|klon|kpt |kwc-|kyo(c|k)',
+        '|le(no|xi)|lg( g|/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50/|ma(te|ui|xo)|mc(01|21|ca)',
+        '|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]',
+        '|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)',
+        '|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio',
+        '|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55/|sa(ge|ma|mm|ms',
+        '|ny|va)|sc(01|h-|oo|p-)|sdk/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al',
+        '|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)',
+        '|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(.b|g1|si)|utst|',
+        'v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)',
+        '|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-',
+        '|your|zeto|zte-',
+      ].join(''),
+      'i'
+    );
+    if (reg1.test(a) || reg2.test(a.substr(0, 4))) {
+      check = true;
+    }
+  })(navigator.userAgent || navigator.vendor || window.opera);
+  return check;
+}
+
+/**
+ * 获取底价
+ * @param {*} bid
+ * @param {*} mediaType
+ * @param {*} sizes
+ * @returns
+ */
+// function getBidFloor(bid, mediaType, sizes) {
+//   var floor;
+//   var size = sizes.length === 1 ? sizes[0] : "*";
+//   if (typeof bid.getFloor === "function") {
+//     const floorInfo = bid.getFloor({ currency: "USD", mediaType, size });
+//     if (
+//       typeof floorInfo === "object" &&
+//       floorInfo.currency === "USD" &&
+//       !isNaN(parseFloat(floorInfo.floor))
+//     ) {
+//       floor = parseFloat(floorInfo.floor);
+//     }
+//   }
+//   return floor;
+// }
+function getBidFloor(bid) {
+  if (!utils.isFn(bid.getFloor)) {
+    return utils.deepAccess(bid, 'params.bidfloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (_) {
+    return 0;
+  }
+}
+
+/**
+ * 将尺寸转为RTB识别的尺寸
+ *
+ * @param  {Array|Object} requestSizes 配置尺寸
+ * @return {Object}
+ */
+function transformSizes(requestSizes) {
+  let sizes = [];
+  let sizeObj = {};
+
+  if (
+    utils.isArray(requestSizes) &&
+    requestSizes.length === 2 &&
+    !utils.isArray(requestSizes[0])
+  ) {
+    sizeObj.width = parseInt(requestSizes[0], 10);
+    sizeObj.height = parseInt(requestSizes[1], 10);
+    sizes.push(sizeObj);
+  } else if (typeof requestSizes === 'object') {
+    for (let i = 0; i < requestSizes.length; i++) {
+      let size = requestSizes[i];
+      sizeObj = {};
+      sizeObj.width = parseInt(size[0], 10);
+      sizeObj.height = parseInt(size[1], 10);
+      sizes.push(sizeObj);
+    }
+  }
+
+  return sizes;
+}
+
+// 支持的广告尺寸
+const mediagoAdSize = [
+  { w: 300, h: 250 },
+  { w: 300, h: 600 },
+  { w: 728, h: 90 },
+  { w: 970, h: 250 },
+  { w: 320, h: 50 },
+  { w: 160, h: 600 },
+  { w: 320, h: 180 },
+  { w: 320, h: 100 },
+  { w: 336, h: 280 },
+];
+
+/**
+ * 获取广告位配置
+ * @param {Array}  validBidRequests an an array of bids
+ * @param {Object} bidderRequest  The master bidRequest object
+ * @return {Object}
+ */
+function getItems(validBidRequests, bidderRequest) {
+  let items = [];
+  items = validBidRequests.map((req, i) => {
+    let ret = {};
+    let mediaTypes = getProperty(req, 'mediaTypes');
+
+    let sizes = transformSizes(getProperty(req, 'sizes'));
+    let matchSize;
+
+    // 确认尺寸是否符合我们要求
+    for (let size of sizes) {
+      matchSize = mediagoAdSize.find(
+        (item) => size.width === item.w && size.height === item.h
+      );
+      if (matchSize) {
+        break;
+      }
+    }
+    if (!matchSize) {
+      return {};
+    }
+
+    const bidFloor = getBidFloor(req);
+    // const gpid =
+    //   utils.deepAccess(req, 'ortb2Imp.ext.gpid') ||
+    //   utils.deepAccess(req, 'ortb2Imp.ext.data.pbadslot') ||
+    //   utils.deepAccess(req, 'params.placementId', 0);
+    // console.log("wjh getItems:", req, bidFloor, gpid);
+
+    // if (mediaTypes.native) {}
+    // banner广告类型
+    if (mediaTypes.banner) {
+      let id = '' + (i + 1);
+      ret = {
+        id: id,
+        bidfloor: bidFloor,
+        banner: {
+          h: matchSize.h,
+          w: matchSize.w,
+          pos: 1,
+        },
+        ext: {
+        //   gpid: gpid, // 加入后无法返回广告
+        },
+      };
+      itemMaps[id] = {
+        req,
+        ret,
+      };
+    }
+
+    return ret;
+  });
+  return items;
+}
+
+/**
+ * 获取rtb请求参数
+ *
+ * @param {Array}  validBidRequests an an array of bids
+ * @param {Object} bidderRequest  The master bidRequest object
+ * @return {Object}
+ */
+function getParam(validBidRequests, bidderRequest) {
+  const pubcid = utils.deepAccess(validBidRequests[0], 'crumbs.pubcid');
+  // console.log('wjh getParam', validBidRequests, bidderRequest);
+  let isMobile = isMobileAndTablet() ? 1 : 0;
+  let isTest = 0;
+  let auctionId = getProperty(bidderRequest, 'auctionId');
+  let items = getItems(validBidRequests, bidderRequest);
+
+  const domain = document.domain;
+  const location = utils.deepAccess(bidderRequest, 'refererInfo.referer');
+
+  const timeout = bidderRequest.timeout || 2000;
+
+  if (items && items.length) {
+    let c = {
+      id: 'mgprebidjs_' + auctionId,
+      test: +isTest,
+      at: 1,
+      cur: ['USD'],
+      device: {
+        connectiontype: 0,
+        // ip: '64.188.178.115',
+        js: 1,
+        // language: "en",
+        // os: "Microsoft Windows",
+        // ua: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.102 Safari/537.36 Edge/18.19043",
+        os: navigator.platform || '',
+        ua: navigator.userAgent,
+        language: /en/.test(navigator.language) ? 'en' : navigator.language,
+      },
+      ext: {},
+      user: {
+        buyeruid: getUserID(),
+        id: pubcid,
+      },
+      site: {
+        name: domain,
+        domain: domain,
+        page: location,
+        ref: location,
+        mobile: isMobile,
+        cat: [], // todo
+        publisher: {
+          // todo
+          id: domain,
+          name: domain,
+        },
+      },
+      imp: items,
+      tmax: timeout,
+    };
+    return c;
+  } else {
+    return null;
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  // aliases: ['ex'], // short code
+  /**
+   * 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.
+   */
+  isBidRequestValid: function (bid) {
+    // console.log('mediago', {
+    //   bid
+    // });
+    if (bid.params.token) {
+      globals['token'] = bid.params.token;
+    }
+    return !!bid.params.token;
+  },
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {Array}  validBidRequests an an array of bids
+   * @param {Object} bidderRequest  The master bidRequest object
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function (validBidRequests, bidderRequest) {
+    let payload = getParam(validBidRequests, bidderRequest);
+
+    const payloadString = JSON.stringify(payload);
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL + globals['token'],
+      data: payloadString,
+    };
+  },
+
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {ServerResponse} serverResponse A successful response from the server.
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function (serverResponse, bidRequest) {
+    const bids = getProperty(serverResponse, 'body', 'seatbid', 0, 'bid');
+    const cur = getProperty(serverResponse, 'body', 'cur');
+
+    const bidResponses = [];
+    for (let bid of bids) {
+      let impid = getProperty(bid, 'impid');
+      if (itemMaps[impid]) {
+        let bidId = getProperty(itemMaps[impid], 'req', 'bidId');
+        const bidResponse = {
+          requestId: bidId,
+          cpm: getProperty(bid, 'price'),
+          width: getProperty(bid, 'w'),
+          height: getProperty(bid, 'h'),
+          creativeId: getProperty(bid, 'crid'),
+          dealId: '',
+          currency: cur,
+          netRevenue: true,
+          ttl: TIME_TO_LIVE,
+          // referrer: REFERER,
+          ad: getProperty(bid, 'adm'),
+          nurl: getProperty(bid, 'nurl'),
+          //   adserverTargeting: {
+          //     granularityMultiplier: 0.1,
+          //     priceGranularity: "pbHg",
+          //     pbMg: "0.01",
+          //   },
+          //   pbMg: "0.01",
+          //   granularityMultiplier: 0.1,
+          //   priceGranularity: "pbHg",
+        };
+        bidResponses.push(bidResponse);
+      }
+    }
+
+    return bidResponses;
+  },
+
+  /**
+   * Register bidder specific code, which will execute if bidder timed out after an auction
+   * @param {data} Containing timeout specific data
+   */
+  //   onTimeout: function (data) {
+  //     // console.log('onTimeout', data);
+  //     // Bidder specifc code
+  //   },
+
+  /**
+   * Register bidder specific code, which will execute if a bid from this bidder won the auction
+   * @param {Bid} The bid that won the auction
+   */
+  onBidWon: function (bid) {
+    // console.log('onBidWon： ', bid, config.getConfig('priceGranularity'));
+    // Bidder specific code
+    if (bid['nurl']) {
+      utils.triggerPixel(bid['nurl']);
+    }
+  },
+
+  /**
+   * Register bidder specific code, which will execute when the adserver targeting has been set for a bid from this bidder
+   * @param {Bid} The bid of which the targeting has been set
+   */
+//   onSetTargeting: function (bid) {
+//     // console.log('onSetTargeting', bid);
+//     // Bidder specific code
+//   },
+};
+registerBidder(spec);

package/modules/mediagoBidAdapter.md

@@ -0,0 +1,34 @@
+# Overview
+
+```
+Module Name: MediaGo Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: fangsimin@baidu.com
+```
+
+# Description
+
+Module that connects to MediaGo's demand sources
+
+# Test Parameters
+
+```
+    var adUnits = [
+        {
+            code: 'test-div',
+            mediaTypes: {
+                banner: {
+                    sizes: [[300, 250]],
+                }
+            },
+            bids: [
+                {
+                    bidder: "mediago",
+                    params: {
+                        token: ''  // required, send email to ext_mediago_am@baidu.com to get the corresponding token
+                    }
+                }
+            ]
+        }
+    ];
+```

package/modules/mediakeysBidAdapter.js

@@ -420,7 +420,7 @@ function createVideoImp(bid) {
     }
   });
 
-  return video
+  return video;
 }
 
 /**
@@ -703,7 +703,7 @@ export const spec = {
               agencyName: deepAccess(bid, 'ext.agency_name', null),
               primaryCatId: getPrimaryCatFromResponse(bid.cat),
               mediaType
-            }
+            };
 
             const newBid = {
               requestId: bid.impid,

package/modules/mgidBidAdapter.js

@@ -88,7 +88,7 @@ export const spec = {
           let v = nativeParams[k];
           const supportProp = spec.NATIVE_ASSET_KEY_TO_ASSET_MAP.hasOwnProperty(k);
           if (supportProp) {
-            assetsCount++
+            assetsCount++;
           }
           if (!isPlainObject(v) || (!supportProp && deepAccess(v, 'required'))) {
             nativeOk = false;
@@ -152,7 +152,7 @@ export const spec = {
         impObj.bidfloor = floorData.floor;
       }
       if (floorData.cur) {
-        impObj.bidfloorcur = floorData.cur
+        impObj.bidfloorcur = floorData.cur;
       }
       for (let mediaTypes in bid.mediaTypes) {
         switch (mediaTypes) {

package/modules/nextMillenniumBidAdapter.js

@@ -26,11 +26,12 @@ export const spec = {
     _each(validBidRequests, function(bid) {
       window.nmmRefreshCounts[bid.adUnitCode] = window.nmmRefreshCounts[bid.adUnitCode] || 0;
       const id = getPlacementId(bid)
+      let sizes = bid.sizes
+      if (sizes && !Array.isArray(sizes[0])) sizes = [sizes]
+
+      const site = getSiteObj()
+      const device = getDeviceObj()
 
-      if (bid.sizes && !Array.isArray(bid.sizes[0])) bid.sizes = [bid.sizes]
-      if (!bid.ortb2) bid.ortb2 = {}
-      if (!bid.ortb2.device) bid.ortb2.device = {}
-      bid.ortb2.device.referrer = (getRefererInfo && getRefererInfo().ref) || ''
       const postBody = {
         'id': bid.auctionId,
         'ext': {
@@ -46,10 +47,11 @@ export const spec = {
             'scrollTop': window.pageYOffset || document.documentElement.scrollTop
           }
         },
-        ...bid.ortb2,
+        device,
+        site,
         'imp': [{
           'banner': {
-            'format': (bid.sizes || []).map(s => { return {w: s[0], h: s[1]} })
+            'format': (sizes || []).map(s => { return {w: s[0], h: s[1]} })
           },
           'ext': {
             'prebid': {
@@ -198,4 +200,21 @@ function getTopWindow(curWindow, nesting = 0) {
   }
 }
 
+function getSiteObj() {
+  const refInfo = (getRefererInfo && getRefererInfo()) || {}
+
+  return {
+    page: refInfo.page,
+    ref: refInfo.ref,
+    domain: refInfo.domain
+  }
+}
+
+function getDeviceObj() {
+  return {
+    w: window.innerWidth || window.document.documentElement.clientWidth || window.document.body.clientWidth || 0,
+    h: window.innerHeight || window.document.documentElement.clientHeight || window.document.body.clientHeight || 0,
+  }
+}
+
 registerBidder(spec);

package/modules/nobidBidAdapter.js

@@ -147,7 +147,7 @@ function nobidBuildRequests(bids, bidderRequest) {
     if (eids && eids.length > 0) state['eids'] = eids;
     if (bidderRequest && bidderRequest.ortb2) state['ortb2'] = bidderRequest.ortb2;
     return state;
-  }
+  };
   function newAdunit(adunitObject, adunits) {
     var getAdUnit = function(divid, adunits) {
       for (var i = 0; i < adunits.length; i++) {
@@ -438,7 +438,7 @@ export const spec = {
             type: 'image',
             url: element
           });
-        })
+        });
       }
       return syncs;
     } else {

package/modules/novatiqIdSystem.js

@@ -245,7 +245,7 @@ export const novatiqIdSubmodule = {
     } else {
       srcId = configParams.sourceid;
     }
-    return srcId
+    return srcId;
   }
 };
 submodule('userId', novatiqIdSubmodule);

package/modules/oneKeyIdSystem.js

@@ -0,0 +1,78 @@
+/**
+ * This module adds Onekey data to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/oneKeyIdSystem
+ * @requires module:modules/userId
+ */
+
+import {submodule} from '../src/hook.js';
+import { logError, logMessage } from '../src/utils.js';
+
+// Pre-init OneKey if it has not load yet.
+window.OneKey = window.OneKey || {};
+window.OneKey.queue = window.OneKey.queue || [];
+
+const logPrefix = 'OneKey.Id-Module';
+
+/**
+ * Generate callback that deserializes the result of getIdsAndPreferences.
+ */
+const onIdsAndPreferencesResult = (callback) => {
+  return (result) => {
+    logMessage(logPrefix, `Has got Ids and Prefs with status: `, result);
+    callback(result.data);
+  };
+};
+
+/**
+ * Call OneKey once it is loaded for retrieving
+ * the ids and the preferences.
+ */
+const getIdsAndPreferences = (callback) => {
+  logMessage(logPrefix, 'Queue getIdsAndPreferences call');
+  // Call OneKey in a queue so that we are sure
+  // it will be called when fully load and configured
+  // within the page.
+  window.OneKey.queue.push(() => {
+    logMessage(logPrefix, 'Get Ids and Prefs');
+    window.OneKey.getIdsAndPreferences()
+      .then(onIdsAndPreferencesResult(callback))
+      .catch(() => {
+        logError(logPrefix, 'Cannot retrieve the ids and preferences from OneKey.');
+        callback(undefined);
+      });
+  });
+};
+
+/** @type {Submodule} */
+export const oneKeyIdSubmodule = {
+  /**
+    * used to link submodule with config
+    * @type {string}
+    */
+  name: 'oneKeyData',
+  /**
+    * decode the stored data value for passing to bid requests
+    * @function decode
+    * @param {(Object|string)} value
+    * @returns {(Object|undefined)}
+    */
+  decode(data) {
+    return { oneKeyData: data };
+  },
+  /**
+    * performs action to obtain id and return a value in the callback's response argument
+    * @function
+    * @param {SubmoduleConfig} [config]
+    * @param {ConsentData} [consentData]
+    * @param {(Object|undefined)} cacheIdObj
+    * @returns {IdResponse|undefined}
+    */
+  getId(config) {
+    return {
+      callback: getIdsAndPreferences
+    };
+  }
+};
+
+submodule('userId', oneKeyIdSubmodule);