prebid.js 8.7.0 → 8.9.0

package/modules/growthCodeAnalyticsAdapter.js

@@ -13,7 +13,7 @@ import {MODULE_TYPE_ANALYTICS} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'growthCodeAnalytics';
 const DEFAULT_PID = 'INVALID_PID'
-const ENDPOINT_URL = 'https://p2.gcprivacy.com/v1/pb/analytics'
+const ENDPOINT_URL = 'https://p2.gcprivacy.com/v3/pb/analytics'
 
 export const storage = getStorageManager({moduleType: MODULE_TYPE_ANALYTICS, moduleName: MODULE_NAME});
 
@@ -138,12 +138,15 @@ growthCodeAnalyticsAdapter.enableAnalytics = function(conf = {}) {
 
 function logToServer() {
   if (pid === DEFAULT_PID) return;
-  if (eventQueue.length > 1) {
+  if (eventQueue.length >= 1) {
+    // Get the correct GCID
+    let gcid = localStorage.getItem('gcid')
+
     let data = {
       session: sessionId,
       pid: pid,
+      gcid: gcid,
       timestamp: Date.now(),
-      timezoneoffset: new Date().getTimezoneOffset(),
       url: getRefererInfo().page,
       referer: document.referrer,
       events: eventQueue
@@ -167,7 +170,7 @@ function sendEvent(event) {
   eventQueue.push(event);
   logInfo(MODULE_NAME + 'Analytics Event: ' + event);
 
-  if (event.eventType === CONSTANTS.EVENTS.AUCTION_END) {
+  if ((event.eventType === CONSTANTS.EVENTS.AUCTION_END) || (event.eventType === CONSTANTS.EVENTS.BID_WON)) {
     logToServer();
   }
 }

package/modules/growthCodeAnalyticsAdapter.md

@@ -21,13 +21,7 @@ pbjs.enableAnalytics({
     pid: '<Contact GrowthCode>',
     trackEvents: [
       'auctionEnd',
-      'bidAdjustment',
-      'bidTimeout',
-      'bidRequested',
-      'bidResponse',
-      'noBid',
-      'bidWon',
-      'bidderDone']
+      'bidWon']
   }
 });
 ```

package/modules/liveIntentIdSystem.js

@@ -205,6 +205,10 @@ export const liveIntentIdSubmodule = {
         result.magnite = { 'id': value.magnite, ext: { provider: LI_PROVIDER_DOMAIN } }
       }
 
+      if (value.index) {
+        result.index = { 'id': value.index, ext: { provider: LI_PROVIDER_DOMAIN } }
+      }
+
       return result
     }
 
@@ -294,7 +298,18 @@ export const liveIntentIdSubmodule = {
         }
       }
     },
-
+    'index': {
+      source: 'liveintent.indexexchange.com',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    }
   }
 };
 

package/modules/nativoBidAdapter.js

@@ -2,7 +2,20 @@ import { deepAccess, isEmpty } from '../src/utils.js'
 import { registerBidder } from '../src/adapters/bidderFactory.js'
 import { BANNER } from '../src/mediaTypes.js'
 import { getGlobal } from '../src/prebidGlobal.js'
-// import { config } from 'src/config'
+import { ortbConverter } from '../libraries/ortbConverter/converter.js'
+
+const converter = ortbConverter({
+  context: {
+    // `netRevenue` and `ttl` are required properties of bid responses - provide a default for them
+    netRevenue: true, // or false if your adapter should set bidResponse.netRevenue = false
+    ttl: 30 // default bidResponse.ttl (when not specified in ORTB response.seatbid[].bid[].exp)
+  },
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    imp.tagid = bidRequest.adUnitCode
+    return imp;
+  }
+});
 
 const BIDDER_CODE = 'nativo'
 const BIDDER_ENDPOINT = 'https://exchange.postrelease.com/prebid'
@@ -136,6 +149,10 @@ export const spec = {
    * @return ServerRequest Info describing the request to the server.
    */
   buildRequests: function (validBidRequests, bidderRequest) {
+    // Get OpenRTB Data
+    const openRTBData = converter.toORTB({bidRequests: validBidRequests, bidderRequest})
+    const openRTBDataString = JSON.stringify(openRTBData)
+
     const requestData = new RequestData()
     requestData.addBidRequestDataSource(new UserEIDs())
 
@@ -271,8 +288,9 @@ export const spec = {
     const requestUrl = buildRequestUrl(BIDDER_ENDPOINT, qsParamStrings)
 
     let serverRequest = {
-      method: 'GET',
-      url: requestUrl
+      method: 'POST',
+      url: requestUrl,
+      data: openRTBDataString,
     }
 
     return serverRequest

package/modules/nexx360BidAdapter.js

@@ -192,7 +192,13 @@ function interpretResponse(serverResponse) {
       };
       if (allowAlternateBidderCodes) response.bidderCode = `n360-${bid.ext.ssp}`;
 
-      if (bid.ext.mediaType === BANNER) response.adUrl = bid.ext.adUrl;
+      if (bid.ext.mediaType === BANNER) {
+        if (bid.adm) {
+          response.ad = bid.adm;
+        } else {
+          response.adUrl = bid.ext.adUrl;
+        }
+      }
       if ([INSTREAM, OUTSTREAM].includes(bid.ext.mediaType)) response.vastXml = bid.ext.vastXml;
 
       if (bid.ext.mediaType === OUTSTREAM) {

package/modules/onetagBidAdapter.js

@@ -70,6 +70,9 @@ function buildRequests(validBidRequests, bidderRequest) {
   if (bidderRequest && bidderRequest.uspConsent) {
     payload.usPrivacy = bidderRequest.uspConsent;
   }
+  if (bidderRequest && bidderRequest.ortb2) {
+    payload.ortb2 = bidderRequest.ortb2;
+  }
   if (validBidRequests && validBidRequests.length !== 0 && validBidRequests[0].userIdAsEids) {
     payload.userId = validBidRequests[0].userIdAsEids;
   }

package/modules/operaadsBidAdapter.js

@@ -680,6 +680,11 @@ function mapNativeImage(image, type) {
  * @returns {String} userId
  */
 function getUserId(bidRequest) {
+  let operaId = deepAccess(bidRequest, 'userId.operaId');
+  if (operaId) {
+    return operaId;
+  }
+
   let sharedId = deepAccess(bidRequest, 'userId.sharedid.id');
   if (sharedId) {
     return sharedId;

package/modules/operaadsBidAdapter.md

@@ -135,18 +135,18 @@ var adUnits = [{
 
 ### User Ids
 
-Opera Ads Bid Adapter uses `sharedId`, `pubcid` or `tdid`, please config at least one.
+Opera Ads Bid Adapter uses `operaId`, please refer to [`Opera ID System`](./operaadsIdSystem.md).
 
 ```javascript
 pbjs.setConfig({
   ...,
   userSync: {
     userIds: [{
-      name: 'sharedId',
+      name: 'operaId',
       storage: {
-        name: '_sharedID', // name of the 1st party cookie
-        type: 'cookie',
-        expires: 30
+        name: 'operaId',
+        type: 'html5',
+        expires: 14
       }
     }]
   }

package/modules/operaadsIdSystem.js

@@ -0,0 +1,106 @@
+/**
+ * This module adds operaId to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/operaadsIdSystem
+ * @requires module:modules/userId
+ */
+import * as ajax from '../src/ajax.js';
+import { submodule } from '../src/hook.js';
+import { logMessage, logError } from '../src/utils.js';
+
+const MODULE_NAME = 'operaId';
+const ID_KEY = MODULE_NAME;
+const version = '1.0';
+const SYNC_URL = 'https://t.adx.opera.com/identity/';
+const AJAX_TIMEOUT = 300;
+const AJAX_OPTIONS = {method: 'GET', withCredentials: true, contentType: 'application/json'};
+
+function constructUrl(pairs) {
+  const queries = [];
+  for (let key in pairs) {
+    queries.push(`${key}=${encodeURIComponent(pairs[key])}`);
+  }
+  return `${SYNC_URL}?${queries.join('&')}`;
+}
+
+function asyncRequest(url, cb) {
+  ajax.ajaxBuilder(AJAX_TIMEOUT)(
+    url,
+    {
+      success: response => {
+        try {
+          const jsonResponse = JSON.parse(response);
+          const { uid: operaId } = jsonResponse;
+          cb(operaId);
+          return;
+        } catch (e) {
+          logError(`${MODULE_NAME}: invalid response`, response);
+        }
+        cb();
+      },
+      error: (err) => {
+        logError(`${MODULE_NAME}: ID error response`, err);
+        cb();
+      }
+    },
+    null,
+    AJAX_OPTIONS
+  );
+}
+
+export const operaIdSubmodule = {
+  /**
+     * used to link submodule with config
+     * @type {string}
+     */
+  name: MODULE_NAME,
+
+  /**
+     * @type {string}
+     */
+  version,
+
+  /**
+     * decode the stored id value for passing to bid requests
+     * @function
+     * @param {string} id
+     * @returns {{'operaId': string}}
+     */
+  decode: (id) =>
+    id != null && id.length > 0
+      ? { [ID_KEY]: id }
+      : undefined,
+
+  /**
+     * performs action to obtain id and return a value in the callback's response argument
+     * @function
+     * @param {SubmoduleConfig} [config]
+     * @returns {IdResponse|undefined}
+     */
+  getId(config, consentData) {
+    logMessage(`${MODULE_NAME}: start synchronizing opera uid`);
+    const params = (config && config.params) || {};
+    if (typeof params.pid !== 'string' || params.pid.length == 0) {
+      logError(`${MODULE_NAME}: submodule requires a publisher ID to be defined`);
+      return;
+    }
+
+    const { pid, syncUrl = SYNC_URL } = params;
+    const url = constructUrl(syncUrl, { publisherId: pid });
+
+    return {
+      callback: (cb) => {
+        asyncRequest(url, cb);
+      }
+    }
+  },
+
+  eids: {
+    'operaId': {
+      source: 't.adx.opera.com',
+      atype: 1
+    },
+  }
+};
+
+submodule('userId', operaIdSubmodule);

package/modules/operaadsIdSystem.md

@@ -0,0 +1,52 @@
+# Opera ID System
+
+For help adding this module, please contact [adtech-prebid-group@opera.com](adtech-prebid-group@opera.com).
+
+### Prebid Configuration
+
+You should configure this module under your `userSync.userIds[]` configuration:
+
+```javascript
+pbjs.setConfig({
+    userSync: {
+        userIds: [
+            {
+                name: "operaId",
+                storage: {
+                    name: "operaId",
+                    type: "html5",
+                    expires: 14
+                },
+                params: {
+                    pid: "your-pulisher-ID-here"
+                }
+            }
+        ]
+    }
+})
+```
+<br>
+
+| Param under `userSync.userIds[]` | Scope    | Type   | Description                   | Example                                   |
+| -------------------------------- | -------- | ------ | ----------------------------- | ----------------------------------------- |
+| name                             | Required | string | ID for the operaId module     | `"operaId"`                               |
+| storage                          | Optional | Object | Settings for operaId storage  | See [storage settings](#storage-settings) |
+| params                           | Required | Object | Parameters for opreaId module | See [params](#params)                     |
+<br>
+
+### Params
+
+| Param under `params` | Scope    | Type   | Description                    | Example         |
+| -------------------- | -------- | ------ | ------------------------------ | --------------- |
+| pid                  | Required | string | Publisher ID assigned by Opera | `"pub12345678"` |
+<br>
+
+### Storage Settings
+
+The following settings are suggested for the `storage` property in the `userSync.userIds[]` object:
+
+| Param under `storage` | Type          | Description                                                                      | Example     |
+| --------------------- | ------------- | -------------------------------------------------------------------------------- | ----------- |
+| name                  |  String       | Where the ID will be stored                                                      | `"operaId"` |
+| type                  |  String       | For best performance, this should be `"html5"`                                   | `"html5"`   |
+| expires               |  Number <= 30 | number of days until the stored ID expires. **Must be less than or equal to 30** | `14`        |

package/modules/oxxionAnalyticsAdapter.js

@@ -21,6 +21,7 @@ let saveEvents = {}
 let allEvents = {}
 let auctionEnd = {}
 let initOptions = {}
+let mode = {};
 let endpoint = 'https://default'
 let requestsAttributes = ['adUnitCode', 'auctionId', 'bidder', 'bidderCode', 'bidId', 'cpm', 'creativeId', 'currency', 'width', 'height', 'mediaType', 'netRevenue', 'originalCpm', 'originalCurrency', 'requestId', 'size', 'source', 'status', 'timeToRespond', 'transactionId', 'ttl', 'sizes', 'mediaTypes', 'src', 'params', 'userId', 'labelAny', 'bids', 'adId'];
 
@@ -41,16 +42,27 @@ function filterAttributes(arg, removead) {
     }
     if (typeof arg['gdprConsent'] != 'undefined') {
       response['gdprConsent'] = {};
-      if (typeof arg['gdprConsent']['consentString'] != 'undefined') { response['gdprConsent']['consentString'] = arg['gdprConsent']['consentString']; }
+      if (typeof arg['gdprConsent']['consentString'] != 'undefined') {
+        response['gdprConsent']['consentString'] = arg['gdprConsent']['consentString'];
+      }
     }
-    if (typeof arg['meta'] == 'object' && typeof arg['meta']['advertiserDomains'] != 'undefined') {
-      response['meta'] = {'advertiserDomains': arg['meta']['advertiserDomains']};
+    if (typeof arg['meta'] == 'object') {
+      response['meta'] = {};
+      if (typeof arg['meta']['advertiserDomains'] != 'undefined') {
+        response['meta']['advertiserDomains'] = arg['meta']['advertiserDomains'];
+      }
+      if (typeof arg['meta']['demandSource'] == 'string') {
+        response['meta']['demandSource'] = arg['meta']['demandSource'];
+      }
     }
     requestsAttributes.forEach((attr) => {
       if (typeof arg[attr] != 'undefined') { response[attr] = arg[attr]; }
     });
-    if (typeof response['creativeId'] == 'number') { response['creativeId'] = response['creativeId'].toString(); }
+    if (typeof response['creativeId'] == 'number') {
+      response['creativeId'] = response['creativeId'].toString();
+    }
   }
+  response['oxxionMode'] = mode;
   return response;
 }
 
@@ -229,7 +241,12 @@ oxxionAnalytics.originEnableAnalytics = oxxionAnalytics.enableAnalytics;
 oxxionAnalytics.enableAnalytics = function (config) {
   oxxionAnalytics.originEnableAnalytics(config); // call the base class function
   initOptions = config.options;
-  if (initOptions.domain) { endpoint = 'https://' + initOptions.domain; }
+  if (initOptions.domain) {
+    endpoint = 'https://' + initOptions.domain;
+  }
+  if (window.OXXION_MODE) {
+    mode = window.OXXION_MODE;
+  }
 };
 
 adapterManager.registerAnalyticsAdapter({

package/modules/prebidServerBidAdapter/index.js

@@ -18,7 +18,7 @@ import {
   deepAccess,
 } from '../../src/utils.js';
 import CONSTANTS from '../../src/constants.json';
-import adapterManager from '../../src/adapterManager.js';
+import adapterManager, {s2sActivityParams} from '../../src/adapterManager.js';
 import {config} from '../../src/config.js';
 import {addComponentAuction, isValid} from '../../src/adapters/bidderFactory.js';
 import * as events from '../../src/events.js';
@@ -29,6 +29,8 @@ import {hook} from '../../src/hook.js';
 import {hasPurpose1Consent} from '../../src/utils/gpdr.js';
 import {buildPBSRequest, interpretPBSResponse} from './ortbConverter.js';
 import {useMetrics} from '../../src/utils/perfMetrics.js';
+import {isActivityAllowed} from '../../src/activities/rules.js';
+import {ACTIVITY_TRANSMIT_UFPD} from '../../src/activities/activities.js';
 
 const getConfig = config.getConfig;
 
@@ -571,7 +573,11 @@ export const processPBSRequest = hook('sync', function (s2sBidRequest, bidReques
         }
       },
       requestJson,
-      {contentType: 'text/plain', withCredentials: true}
+      {
+        contentType: 'text/plain',
+        withCredentials: true,
+        browsingTopics: isActivityAllowed(ACTIVITY_TRANSMIT_UFPD, s2sActivityParams(s2sBidRequest.s2sConfig))
+      }
     );
   } else {
     logError('PBS request not made.  Check endpoints.');

package/modules/pubmaticAnalyticsAdapter.js

@@ -283,7 +283,7 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
         'ocpm': bid.bidResponse ? (bid.bidResponse.originalCpm || 0) : 0,
         'ocry': bid.bidResponse ? (bid.bidResponse.originalCurrency || CURRENCY_USD) : CURRENCY_USD,
         'piid': bid.bidResponse ? (bid.bidResponse.partnerImpId || EMPTY_STRING) : EMPTY_STRING,
-        'frv': (s2sBidders.indexOf(bid.bidder) > -1) ? undefined : (bid.bidResponse ? (bid.bidResponse.floorData ? bid.bidResponse.floorData.floorRuleValue : undefined) : undefined),
+        'frv': (bid.bidResponse ? (bid.bidResponse.floorData ? bid.bidResponse.floorData.floorRuleValue : undefined) : undefined),
         'md': bid.bidResponse ? getMetadata(bid.bidResponse.meta) : undefined
       });
     });
@@ -319,6 +319,17 @@ function getTgId() {
   return 0;
 }
 
+function getFloorFetchStatus(floorData) {
+  if (!floorData?.floorRequestData) {
+    return false;
+  }
+  const { location, fetchStatus } = floorData?.floorRequestData;
+  const isDataValid = location !== CONSTANTS.FLOOR_VALUES.NO_DATA;
+  const isFetchSuccessful = location === CONSTANTS.FLOOR_VALUES.FETCH && fetchStatus === CONSTANTS.FLOOR_VALUES.SUCCESS;
+  const isAdUnitOrSetConfig = location === CONSTANTS.FLOOR_VALUES.AD_UNIT || location === CONSTANTS.FLOOR_VALUES.SET_CONFIG;
+  return isDataValid && (isAdUnitOrSetConfig || isFetchSuccessful);
+}
+
 function executeBidsLoggerCall(e, highestCpmBids) {
   let auctionId = e.auctionId;
   let referrer = config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '';
@@ -326,6 +337,8 @@ function executeBidsLoggerCall(e, highestCpmBids) {
   let floorData = auctionCache.floorData;
   let outputObj = { s: [] };
   let pixelURL = END_POINT_BID_LOGGER;
+  // will return true if floor data is present.
+  let fetchStatus = getFloorFetchStatus(auctionCache.floorData);
 
   if (!auctionCache) {
     return;
@@ -347,7 +360,7 @@ function executeBidsLoggerCall(e, highestCpmBids) {
   outputObj['dvc'] = {'plt': getDevicePlatform()};
   outputObj['tgid'] = getTgId();
 
-  if (floorData) {
+  if (floorData && fetchStatus) {
     outputObj['fmv'] = floorData.floorRequestData ? floorData.floorRequestData.modelVersion || undefined : undefined;
     outputObj['ft'] = floorData.floorResponseData ? (floorData.floorResponseData.enforcements.enforceJS == false ? 0 : 1) : undefined;
   }
@@ -362,7 +375,7 @@ function executeBidsLoggerCall(e, highestCpmBids) {
       'mt': getAdUnitAdFormats(origAdUnit),
       'sz': getSizesForAdUnit(adUnit, adUnitId),
       'ps': gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestCpmBids.filter(bid => bid.adUnitCode === adUnitId)),
-      'fskp': floorData ? (floorData.floorRequestData ? (floorData.floorRequestData.skipped == false ? 0 : 1) : undefined) : undefined,
+      'fskp': (floorData && fetchStatus) ? (floorData.floorRequestData ? (floorData.floorRequestData.skipped == false ? 0 : 1) : undefined) : undefined,
     };
     slotsArray.push(slotObject);
     return slotsArray;

package/modules/rubiconBidAdapter.js

@@ -27,7 +27,7 @@ const DEFAULT_PBS_INTEGRATION = 'pbjs';
 const DEFAULT_RENDERER_URL = 'https://video-outstream.rubiconproject.com/apex-2.2.1.js';
 // renderer code at https://github.com/rubicon-project/apex2
 
-let rubiConf = {};
+let rubiConf = config.getConfig('rubicon') || {};
 // we are saving these as global to this module so that if a pub accidentally overwrites the entire
 // rubicon object, then we do not lose other data
 config.getConfig('rubicon', config => {
@@ -322,7 +322,7 @@ export const spec = {
         )
       );
     });
-    if (config.getConfig('rubicon.singleRequest') !== true) {
+    if (rubiConf.singleRequest !== true) {
       // bids are not grouped if single request mode is not enabled
       requests = filteredHttpRequest.concat(bannerBidRequests.map(bidRequest => {
         const bidParams = spec.createSlotParams(bidRequest, bidderRequest);

package/modules/smartyadsBidAdapter.js

@@ -3,6 +3,7 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
 import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import { ajax } from '../src/ajax.js';
 
 const BIDDER_CODE = 'smartyads';
 const AD_URL = 'https://n1.smartyads.com/?c=o&m=prebid&secret_key=prebid_js';
@@ -122,7 +123,23 @@ export const spec = {
     }
 
     return syncs
-  }
+  },
+
+  onBidWon: function(bid) {
+    if (bid.winUrl) {
+      ajax(bid.winUrl, () => {}, JSON.stringify(bid));
+    } else {
+      ajax('https://et-nd43.itdsmr.com/?c=o&m=prebid&secret_key=prebid_js&winTest=1', () => {}, JSON.stringify(bid));
+    }
+  },
+
+  onTimeout: function(bid) {
+    ajax('https://et-nd43.itdsmr.com/?c=o&m=prebid&secret_key=prebid_js&bidTimeout=1', () => {}, JSON.stringify(bid));
+  },
+
+  onBidderError: function(bid) {
+    ajax('https://et-nd43.itdsmr.com/?c=o&m=prebid&secret_key=prebid_js&bidderError=1', () => {}, JSON.stringify(bid));
+  },
 
 };