From 62349f1b2d99c763c387eea3ec46f1e6c38eeed3 Mon Sep 17 00:00:00 2001
From: novatiq <79258366+novatiq@users.noreply.github.com>
Date: Mon, 1 Mar 2021 17:56:02 +0200
Subject: [PATCH 3/9] Revert "Update userId.md"
This reverts commit 556d56a11608135b5abcbe73755bb9b3b8be7308.
---
dev-docs/modules/userId.md | 51 ++++----------------------------------
1 file changed, 5 insertions(+), 46 deletions(-)
diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md
index 9740dde699..282cb319f8 100644
--- a/dev-docs/modules/userId.md
+++ b/dev-docs/modules/userId.md
@@ -58,7 +58,7 @@ of sub-objects. The table below has the options that are common across ID system
{: .table .table-bordered .table-striped }
| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
-| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"novatiq"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"` |
+| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"` |
| params | Based on User ID sub-module | Object | | |
| bidders | Optional | Array of Strings | An array of bidder codes to which this user ID may be sent. | `['bidderA', 'bidderB']` |
| storage | Optional | Object | The publisher can specify some kind of local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. This is not needed when `value` is specified or the ID system is managing its own storage | |
@@ -72,7 +72,7 @@ of sub-objects. The table below has the options that are common across ID system
## User ID Sub-Modules
## Permissions
-Publishers can control which user ids are shared with the bid adapters they choose to work with by using the bidders array. The bidders array is part of the User id module config, publisher may choose to send an id to some bidders but not all, the default behavior is that each user id go to all bid adapters the publisher is working with.
+Publishers can control which user ids are shared with the bid adapters they choose to work with by using the bidders array. The bidders array is part of the User id module config, publisher may choose to send an id to some bidders but not all, the default behavior is that each user id go to all bid adapters the publisher is working with.
Use the optional `bidders` parameter to define an array of bidder codes to which this user ID may be sent.
@@ -96,7 +96,7 @@ userIds: [
}
]
```
-The Rubicon bid adapter would then receive
+The Rubicon bid adapter would then receive
```
{
"bidder": "rubicon",
@@ -842,42 +842,6 @@ pbjs.setConfig({
});
{% endhighlight %}
-### Novatiq Snowflake ID
-
-Novatiq proprietary dynamic snowflake ID is a unique, non sequential and single use identifier for marketing activation. Only the snowflake ID moves beyond the firewall, keeping all customer data (publisher / brand and telco) private, secure and under control. Our in network solution matches verification requests to the telco network ID, safely and securely behind the telco firewall .
-
-#### Novatiq Snowflake ID Configuration
-
-Enable by adding the Novatiq submodule to your Prebid.js package with:
-
-```
-gulp build --modules=novatiqIdSystem,userId
-```
-
-Module activation and configuration:
-
-```javascript
-pbjs.setConfig({
- userSync: {
- userIds: [{
- name: 'novatiq',
- params: {
- sourceid '1a3', // change to the Partner Number you received from Novatiq
- }
- }
- }],
- auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules
- }
-});
-```
-
-| Param under userSync.userIds[] | 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` |
-
-If you have any questions, please reach out to us at prebid@novatiq.com.
### Parrable ID
@@ -1384,6 +1348,7 @@ pbjs.setConfig({
})
```
+
## Adapters Supporting the User ID Sub-Modules
{% assign bidder_pages = site.pages | where: "layout", "bidder" %}
@@ -1510,12 +1475,6 @@ Bidders that want to support the User ID module in Prebid Server, need to update
"id": "11111111"
}]
},{
- "source": "novatiq.com",
- "uids": [{
- "id": "81b001ec-8914-488c-a96e-8c220d4ee08895ef",
- "atype":1
- }]
- },{
"source": "sharedid.org", // Shared ID
"uids": [{
"id": "01EAJWWNEPN3CYMM5N8M5VXY22",
@@ -1537,7 +1496,7 @@ Bidders that want to support the User ID module in Prebid Server, need to update
"uids": [{
"id": "61cef5656fb05f16d53938069f1684df4b2257e27"
}]
- }
+ }
]
}
}
From bc4683e2e396302236648ccfa6408317bba165ab Mon Sep 17 00:00:00 2001
From: novatiq <79258366+novatiq@users.noreply.github.com>
Date: Tue, 2 Mar 2021 12:47:31 +0200
Subject: [PATCH 4/9] Update userId.md
Novatiq ID System: updated product description as per request
---
dev-docs/modules/userId.md | 44 +++++++++++++++++++++++++++++++++++++-
1 file changed, 43 insertions(+), 1 deletion(-)
diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md
index 282cb319f8..8768af44cc 100644
--- a/dev-docs/modules/userId.md
+++ b/dev-docs/modules/userId.md
@@ -58,7 +58,7 @@ of sub-objects. The table below has the options that are common across ID system
{: .table .table-bordered .table-striped }
| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
-| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"` |
+| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"novatiqId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"` |
| params | Based on User ID sub-module | Object | | |
| bidders | Optional | Array of Strings | An array of bidder codes to which this user ID may be sent. | `['bidderA', 'bidderB']` |
| storage | Optional | Object | The publisher can specify some kind of local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. This is not needed when `value` is specified or the ID system is managing its own storage | |
@@ -842,6 +842,42 @@ pbjs.setConfig({
});
{% endhighlight %}
+### Novatiq Snowflake 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.
+
+#### Novatiq Snowflake ID Configuration
+
+Enable by adding the Novatiq submodule to your Prebid.js package with:
+
+```
+gulp build --modules=novatiqIdSystem,userId
+```
+
+Module activation and configuration:
+
+```javascript
+pbjs.setConfig({
+ userSync: {
+ userIds: [{
+ name: 'novatiq',
+ params: {
+ sourceid '1a3', // change to the Partner Number you received from Novatiq
+ }
+ }
+ }],
+ auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules
+ }
+});
+```
+
+| Param under userSync.userIds[] | 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` |
+
+If you have any questions, please reach out to us at prebid@novatiq.com.
### Parrable ID
@@ -1475,6 +1511,12 @@ Bidders that want to support the User ID module in Prebid Server, need to update
"id": "11111111"
}]
},{
+ "source": "novatiq.com",
+ "uids": [{
+ "id": "81b001ec-8914-488c-a96e-8c220d4ee08895ef",
+ "atype":1
+ }]
+ },{
"source": "sharedid.org", // Shared ID
"uids": [{
"id": "01EAJWWNEPN3CYMM5N8M5VXY22",
From 4ed64d37f870e3a8c9bf0d61de406de84b1ee38f Mon Sep 17 00:00:00 2001
From: "raj.sidhu"
Date: Tue, 1 Feb 2022 21:05:44 +0000
Subject: [PATCH 5/9] fix layout and format as per other examples
---
dev-docs/modules/userId.md | 90 ++++++++++++++++++--------------------
1 file changed, 42 insertions(+), 48 deletions(-)
diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md
index f57038f4c8..a0f4d2d638 100644
--- a/dev-docs/modules/userId.md
+++ b/dev-docs/modules/userId.md
@@ -1320,23 +1320,21 @@ pbjs.setConfig({
});
{% endhighlight %}
-# Novatiq Hyper ID
+### Novatiq Hyper ID
-The Novatiq 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.
+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 Hyper 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: [{
@@ -1351,34 +1349,31 @@ pbjs.setConfig({
auctionDelay: 50
}
});
-```
-
+{% endhighlight %}
-### Parameters for the Novatiq Module
-| 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` |
+#### Parameters for the Novatiq Module
-
+
+ | 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` |
+
-# Novatiq Hyper ID with Prebid SharedID support
+### Novatiq Hyper ID with Prebid SharedID support
You can make use of the Prebid.js SharedId module as follows.
-
-
-## Novatiq Hyper ID Configuration
+#### 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:
-```javascript
+{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [
@@ -1413,35 +1408,34 @@ pbjs.setConfig({
auctionDelay: 50
}
});
-```
-
-
-
-### Parameters for the Novatiq Module
-| 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
Defaults to "_pubcid" | `"demo_pubcid"` |
+{% endhighlight %}
-
+#### Parameters for the Novatiq Module
-### Parameters for the SharedID Module
-| 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
in the Novatiq module | `"demo_pubcid"` ||
-| params.storage.expires | Required | integer | Time to expire | `365` |
+
+ | 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
Defaults to "_pubcid" | `"demo_pubcid"` |
+
+#### Parameters for the SharedID Module
-
+
+ | 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
in the Novatiq module | `"demo_pubcid"` ||
+ | params.storage.expires | Required | integer | Time to expire | `365` |
+
-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
From 726ce25611791f8ae139ac0a087870bf52d07d2c Mon Sep 17 00:00:00 2001
From: "raj.sidhu"
Date: Tue, 1 Feb 2022 21:12:48 +0000
Subject: [PATCH 6/9] tables still broken, missed markup line just before the
close div - try again
---
dev-docs/modules/userId.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md
index a0f4d2d638..984e9cde7c 100644
--- a/dev-docs/modules/userId.md
+++ b/dev-docs/modules/userId.md
@@ -1359,6 +1359,7 @@ pbjs.setConfig({
| 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 }
### Novatiq Hyper ID with Prebid SharedID support
@@ -1420,6 +1421,7 @@ pbjs.setConfig({
| 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
Defaults to "_pubcid" | `"demo_pubcid"` |
+ {: .table .table-bordered .table-striped }