CM-864 - dd index id support

modules/.submodules.json

@@ -46,7 +46,8 @@
       "zeotapIdPlusIdSystem",
       "adqueryIdSystem",
       "gravitoIdSystem",
-      "freepassIdSystem"
+      "freepassIdSystem",
+      "operaadsIdSystem"
     ],
     "adpod": [
       "freeWheelAdserverVideo",

modules/adrelevantisBidAdapter.js

@@ -597,6 +597,8 @@ function parseMediaType(rtbBid) {
   const adType = rtbBid.ad_type;
   if (adType === VIDEO) {
     return VIDEO;
+  } else if (adType === NATIVE) {
+    return NATIVE;
   } else {
     return BANNER;
   }

modules/criteoBidAdapter.js

@@ -3,7 +3,6 @@ import { loadExternalScript } from '../src/adloader.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { find } from '../src/polyfill.js';
 import { verify } from 'criteo-direct-rsa-validate/build/verify.js'; // ref#2
 import { getStorageManager } from '../src/storageManager.js';
 import { getRefererInfo } from '../src/refererDetection.js';
@@ -219,51 +218,53 @@ export const spec = {
 
     if (body && body.slots && isArray(body.slots)) {
       body.slots.forEach(slot => {
-        const bidRequest = find(request.bidRequests, b => b.adUnitCode === slot.impid && (!b.params.zoneId || parseInt(b.params.zoneId) === slot.zoneid));
-        const bidId = bidRequest.bidId;
-        const bid = {
-          requestId: bidId,
-          cpm: slot.cpm,
-          currency: slot.currency,
-          netRevenue: true,
-          ttl: slot.ttl || 60,
-          creativeId: slot.creativecode,
-          width: slot.width,
-          height: slot.height,
-          dealId: slot.deal,
-        };
-        if (body.ext?.paf?.transmission && slot.ext?.paf?.content_id) {
-          const pafResponseMeta = {
-            content_id: slot.ext.paf.content_id,
-            transmission: response.ext.paf.transmission
+        const bidRequest = getAssociatedBidRequest(request.bidRequests, slot);
+        if (bidRequest) {
+          const bidId = bidRequest.bidId;
+          const bid = {
+            requestId: bidId,
+            cpm: slot.cpm,
+            currency: slot.currency,
+            netRevenue: true,
+            ttl: slot.ttl || 60,
+            creativeId: slot.creativecode,
+            width: slot.width,
+            height: slot.height,
+            dealId: slot.deal,
           };
-          bid.meta = Object.assign({}, bid.meta, { paf: pafResponseMeta });
-        }
-        if (slot.adomain) {
-          bid.meta = Object.assign({}, bid.meta, { advertiserDomains: [slot.adomain].flat() });
-        }
-        if (slot.ext?.meta?.networkName) {
-          bid.meta = Object.assign({}, bid.meta, { networkName: slot.ext.meta.networkName })
-        }
-        if (slot.native) {
-          if (bidRequest.params.nativeCallback) {
-            bid.ad = createNativeAd(bidId, slot.native, bidRequest.params.nativeCallback);
-          } else {
-            bid.native = createPrebidNativeAd(slot.native);
-            bid.mediaType = NATIVE;
+          if (body.ext?.paf?.transmission && slot.ext?.paf?.content_id) {
+            const pafResponseMeta = {
+              content_id: slot.ext.paf.content_id,
+              transmission: response.ext.paf.transmission
+            };
+            bid.meta = Object.assign({}, bid.meta, { paf: pafResponseMeta });
           }
-        } else if (slot.video) {
-          bid.vastUrl = slot.displayurl;
-          bid.mediaType = VIDEO;
-          const context = deepAccess(bidRequest, 'mediaTypes.video.context');
-          // if outstream video, add a default render for it.
-          if (context === OUTSTREAM) {
-            bid.renderer = createOutstreamVideoRenderer(slot);
+          if (slot.adomain) {
+            bid.meta = Object.assign({}, bid.meta, { advertiserDomains: [slot.adomain].flat() });
           }
-        } else {
-          bid.ad = slot.creative;
+          if (slot.ext?.meta?.networkName) {
+            bid.meta = Object.assign({}, bid.meta, { networkName: slot.ext.meta.networkName })
+          }
+          if (slot.native) {
+            if (bidRequest.params.nativeCallback) {
+              bid.ad = createNativeAd(bidId, slot.native, bidRequest.params.nativeCallback);
+            } else {
+              bid.native = createPrebidNativeAd(slot.native);
+              bid.mediaType = NATIVE;
+            }
+          } else if (slot.video) {
+            bid.vastUrl = slot.displayurl;
+            bid.mediaType = VIDEO;
+            const context = deepAccess(bidRequest, 'mediaTypes.video.context');
+            // if outstream video, add a default render for it.
+            if (context === OUTSTREAM) {
+              bid.renderer = createOutstreamVideoRenderer(slot);
+            }
+          } else {
+            bid.ad = slot.creative;
+          }
+          bids.push(bid);
         }
-        bids.push(bid);
       });
     }
 
@@ -786,6 +787,27 @@ function createOutstreamVideoRenderer(slot) {
   return renderer;
 }
 
+function getAssociatedBidRequest(bidRequests, slot) {
+  for (const request of bidRequests) {
+    if (request.adUnitCode === slot.impid) {
+      if (request.params.zoneId && parseInt(request.params.zoneId) === slot.zoneid) {
+        return request;
+      } else if (slot.native) {
+        if (request.mediaTypes?.native || request.nativeParams) {
+          return request;
+        }
+      } else if (slot.video) {
+        if (request.mediaTypes?.video) {
+          return request;
+        }
+      } else if (request.mediaTypes?.banner || request.sizes) {
+        return request;
+      }
+    }
+  }
+  return undefined;
+}
+
 export function tryGetCriteoFastBid() {
   // begin ref#1
   try {

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: 'indexexchange.com',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    }
   }
 };
 

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;

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
       }
     }]
   }

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);

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`        |