Audigent HaloID User Id System Module

integrationExamples/gpt/userId_example.html

@@ -230,10 +230,19 @@
                         name: "_li_pbid",
                         expires: 28
                       }
+                    }, 
+                    {
+                        name: "zeotapIdPlus"
                     },
                     {
-                      name: "zeotapIdPlus"
-                    }],
+                        name: 'haloId',
+                        storage: {
+                            type: "cookie",
+                            name: "haloId",
+                            expires: 28
+                        }
+                    } 
+                    ],
                     syncDelay: 5000,
                     auctionDelay: 1000
                 }

modules/.submodules.json

@@ -13,14 +13,16 @@
     "identityLinkIdSystem",
     "sharedIdSystem",
     "intentIqIdSystem",
-    "zeotapIdPlusIdSystem"
+    "zeotapIdPlusIdSystem",
+    "haloIdSystem"
   ],
   "adpod": [
     "freeWheelAdserverVideo",
     "dfpAdServerVideo"
   ],
   "rtdModule": [
     "browsiRtdProvider",
+    "audigentRtdProvider",
     "jwplayerRtdProvider"
   ]
 }

modules/haloIdSystem.js

@@ -0,0 +1,63 @@
+/**
+ * This module adds HaloID to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/haloIdSystem
+ * @requires module:modules/userId
+ */
+
+import * as utils from '../src/utils.js';
+import {ajax} from '../src/ajax.js';
+import {submodule} from '../src/hook.js';
+
+const MODULE_NAME = 'haloId';
+
+/** @type {Submodule} */
+export const haloIdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {{value:string}} value
+   * @returns {{haloId:Object}}
+   */
+  decode(value) {
+    return (value && typeof value['haloId'] === 'string') ? { 'haloId': value['haloId'] } : undefined;
+  },
+  /**
+   * performs action to obtain id and return a value in the callback's response argument
+   * @function
+   * @param {SubmoduleParams} [configParams]
+   * @returns {IdResponse|undefined}
+   */
+  getId(configParams) {
+    const url = `https://id.halo.ad.gt/api/v1/pbhid`;
+
+    const resp = function (callback) {
+      const callbacks = {
+        success: response => {
+          let responseObj;
+          if (response) {
+            try {
+              responseObj = JSON.parse(response);
+            } catch (error) {
+              utils.logError(error);
+            }
+          }
+          callback(responseObj);
+        },
+        error: error => {
+          utils.logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+          callback();
+        }
+      };
+      ajax(url, callbacks, undefined, {method: 'GET'});
+    };
+    return {callback: resp};
+  }
+};
+
+submodule('userId', haloIdSubmodule);

modules/haloIdSystem.md

@@ -0,0 +1,32 @@
+## Audigent Halo User ID Submodule
+
+Audigent Halo ID Module. For assistance setting up your module please contact us at [[email protected]]([email protected]).
+
+### Prebid Params
+
+Individual params may be set for the Audigent Halo ID Submodule. At least one identifier must be set in the params.
+
+```
+pbjs.setConfig({
+    usersync: {
+        userIds: [{
+            name: 'haloId',
+            storage: {
+                name: 'haloId',
+                type: 'html5'
+            }
+        }]
+    }
+});
+```
+## Parameter Descriptions for the `usersync` Configuration Section
+The below parameters apply only to the HaloID User ID Module integration.
+
+| Param under usersync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | ID value for the HaloID module - `"haloId"` | `"haloId"` |
+| storage | Required | Object | The publisher must specify the local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. | |
+| storage.type | Required | String | This is where the results of the user ID will be stored. The recommended method is `localStorage` by specifying `html5`. | `"html5"` |
+| storage.name | Required | String | The name of the cookie or html5 local storage where the user ID will be stored. | `"haloid"` |
+| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. | `365` |
+| value | Optional | Object | Used only if the page has a separate mechanism for storing the Halo 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 | `{"haloId": "eb33b0cb-8d35-4722-b9c0-1a31d4064888"}` |

modules/userId/eids.js

@@ -111,6 +111,7 @@ const USER_IDS_CONFIG = {
     source: 'netid.de',
     atype: 1
   },
+
   // sharedid
   'sharedid': {
     source: 'sharedid.org',
@@ -124,10 +125,17 @@ const USER_IDS_CONFIG = {
       } : undefined;
     }
   },
+
   // zeotapIdPlus
   'IDP': {
     source: 'zeotap.com',
     atype: 1
+  },
+
+  // haloId
+  'haloId': {
+    source: 'audigent.com',
+    atype: 1
   }
 };
 

modules/userId/eids.md

@@ -103,5 +103,12 @@ userIdAsEids = [
             atype: 1
         }]
     },
+    {
+        source: 'audigent.com',
+        uids: [{
+            id: 'some-random-id-value',
+            atype: 1
+        }]
+    }
 ]
 ```

test/spec/modules/eids_spec.js

@@ -192,6 +192,7 @@ describe('eids array generation for known sub-modules', function() {
       }]
     });
   });
+
   it('zeotapIdPlus', function() {
     const userId = {
       IDP: 'some-random-id-value'
@@ -206,6 +207,21 @@ describe('eids array generation for known sub-modules', function() {
       }]
     });
   });
+
+  it('haloId', function() {
+    const userId = {
+      haloId: 'some-random-id-value'
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: 'audigent.com',
+      uids: [{
+        id: 'some-random-id-value',
+        atype: 1
+      }]
+    });
+  });
 });
 
 describe('Negative case', function() {