prebid.js 7.6.0 → 7.7.0

package/modules/1plusXRtdProvider.js

@@ -0,0 +1,251 @@
+import { submodule } from '../src/hook.js';
+import { config } from '../src/config.js';
+import { ajax } from '../src/ajax.js';
+import {
+  logMessage, logError,
+  deepAccess, mergeDeep,
+  isNumber, isArray, deepSetValue
+} from '../src/utils.js';
+
+// Constants
+const REAL_TIME_MODULE = 'realTimeData';
+const MODULE_NAME = '1plusX';
+const ORTB2_NAME = '1plusX.com'
+const PAPI_VERSION = 'v1.0';
+const LOG_PREFIX = '[1plusX RTD Module]: ';
+const LEGACY_SITE_KEYWORDS_BIDDERS = ['appnexus'];
+export const segtaxes = {
+  // cf. https://github.com/InteractiveAdvertisingBureau/openrtb/pull/108
+  AUDIENCE: 526,
+  CONTENT: 527,
+};
+// Functions
+/**
+ * Extracts the parameters for 1plusX RTD module from the config object passed at instanciation
+ * @param {Object} moduleConfig Config object passed to the module
+ * @param {Object} reqBidsConfigObj Config object for the bidders; each adapter has its own entry
+ * @returns {Object} Extracted configuration parameters for the module
+ */
+export const extractConfig = (moduleConfig, reqBidsConfigObj) => {
+  // CustomerId
+  const customerId = deepAccess(moduleConfig, 'params.customerId');
+  if (!customerId) {
+    throw new Error('Missing parameter customerId in moduleConfig');
+  }
+  // Timeout
+  const tempTimeout = deepAccess(moduleConfig, 'params.timeout');
+  const timeout = isNumber(tempTimeout) && tempTimeout > 300 ? tempTimeout : 1000;
+
+  // Bidders
+  const biddersTemp = deepAccess(moduleConfig, 'params.bidders');
+  if (!isArray(biddersTemp) || !biddersTemp.length) {
+    throw new Error('Missing parameter bidders in moduleConfig');
+  }
+
+  const adUnitBidders = reqBidsConfigObj.adUnits
+    .flatMap(({ bids }) => bids.map(({ bidder }) => bidder))
+    .filter((e, i, a) => a.indexOf(e) === i);
+  if (!isArray(adUnitBidders) || !adUnitBidders.length) {
+    throw new Error('Missing parameter bidders in bidRequestConfig');
+  }
+
+  const bidders = biddersTemp.filter(bidder => adUnitBidders.includes(bidder));
+  if (!bidders.length) {
+    throw new Error('No bidRequestConfig bidder found in moduleConfig bidders');
+  }
+
+  return { customerId, timeout, bidders };
+}
+
+/**
+ * Gets the URL of Profile Api from which targeting data will be fetched
+ * @param {Object} config
+ * @param {string} config.customerId
+ * @returns {string} URL to access 1plusX Profile API
+ */
+const getPapiUrl = ({ customerId }) => {
+  // https://[yourClientId].profiles.tagger.opecloud.com/[VERSION]/targeting?url=
+  const currentUrl = encodeURIComponent(window.location.href);
+  const papiUrl = `https://${customerId}.profiles.tagger.opecloud.com/${PAPI_VERSION}/targeting?url=${currentUrl}`;
+  return papiUrl;
+}
+
+/**
+ * Fetches targeting data. It contains the audience segments & the contextual topics
+ * @param {string} papiUrl URL of profile API
+ * @returns {Promise} Promise object resolving with data fetched from Profile API
+ */
+const getTargetingDataFromPapi = (papiUrl) => {
+  return new Promise((resolve, reject) => {
+    const requestOptions = {
+      customHeaders: {
+        'Accept': 'application/json'
+      }
+    }
+    const callbacks = {
+      success(responseText, response) {
+        resolve(JSON.parse(response.response));
+      },
+      error(error) {
+        reject(error);
+      }
+    };
+    ajax(papiUrl, callbacks, null, requestOptions)
+  })
+}
+
+/**
+ * Prepares the update for the ORTB2 object
+ * @param {Object} targetingData Targeting data fetched from Profile API
+ * @param {string[]} segments Represents the audience segments of the user
+ * @param {string[]} topics Represents the topics of the page
+ * @returns {Object} Object describing the updates to make on bidder configs
+ */
+export const buildOrtb2Updates = ({ segments = [], topics = [] }, bidder) => {
+  // Currently appnexus bidAdapter doesn't support topics in `site.content.data.segment`
+  // Therefore, writing them in `site.keywords` until it's supported
+  // Other bidAdapters do fine with `site.content.data.segment`
+  const writeToLegacySiteKeywords = LEGACY_SITE_KEYWORDS_BIDDERS.includes(bidder);
+  if (writeToLegacySiteKeywords) {
+    const site = {
+      keywords: topics.join(',')
+    };
+    return { site };
+  }
+
+  const userData = {
+    name: ORTB2_NAME,
+    segment: segments.map((segmentId) => ({ id: segmentId }))
+  };
+  const siteContentData = {
+    name: ORTB2_NAME,
+    segment: topics.map((topicId) => ({ id: topicId })),
+    ext: { segtax: segtaxes.CONTENT }
+  }
+  return { userData, siteContentData };
+}
+
+/**
+ * Merges the targeting data with the existing config for bidder and updates
+ * @param {string} bidder Bidder for which to set config
+ * @param {Object} ortb2Updates Updates to be applied to bidder config
+ * @param {Object} bidderConfigs All current bidder configs
+ * @returns {Object} Updated bidder config
+ */
+export const updateBidderConfig = (bidder, ortb2Updates, bidderConfigs) => {
+  const { site, siteContentData, userData } = ortb2Updates;
+  const bidderConfigCopy = mergeDeep({}, bidderConfigs[bidder]);
+
+  if (site) {
+    // Legacy : cf. comment on buildOrtb2Updates first lines
+    const currentSite = deepAccess(bidderConfigCopy, 'ortb2.site')
+    const updatedSite = mergeDeep(currentSite, site);
+    deepSetValue(bidderConfigCopy, 'ortb2.site', updatedSite);
+  }
+
+  if (siteContentData) {
+    const siteDataPath = 'ortb2.site.content.data';
+    const currentSiteContentData = deepAccess(bidderConfigCopy, siteDataPath) || [];
+    const updatedSiteContentData = [
+      ...currentSiteContentData.filter(({ name }) => name != siteContentData.name),
+      siteContentData
+    ];
+    deepSetValue(bidderConfigCopy, siteDataPath, updatedSiteContentData);
+  }
+
+  if (userData) {
+    const userDataPath = 'ortb2.user.data';
+    const currentUserData = deepAccess(bidderConfigCopy, userDataPath) || [];
+    const updatedUserData = [
+      ...currentUserData.filter(({ name }) => name != userData.name),
+      userData
+    ];
+    deepSetValue(bidderConfigCopy, userDataPath, updatedUserData);
+  }
+
+  return bidderConfigCopy;
+};
+
+const setAppnexusAudiences = (audiences) => {
+  config.setConfig({
+    appnexusAuctionKeywords: {
+      '1plusX': audiences,
+    },
+  });
+}
+
+/**
+ * Updates bidder configs with the targeting data retreived from Profile API
+ * @param {Object} papiResponse Response from Profile API
+ * @param {Object} config Module configuration
+ * @param {string[]} config.bidders Bidders specified in module's configuration
+ */
+export const setTargetingDataToConfig = (papiResponse, { bidders }) => {
+  const bidderConfigs = config.getBidderConfig();
+  const { s: segments, t: topics } = papiResponse;
+
+  for (const bidder of bidders) {
+    const ortb2Updates = buildOrtb2Updates({ segments, topics }, bidder);
+    const updatedBidderConfig = updateBidderConfig(bidder, ortb2Updates, bidderConfigs);
+    if (updatedBidderConfig) {
+      config.setBidderConfig({
+        bidders: [bidder],
+        config: updatedBidderConfig
+      });
+    }
+    if (bidder === 'appnexus') {
+      // Do the legacy stuff for appnexus with segments
+      setAppnexusAudiences(segments);
+    }
+  }
+}
+
+// Functions exported in submodule object
+/**
+ * Init
+ * @param {Object} config Module configuration
+ * @param {boolean} userConsent
+ * @returns true
+ */
+const init = (config, userConsent) => {
+  return true;
+}
+
+/**
+ *
+ * @param {Object} reqBidsConfigObj Bid request configuration object
+ * @param {Function} callback Called on completion
+ * @param {Object} moduleConfig Configuration for 1plusX RTD module
+ * @param {boolean} userConsent
+ */
+const getBidRequestData = (reqBidsConfigObj, callback, moduleConfig, userConsent) => {
+  try {
+    // Get the required config
+    const { customerId, bidders } = extractConfig(moduleConfig, reqBidsConfigObj);
+    // Get PAPI URL
+    const papiUrl = getPapiUrl({ customerId })
+    // Call PAPI
+    getTargetingDataFromPapi(papiUrl)
+      .then((papiResponse) => {
+        logMessage(LOG_PREFIX, 'Get targeting data request successful');
+        setTargetingDataToConfig(papiResponse, { bidders });
+        callback();
+      })
+      .catch((error) => {
+        throw error;
+      })
+  } catch (error) {
+    logError(LOG_PREFIX, error);
+    callback();
+  }
+}
+
+// The RTD submodule object to be exported
+export const onePlusXSubmodule = {
+  name: MODULE_NAME,
+  init,
+  getBidRequestData
+}
+
+// Register the onePlusXSubmodule as submodule of realTimeData
+submodule(REAL_TIME_MODULE, onePlusXSubmodule);

package/modules/1plusXRtdProvider.md

@@ -0,0 +1,65 @@
+# 1plusX Real-time Data Submodule
+
+## Overview
+
+    Module Name: 1plusX Rtd Provider
+    Module Type: Rtd Provider
+    Maintainer: dc-team-1px@triplelift.com
+
+## Description
+
+The 1plusX RTD module appends User and Contextual segments to the bidding object.
+
+## Usage
+
+### Build
+```
+gulp build --modules="rtdModule,1plusXRtdProvider,appnexusBidAdapter,..."  
+```
+
+> Note that the global RTD module, `rtdModule`, is a prerequisite of the 1plusX RTD module.
+
+### Configuration
+
+Use `setConfig` to instruct Prebid.js to initilize the 1plusX RTD module, as specified below. 
+
+This module is configured as part of the `realTimeData.dataProviders`
+
+```javascript
+var TIMEOUT = 1000;
+pbjs.setConfig({
+    realTimeData: {
+        auctionDelay: TIMEOUT,
+        dataProviders: [{
+            name: '1plusX',
+            waitForIt: true,
+            params: {
+                customerId: 'acme',
+                bidders: ['appnexus', 'rubicon'],
+                timeout: TIMEOUT
+            }
+        }]
+    }
+});
+```
+
+### Parameters 
+
+| Name              | Type          | Description                                                      | Default           |
+| :---------------- | :------------ | :--------------------------------------------------------------- |:----------------- |
+| name              | String        | Real time data module name                                       | Always '1plusX'   |
+| waitForIt         | Boolean       | Should be `true` if there's an `auctionDelay` defined (optional) | `false`           |
+| params            | Object        |                                                                  |                   |
+| params.customerId | String        | Your 1plusX customer id                                          |                   |
+| params.bidders    | Array<string> | List of bidders for which you would like data to be set          |                   |
+| params.timeout    | Integer       | timeout (ms)                                                     | 1000ms            |
+
+## Testing 
+
+To view an example of how the 1plusX RTD module works :
+
+`gulp serve --modules=rtdModule,1plusXRtdProvider,appnexusBidAdapter,rubiconBidAdapter`
+
+and then point your browser at:
+
+`http://localhost:9999/integrationExamples/gpt/1plusXRtdProvider_example.html`

package/modules/adoceanBidAdapter.js

@@ -2,11 +2,15 @@ import { _each, parseSizesInput, isStr, isArray } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 
 const BIDDER_CODE = 'adocean';
+const URL_SAFE_FIELDS = {
+  schain: true,
+  slaves: true
+};
 
 function buildEndpointUrl(emiter, payloadMap) {
   const payload = [];
   _each(payloadMap, function(v, k) {
-    payload.push(k + '=' + (k === 'schain' ? v : encodeURIComponent(v)));
+    payload.push(k + '=' + (URL_SAFE_FIELDS[k] ? v : encodeURIComponent(v)));
   });
 
   const randomizedPart = Math.random().toString().slice(2);
@@ -17,7 +21,8 @@ function buildRequest(masterBidRequests, masterId, gdprConsent) {
   let emiter;
   const payload = {
     id: masterId,
-    aosspsizes: []
+    aosspsizes: [],
+    slaves: []
   };
   if (gdprConsent) {
     payload.gdpr_consent = gdprConsent.consentString || undefined;
@@ -29,7 +34,7 @@ function buildRequest(masterBidRequests, masterId, gdprConsent) {
   }
 
   const bidIdMap = {};
-
+  const uniquePartLength = 10;
   _each(masterBidRequests, function(bid, slaveId) {
     if (!emiter) {
       emiter = bid.params.emiter;
@@ -38,11 +43,13 @@ function buildRequest(masterBidRequests, masterId, gdprConsent) {
     const slaveSizes = parseSizesInput(bid.mediaTypes.banner.sizes).join('_');
     const rawSlaveId = bid.params.slaveId.replace('adocean', '');
     payload.aosspsizes.push(rawSlaveId + '~' + slaveSizes);
+    payload.slaves.push(rawSlaveId.slice(-uniquePartLength));
 
     bidIdMap[slaveId] = bid.bidId;
   });
 
   payload.aosspsizes = payload.aosspsizes.join('-');
+  payload.slaves = payload.slaves.join(',');
 
   return {
     method: 'GET',

package/modules/big-richmediaBidAdapter.js

@@ -8,7 +8,7 @@ const BIDDER_CODE = 'big-richmedia';
 const metadataByRequestId = {};
 
 export const spec = {
-  version: '1.5.0',
+  version: '1.5.1',
   code: BIDDER_CODE,
   gvlid: baseAdapter.GVLID, // use base adapter gvlid
   supportedMediaTypes: [ BANNER, VIDEO ],
@@ -82,8 +82,8 @@ export const spec = {
       // This is a workaround needed for the rendering step (so that the adserver iframe does not get resized to 1800x1000
       // when there is skin demand
       if (format === 'skin') {
-        renderParams.width = 1
-        renderParams.height = 1
+        bid.width = 1
+        bid.height = 1
       }
 
       const encoded = window.btoa(JSON.stringify(renderParams));