Snowflake ID is now Hyper ID and document new SharedID changes (prebi…

…d#3542) * Update userId.md Included novatiq snowflake id submodule specifications * Update download.md Added novatiq snowflake id submodule * Revert "Update userId.md" This reverts commit 556d56a. * Update userId.md Novatiq ID System: updated product description as per request * fix layout and format as per other examples * tables still broken, missed markup line just before the close div - try again * whitespace? Co-authored-by: novatiq <79258366+novatiq@users.noreply.github.com>
AuDigent · Aug 31, 2023 · b187c4f · b187c4f
1 parent 7b9de2f
commit b187c4f
Show file tree

Hide file tree

Showing 2 changed files with 96 additions and 12 deletions.
diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md
@@ -1320,42 +1320,126 @@ pbjs.setConfig({
 });
 {% endhighlight %}
 
-### Novatiq Snowflake ID
+### Novatiq Hyper ID
 
-Novatiq proprietary dynamic snowflake ID is a unique, non sequential and single use identifier for marketing activation. Our in network solution matches verification requests to telco network IDs, safely and securely inside telecom infrastructure. Novatiq snowflake ID can be used for identity validation and as a secured 1st party data delivery mechanism.
+The [Novatiq](https://www.novatiq.com) proprietary dynamic Hyper ID is a unique, non sequential and single use identifier for marketing activation. Our in network solution matches verification requests to telco network IDs safely and securely inside telecom infrastructure. The Novatiq Hyper ID can be used for identity validation and as a secured 1st party data delivery mechanism.
 
-#### Novatiq Snowflake ID Configuration
+#### Novatiq Hyper ID Configuration
 
 Enable by adding the Novatiq submodule to your Prebid.js package with:
 
-```
+{: .alert.alert-info :}
 gulp build --modules=novatiqIdSystem,userId
-```
+
 
 Module activation and configuration:
 
-```javascript
+{% highlight javascript %}
 pbjs.setConfig({
   userSync: {
     userIds: [{
       name: 'novatiq',
       params: {
-        sourceid '1a3',            // change to the Partner Number you received from Novatiq
+        // change to the Partner Number you received from Novatiq
+        sourceid '1a3'            
         }
       }
     }],
-    auctionDelay: 50             // 50ms maximum auction delay, applies to all userId modules
+    // 50ms maximum auction delay, applies to all userId modules
+    auctionDelay: 50             
   }
 });
-```
+{% endhighlight %}
 
-| Param under userSync.userIds[] | Scope | Type | Description | Example |
+#### Parameters for the Novatiq Module
+
+<div class="table-responsive" markdown="1">
+| Param  | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | Module identification: `"novatiq"` | `"novatiq"` |
 | params | Required | Object | Configuration specifications for the Novatiq module. | |
 | params.sourceid | Required | String | This is the Novatiq Partner Number obtained via Novatiq registration. | `1a3` |
+{: .table .table-bordered .table-striped }
+</div>
+
+
+### Novatiq Hyper ID with Prebid SharedID support
+You can make use of the Prebid.js SharedId module as follows. 
+
+#### Novatiq Hyper ID Configuration
+
+Enable by adding the Novatiq and SharedId submodule to your Prebid.js package with:
+
+{: .alert.alert-info :}
+gulp build --modules=novatiqIdSystem,userId,pubCommonId
+
+Module activation and configuration:
+
+{% highlight javascript %}
+pbjs.setConfig({
+  userSync: {
+    userIds: [
+      {
+        name: "pubCommonId",
+        storage: {
+          type: "cookie",   
+          // optional: will default to _pubcid if left blank
+          name: "demo_pubcid",     
+          
+          // expires in 1 years
+          expires: 365             
+        },
+        bidders: [ 'adtarget' ]
+      },                                            
+      {
+      name: 'novatiq',
+      params: {
+        // change to the Partner Number you received from Novatiq
+        sourceid '1a3',
+
+        // Use the sharedID module
+        useSharedId: true,
+
+        // optional: will default to _pubcid if left blank. 
+        // If not left blank must match "name" in the the module above
+        sharedIdName: 'demo_pubcid'   
+        }
+      }
+    }],
+    // 50ms maximum auction delay, applies to all userId modules
+    auctionDelay: 50             
+  }
+});
+{% endhighlight %}
+
+#### Parameters for the Novatiq Module
+
+<div class="table-responsive" markdown="1">
+| Param  | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | Module identification: `"novatiq"` | `"novatiq"` |
+| params | Required | Object | Configuration specifications for the Novatiq module. | |
+| params.sourceid | Required | String | The Novatiq Partner Number obtained via Novatiq | `1a3` |
+| params.useSharedId | Optional | Boolean | Use the sharedID module if it's activated. | `true` |
+| params.sharedIdName | Optional | String | Same as the SharedID "name" parameter <br /> Defaults to "_pubcid" | `"demo_pubcid"` |
+{: .table .table-bordered .table-striped }
+</div>
+
+#### Parameters for the SharedID Module
+
+<div class="table-responsive" markdown="1">
+| Param  | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | Module identification: `"pubCommonId"` | `"pubCommonId"` |
+| params | Required | Object | Configuration specifications for the SharedID module. | | |
+| params.storage | Required | Object |  | |
+| params.storage.type | Required | String | Storage type, Set to `"cookie"` | `"cookie"` |
+| params.storage.name | Optional | String | Storage cookie name. If this is changed must match sharedIdName <br /> in the Novatiq module | `"demo_pubcid"` ||
+| params.storage.expires | Required | integer | Time to expire | `365` |
+{: .table .table-bordered .table-striped }
+</div>
 
-If you have any questions, please reach out to us at prebid@novatiq.com.
+If you have any questions, please reach out to us at [prebid@novatiq.com](mailto:prebid@novatiq.com)
 
 ### Parrable ID
 

diff --git a/download.md b/download.md
@@ -309,7 +309,7 @@ These modules may require accounts with a service provider.<br/>
   <label><input type="checkbox" moduleCode="nextrollIdSystem" class="bidder-check-box"> NextRoll ID</label>
   </div></div>
   <div class="col-md-4"><div class="checkbox">
-  <label><input type="checkbox" moduleCode="novatiqIdSystem" class="bidder-check-box"> Novatiq Snowflake ID</label>
+  <label><input type="checkbox" moduleCode="novatiqIdSystem" class="bidder-check-box"> Novatiq Hyper ID</label>
   </div></div>
   <div class="col-md-4"><div class="checkbox">
   <label><input type="checkbox" moduleCode="parrableIdSystem" class="bidder-check-box"> Parrable ID</label>