prebid.js 7.10.0 → 7.13.0

package/modules/oneKeyIdSystem.md

@@ -0,0 +1,109 @@
+# OneKey
+
+The OneKey real-time data module in Prebid has been built so that publishers
+can quickly and easily setup the OneKey Addressability Framework.
+This module is used along with the oneKeyRtdProvider to pass OneKey data to your partners.
+Both modules are required. This module will pass oneKeyData to your partners
+while the oneKeyRtdProvider will pass the transmission requests.
+
+Background information:
+- [OneKey-Network/addressability-framework](https://github.com/OneKey-Network/addressability-framework)
+- [OneKey-Network/OneKey-implementation](https://github.com/OneKey-Network/OneKey-implementation)
+
+It can be added to you Prebid.js package with:
+
+{: .alert.alert-info :}
+gulp build –modules=userId,oneKeyIdSystem
+
+⚠️ This module works in association with a RTD module. See [oneKeyRtdProvider](oneKeyRtdProvider.md).
+
+#### OneKey Registration
+
+OneKey is a community based Framework with a decentralized approach.
+Go to [onekey.community](https://onekey.community/) for more details.
+
+#### OneKey Configuration
+
+{: .table .table-bordered .table-striped }
+| Param under userSync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | The name of this module | `"oneKeyData"` |
+
+
+#### OneKey Exemple
+
+```javascript
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: 'oneKeyData'
+        }]
+    }
+});
+```
+
+Bidders will receive the data in the following format:
+
+```json
+{
+    "identifiers": [{
+        "version": "0.1",
+        "type": "paf_browser_id",
+        "value": "da135b3a-7d04-44bf-a0af-c4709f10420b",
+        "source": {
+            "domain": "crto-poc-1.onekey.network",
+            "timestamp": 1648836556881,
+            "signature": "+NF27bBvPM54z103YPExXuS834+ggAQe6JV0jPeGo764vRYiiBl5OmEXlnB7UZgxNe3KBU7rN2jk0SkI4uL0bg=="
+        }
+    }],
+    "preferences": {
+        "version": "0.1",
+        "data": {
+            "use_browsing_for_personalization": true
+        },
+        "source": {
+            "domain": "cmp.pafdemopublisher.com",
+            "timestamp": 1648836566468,
+            "signature": "ipbYhU8IbSFm2tCqAVYI2d5w4DnGF7Xa2AaiZScx2nmBPLfMmIT/FkBYGitR8Mi791DHtcy5MXr4+bs1aeZFqw=="
+        }
+    }
+}
+```
+
+If the bidder elects to use pbjs.getUserIdsAsEids() then the format will be:
+
+```json
+"user": {
+    "ext": {
+        "eids": [{
+            "source": "paf",
+            "uids": [{
+                "id": "da135b3a-7d04-44bf-a0af-c4709f10420b",
+                "atype": 1,
+                "ext": {
+                    "version": "0.1",
+                    "type": "paf_browser_id",
+                    "source": {
+                        "domain": "crto-poc-1.onekey.network",
+                        "timestamp": 1648836556881,
+                        "signature": "+NF27bBvPM54z103YPExXuS834+ggAQe6JV0jPeGo764vRYiiBl5OmEXlnB7UZgxNe3KBU7rN2jk0SkI4uL0bg=="
+                    }
+                }
+            }],
+            "ext": {
+                "preferences": {
+                    "version": "0.1",
+                    "data": {
+                        "use_browsing_for_personalization": true
+                    },
+                    "source": {
+                        "domain": "cmp.pafdemopublisher.com",
+                        "timestamp": 1648836566468,
+                        "signature": "ipbYhU8IbSFm2tCqAVYI2d5w4DnGF7Xa2AaiZScx2nmBPLfMmIT/FkBYGitR8Mi791DHtcy5MXr4+bs1aeZFqw=="
+                    }
+                }
+            }
+        }]
+    }
+}
+```

package/modules/oneKeyRtdProvider.js

@@ -0,0 +1,98 @@
+
+import { submodule } from '../src/hook.js';
+import { mergeDeep, logError, logMessage, deepSetValue, generateUUID } from '../src/utils.js';
+import { getGlobal } from '../src/prebidGlobal.js';
+
+const SUBMODULE_NAME = 'oneKey';
+const prefixLog = 'OneKey.RTD-module'
+
+// Pre-init OneKey if it has not load yet.
+window.OneKey = window.OneKey || {};
+window.OneKey.queue = window.OneKey.queue || [];
+
+/**
+ * Generate the OneKey transmission and include it in the Bid Request.
+ *
+ * Modify the AdUnit object for each auction.
+ * It’s called as part of the requestBids hook.
+ * https://docs.prebid.org/dev-docs/add-rtd-submodule.html#getbidrequestdata
+ *
+ * @param {Object} reqBidsConfigObj
+ * @param {function} callback
+ * @param {Object} rtdConfig
+ * @param {Object} userConsent
+ */
+const getTransmissionInBidRequest = (reqBidsConfigObj, done, rtdConfig) => {
+  const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
+  const transactionIds = adUnits.map(() => generateUUID());
+
+  logMessage(prefixLog, 'Queue seed generation.');
+  window.OneKey.queue.push(() => {
+    logMessage(prefixLog, 'Generate a seed.');
+    window.OneKey.generateSeed(transactionIds)
+      .then(onGetSeed(reqBidsConfigObj, rtdConfig, adUnits, transactionIds))
+      .catch((err) => { logError(SUBMODULE_NAME, err.message); })
+      .finally(done);
+  });
+}
+
+const onGetSeed = (reqBidsConfigObj, rtdConfig, adUnits, transactionIds) => {
+  return (seed) => {
+    if (!seed) {
+      logMessage(prefixLog, 'No seed generated.');
+      return;
+    }
+
+    logMessage(prefixLog, 'Has retrieved a seed:', seed);
+    addTransactionIdsToAdUnits(adUnits, transactionIds);
+    addTransmissionToOrtb2(reqBidsConfigObj, rtdConfig, seed);
+  };
+};
+
+const addTransactionIdsToAdUnits = (adUnits, transactionIds) => {
+  adUnits.forEach((unit, index) => {
+    deepSetValue(unit, `ortb2Imp.ext.data.paf.transaction_id`, transactionIds[index]);
+  });
+};
+
+const addTransmissionToOrtb2 = (reqBidsConfigObj, rtdConfig, seed) => {
+  const okOrtb2 = {
+    ortb2: {
+      user: {
+        ext: {
+          paf: {
+            transmission: {
+              seed
+            }
+          }
+        }
+      }
+    }
+  }
+
+  const shareSeedWithAllBidders = !rtdConfig.params || !rtdConfig.params.bidders;
+  if (shareSeedWithAllBidders) {
+    // Change global first party data with OneKey
+    logMessage(prefixLog, 'set ortb2:', okOrtb2);
+    mergeDeep(reqBidsConfigObj.ortb2Fragments.global, okOrtb2.ortb2);
+  } else {
+    // Change bidder-specific first party data with OneKey
+    logMessage(prefixLog, `set ortb2 for: ${rtdConfig.params.bidders.join(',')}`, okOrtb2);
+    rtdConfig.params.bidders.forEach(bidder => {
+      mergeDeep(reqBidsConfigObj.ortb2Fragments.bidder, { [bidder]: okOrtb2.ortb2 });
+    });
+  }
+};
+
+/** @type {RtdSubmodule} */
+export const oneKeyDataSubmodule = {
+  /**
+   * used to link submodule with realTimeData
+   * @type {string}
+   */
+  name: SUBMODULE_NAME,
+  init: () => true,
+  getBidRequestData: getTransmissionInBidRequest,
+};
+
+submodule('realTimeData', oneKeyDataSubmodule);

package/modules/oneKeyRtdProvider.md

@@ -0,0 +1,127 @@
+## OneKey Real-time Data Submodule
+
+The OneKey real-time data module in Prebid has been built so that publishers
+can quickly and easily setup the OneKey Addressability Framework.
+This module is used along with the oneKeyIdSystem to pass OneKey data to your partners.
+Both modules are required. This module will pass transmission requests to your partners
+while the oneKeyIdSystem will pass the oneKeyData.
+
+Background information:
+- [OneKey-Network/addressability-framework](https://github.com/OneKey-Network/addressability-framework)
+- [OneKey-Network/OneKey-implementation](https://github.com/OneKey-Network/OneKey-implementation)
+
+## Implementation for Publishers
+
+### Integration
+
+1) Compile the OneKey RTD Provider and the OneKey UserID sub-module into your Prebid build. 
+
+```
+gulp build --modules=rtdModule,oneKeyRtdProvider
+```
+
+2) Publishers must register OneKey RTD Provider as a Real Time Data provider by using `setConfig`
+to load a Prebid Config containing a `realTimeData.dataProviders` array:
+
+```javascript
+pbjs.setConfig({
+    ...,
+    realTimeData: {
+      auctionDelay: 100,
+      dataProviders: [
+            {
+              name: 'oneKey',
+              waitForIt: true
+            }
+        ]
+    }
+});
+``` 
+
+3) Configure the OneKey RTD Provider with the bidders that are part of the OneKey community. If there is no bidders specified, the RTD provider
+will share OneKey data with all adapters.
+
+⚠️ This module works in association with a RTD module. See [oneKeyIdSystem](oneKeyIdSystem.md).
+
+### Parameters
+
+| Name  |Type | Description   | Notes  |
+| :------------ | :------------ | :------------ |:------------ |
+| name | String | Real time data module name | Always 'oneKey' |
+| waitForIt | Boolean | Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false |
+| params | Object | | Optional |
+| params.bidders | Array | List of bidders to restrict the data to. | Optional |
+
+## Implementation for Bidders
+
+### Bidder Requests
+
+The data will provided to the bidders using the `ortb2` object.
+The following is an example of the format of the data:
+
+```json
+"user": {
+    "ext": {
+        "paf": {
+            "transmission": {
+                "seed": {
+                    "version": "0.1",
+                    "transaction_ids": ["06df6992-691c-4342-bbb0-66d2a005d5b1", "d2cd0aa7-8810-478c-bd15-fb5bfa8138b8"],
+                    "publisher": "cmp.pafdemopublisher.com",
+                    "source": {
+                        "domain": "cmp.pafdemopublisher.com",
+                        "timestamp": 1649712888,
+                        "signature": "turzZlXh9IqD5Rjwh4vWR78pKLrVsmwQrGr6fgw8TPgQVJSC8K3HvkypTV7lm3UaCi+Zzjl+9sd7Hrv87gdI8w=="
+                    }
+                }
+            }
+        }
+    }
+}
+```
+
+```json
+"ortb2Imp": {
+    "ext": {
+        "data": {
+            "paf": {
+                "transaction_id": "52d23fed-4f50-4c17-b07a-c458143e9d09"
+            }
+        }
+    }
+}
+```
+
+### Bidder Responses
+
+Bidders who are part of the OneKey Addressability Framework and receive OneKey
+transmissions are required to return transmission responses as outlined in
+[OneKey-Network/addressability-framework]https://github.com/OneKey-Network/addressability-framework/blob/main/mvp-spec/ad-auction.md). Transmission responses should be appended to bids
+along with the releveant content_id using the meta.paf field. The paf-lib will
+be responsible for collecting all of the transmission responses.
+
+Below is an example of setting a transmission response:
+
+```javascript
+bid.meta.paf = {
+    content_id: "90141190-26fe-497c-acee-4d2b649c2112",
+    transmission: {
+        version: "0.1",
+        contents: [
+            {
+                transaction_id: "f55a401d-e8bb-4de1-a3d2-fa95619393e8",
+                content_id: "90141190-26fe-497c-acee-4d2b649c2112"
+            }
+        ],
+        status: "success",
+        details: "",
+        receiver: "dsp1.com",
+        source: {
+            domain: "dsp1.com",
+            timestamp: 1639589531,
+            signature: "d01c6e83f14b4f057c2a2a86d320e2454fc0c60df4645518d993b5f40019d24c"
+        },
+        children: []
+    }
+}
+```

package/modules/open8BidAdapter.js

@@ -68,7 +68,7 @@ export const spec = {
       meta: {
         advertiserDomains: ad.adomain || []
       }
-    }
+    };
 
     if (ad.adType === AD_TYPE.VIDEO) {
       const videoAd = bidderResponse.ad.video;

package/modules/openwebBidAdapter.js

@@ -149,7 +149,7 @@ function bidToTag(bidRequests, adapterRequest) {
     tag.UserEids = deepAccess(bidRequests[0], 'userIdAsEids');
   }
   // end publisher env
-  const bids = []
+  const bids = [];
 
   for (let i = 0, length = bidRequests.length; i < length; i++) {
     const bid = prepareBidRequests(bidRequests[i]);