UID 2.0 Userid submodule (#6443)

* UID 2.0 User id submodule

* UID 2.0 User id submodule

* UID 2.0 User id submodule

* UID 2.0 User id submodule

* Resolving merge conflicts and review comments

* Updating documentation

* Renaming module

* Fixing review comments

* Fixing review comments

* Fixing review comments

* Fixing review comments

* Fixing review comments

* Updating source uid2.com to uidapi.com

Co-authored-by: skocheri <[email protected]>

Author: 2 people

integrationExamples/gpt/userId_example.html

@@ -277,6 +277,9 @@
                         {
                             name: "criteo"
                         },
+                          {
+                            name: "uid2"
+                          }
                         ],
                         syncDelay: 5000,
                         auctionDelay: 1000

modules/uid2IdSystem.js

@@ -0,0 +1,97 @@
+/**
+ * This module adds uid2 ID support to the User ID module
+ * The {@link module:modules/userId} module is required.
+ * @module modules/uid2IdSystem
+ * @requires module:modules/userId
+ */
+
+import * as utils from '../src/utils.js'
+import {submodule} from '../src/hook.js';
+import { getStorageManager } from '../src/storageManager.js';
+
+const MODULE_NAME = 'uid2';
+const GVLID = 887;
+const LOG_PRE_FIX = 'UID2: ';
+const ADVERTISING_COOKIE = '__uid2_advertising_token';
+
+function readCookie() {
+  return storage.cookiesAreEnabled() ? storage.getCookie(ADVERTISING_COOKIE) : null;
+}
+
+function readFromLocalStorage() {
+  return storage.localStorageIsEnabled() ? storage.getDataFromLocalStorage(ADVERTISING_COOKIE) : null;
+}
+
+function getStorage() {
+  return getStorageManager(GVLID, MODULE_NAME);
+}
+
+const storage = getStorage();
+
+const logInfo = createLogInfo(LOG_PRE_FIX);
+
+function createLogInfo(prefix) {
+  return function (...strings) {
+    utils.logInfo(prefix + ' ', ...strings);
+  }
+}
+
+/**
+ * Encode the id
+ * @param value
+ * @returns {string|*}
+ */
+function encodeId(value) {
+  const result = {};
+  if (value) {
+    const bidIds = {
+      id: value
+    }
+    result.uid2 = bidIds;
+    logInfo('Decoded value ' + JSON.stringify(result));
+    return result;
+  }
+  return undefined;
+}
+
+/** @type {Submodule} */
+export const uid2IdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+
+  /**
+   * Vendor id of Prebid
+   * @type {Number}
+   */
+  gvlid: GVLID,
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {string} value
+   * @returns {{uid2:{ id: string }} or undefined if value doesn't exists
+   */
+  decode(value) {
+    return (value) ? encodeId(value) : undefined;
+  },
+
+  /**
+   * performs action to obtain id and return a value.
+   * @function
+   * @param {SubmoduleConfig} [config]
+   * @param {ConsentData|undefined} consentData
+   * @returns {uid2Id}
+   */
+  getId(config, consentData) {
+    logInfo('Creating UID 2.0');
+    let value = readCookie() || readFromLocalStorage();
+    logInfo('The advertising token: ' + value);
+    return {id: value}
+  },
+
+};
+
+// Register submodule for userId
+submodule('userId', uid2IdSubmodule);

modules/uid2IdSystem.md

@@ -0,0 +1,24 @@
+## UID 2.0 User ID Submodule
+
+UID 2.0 ID Module.
+
+### Prebid Params
+
+Individual params may be set for the UID 2.0 Submodule. At least one identifier must be set in the params.
+
+```
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: 'uid2'
+        }]
+    }
+});
+```
+## Parameter Descriptions for the `usersync` Configuration Section
+The below parameters apply only to the UID 2.0 User ID Module integration.
+
+| Param under userSync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | ID value for the UID20 module - `"uid2"` | `"uid2"` |
+| value | Optional | Object | Used only if the page has a separate mechanism for storing the UID 2.O ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage | `{"uid2": { "id": "eb33b0cb-8d35-4722-b9c0-1a31d4064888"}}` |

modules/userId/eids.js

@@ -185,6 +185,13 @@ const USER_IDS_CONFIG = {
     },
     source: 'novatiq.com',
     atype: 1
+  },
+  'uid2': {
+    source: 'uidapi.com',
+    atype: 3,
+    getValue: function(data) {
+      return data.id;
+    }
   }
 };
 

modules/userId/eids.md

@@ -162,6 +162,13 @@ userIdAsEids = [
             id: 'some-random-id-value',
             atype: 1
         }]
-    }
+    },
+     {
+        source: 'uidapi.com',
+        uids: [{
+            id: 'some-random-id-value',
+             atype: 3
+        }]
+     }
 ]
 ```

modules/userId/userId.md

@@ -84,6 +84,9 @@ pbjs.setConfig({
                 partnerId: 0000,
                 uid: '12345xyz'
             }
+        }, {
+            name: 'uid2'
+        }
         }],
         syncDelay: 5000,
         auctionDelay: 1000
@@ -161,7 +164,7 @@ pbjs.setConfig({
                  type: 'html5',
                  name: '_criteoId',
                  expires: 1
-              }
+        }
         }],
         syncDelay: 5000
     }

test/spec/modules/eids_spec.js

@@ -276,6 +276,20 @@ describe('eids array generation for known sub-modules', function() {
       }]
     });
   });
+  it('uid2', function() {
+    const userId = {
+      uid2: {'id': 'Sample_AD_Token'}
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: 'uidapi.com',
+      uids: [{
+        id: 'Sample_AD_Token',
+        atype: 3
+      }]
+    });
+  });
   it('pubProvidedId', function() {
     const userId = {
       pubProvidedId: [{