Integrate id link system (prebid#3965)

* idLink - integrate new submodule idLinkSystem in to userId module

* idLink - Fix unit tests

* identityLink - Change submodule name from idLink to identityLink

* Identity Link - Remove identity link to be default submodule

Author: mamatic

integrationExamples/gpt/userId_example.html

@@ -162,6 +162,16 @@
                         //     foo: '9879878907987',
                         //     bar:'93939'
                         // }
+                    },  {
+                      name: 'identityLink',
+                      params: {
+                        pid: '14' // Set your real identityLink placement ID here
+                      },
+                      storage: {
+                        type: 'cookie',
+                        name: 'idl_env',
+                        expires: 60
+                      }
                     }],
                     syncDelay: 5000
                 }

modules/identityLinkSystem.js

@@ -0,0 +1,58 @@
+/**
+ * This module adds IdentityLink to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/identityLinkSubmodule
+ * @requires module:modules/userId
+ */
+
+import * as utils from '../src/utils.js'
+import {ajax} from '../src/ajax.js';
+import {submodule} from '../src/hook';
+
+/** @type {Submodule} */
+export const identityLinkSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: 'identityLink',
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {string} value
+   * @returns {{idl_env:string}}
+   */
+  decode(value) {
+    return { 'idl_env': value }
+  },
+  /**
+   * performs action to obtain id and return a value in the callback's response argument
+   * @function
+   * @param {SubmoduleParams} [configParams]
+   * @returns {function(callback:function)}
+   */
+  getId(configParams) {
+    if (!configParams || typeof configParams.pid !== 'string') {
+      utils.logError('identityLink submodule requires partner id to be defined');
+      return;
+    }
+    // use protocol relative urls for http or https
+    const url = `https://api.rlcdn.com/api/identity?pid=${configParams.pid}&rt=envelope`;
+
+    return function (callback) {
+      ajax(url, response => {
+        let responseObj;
+        if (response) {
+          try {
+            responseObj = JSON.parse(response);
+          } catch (error) {
+            utils.logError(error);
+          }
+        }
+        callback(responseObj.envelope);
+      }, undefined, { method: 'GET' });
+    }
+  }
+};
+
+submodule('userId', identityLinkSubmodule);

modules/userId/index.js

@@ -50,6 +50,7 @@
  * @typedef {Object} SubmoduleParams
  * @property {(string|undefined)} partner - partner url param value
  * @property {(string|undefined)} url - webservice request url used to load Id data
+ * @property {(string|undefined)} pid - placement id url param value
  */
 
 /**

modules/userId/userId.md

@@ -32,6 +32,16 @@ pbjs.setConfig({
                 name: "id5id",
                 expires: 5
             }
+        }, {
+            name: 'identityLink',
+            params: {
+                pid: '999' // Set your real identityLink placement ID here 
+            },
+            storage: {
+                type: 'cookie',
+                name: 'idl_env',
+                expires: 60
+            }
         }],
         syncDelay: 5000
     }
@@ -60,6 +70,16 @@ pbjs.setConfig({
                 name: "pubcid",
                 expires: 60
             }
+        }, {
+            name: 'identityLink',
+            params: {
+                pid: '999' // Set your real identityLink placement ID here 
+            },
+            storage: {
+                type: 'html5',
+                name: 'idl_env',
+                expires: 60
+            }
         }],
         syncDelay: 5000
     }