New PubProvided Id UserId Submodule

integrationExamples/gpt/userId_example.html

@@ -109,6 +109,15 @@
             googletag.pubads().disableInitialLoad();
         });
 
+        const eidsProvider = function(){
+            return [{
+                source: "prov.com",
+                uids:[{
+                    id: "value read from cookie or local storage"
+                }]
+            }];
+        };
+
         pbjs.que.push(function() {
             pbjs.setConfig({
                 debug: true,
@@ -130,6 +139,25 @@
                 // },
                 userSync: {
                     userIds: [{
+                        name: "publisherProvided",
+                        params: {
+                            eids: [{
+                                source: "example.com",
+                                uids:[{
+                                    id: "value read from cookie or local storage",
+                                    ext: {
+                                        third: "third"
+                                    }
+                                }]
+                            },{
+                                source: "id-partner.com",
+                                uids:[{
+                                    id: "value read from cookie or local storage"
+                                }]
+                            }],
+                            eidsFunction: eidsProvider
+                        }
+                    },{
                         name: "unifiedId",
                         params: {
                             partner: "prebid",

modules/pubProvidedSystem.js

@@ -0,0 +1,52 @@
+/**
+ * This module adds Publisher Provided ids support to the User ID module
+ * The {@link module:modules/userId} module is required.
+ * @module modules/pubProvidedSystem
+ * @requires module:modules/userId
+ */
+
+import {submodule} from '../src/hook.js';
+import * as utils from "../src/utils";
+
+const MODULE_NAME = 'publisherProvided';
+
+/** @type {Submodule} */
+export const pubProvidedSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+
+  /**
+   * decode the stored id value for passing to bid request
+   * @function
+   * @param {string} value
+   * @returns {{pubProvided: array}} or undefined if value doesn't exists
+   */
+  decode(value) {
+    const res = value ? {pubProvided: value} : undefined;
+    utils.logInfo('PubProvidedId: Decoded value ' + JSON.stringify(res));
+    return res;
+  },
+
+  /**
+   * performs action to obtain id and return a value.
+   * @function
+   * @param {SubmoduleParams} [configParams]
+   * @returns {{id: array}}
+   */
+  getId(configParams) {
+    let res = [];
+    if (Array.isArray(configParams.eids)) {
+      res = res.concat(configParams.eids);
+    }
+    if (typeof configParams.eidsFunction === 'function') {
+      res = res.concat(configParams.eidsFunction());
+    }
+    return {id: res};
+  }
+};
+
+// Register submodule for userId
+submodule('userId', pubProvidedSubmodule);

modules/userId/eids.js

@@ -163,9 +163,13 @@ export function createEidsArray(bidRequestUserId) {
   let eids = [];
   for (const subModuleKey in bidRequestUserId) {
     if (bidRequestUserId.hasOwnProperty(subModuleKey)) {
-      const eid = createEidObject(bidRequestUserId[subModuleKey], subModuleKey);
-      if (eid) {
-        eids.push(eid);
+      if(subModuleKey === "pubProvided"){
+        eids = eids.concat(bidRequestUserId["pubProvided"]);
+      } else {
+        const eid = createEidObject(bidRequestUserId[subModuleKey], subModuleKey);
+        if (eid) {
+          eids.push(eid);
+        }
       }
     }
   }