Implement initial proposal for new userId module meta fields - prebid…

…#5060 (prebid#5673) * Implement initial proposal for new userId module meta fields * Fix linting errors in sharedid md * Migrate all meta data to userId files * Fix linting issues in hadron.md * fix table in mediawallah * Fix dmd table * Fix novatiq id table * fix publisherlink table * Fix liveramp table * Fix trustpid table * Fix yahoo table * Fix yahoo table * Remove empty line * Remove empty line #2
Ogury · Nov 28, 2024 · 44c1b8e · 44c1b8e
1 parent 8b6c2cd
commit 44c1b8e
Show file tree

Hide file tree

Showing 54 changed files with 326 additions and 141 deletions.
diff --git a/_layouts/userid.html b/_layouts/userid.html
@@ -30,6 +30,24 @@
                 <p><a href="/dev-docs/modules/userId.html#user-id-sub-modules">Back to User ID Module</a></p>
 
                 <h2>{{ page.title }}</h2>
+                <table class="table table-bordered table-striped">
+                  <tr>
+                    <th class="pbTh">Module</th>
+                    <td class="pbTd">{{ page.useridmodule }}</td>
+                  </tr>
+                  <tr>
+                    <th class="pbTh">EID Source</th>
+                    <td class="pbTd">{{ page.eidsource }}</td>
+                  </tr>
+                  <tr>
+                    <th class="pbTh">bidRequest.userId</th>
+                    <td class="pbTd">{{ page.bidRequestUserId }}</td>
+                  </tr>
+                  <tr>
+                    <th class="pbTh">Example</th>
+                    <td class="pbTd"><code>{{ page.example }}</code></td>
+                  </tr>
+                </table>
 
                 {{content}}
 

diff --git a/dev-docs/modules/idLibrary.md b/dev-docs/modules/idLibrary.md
@@ -26,8 +26,9 @@ The module attempts to extract a persistant identifier in the following ways:
 
 To get started, add the module to your Prebid.js wrapper. From the command line:
 
-{: .alert.alert-info :}
+```bash
 gulp build --modules=idImportLibrary
+```
 
 ## Application Flow
 
@@ -45,6 +46,7 @@ In the idLibrary module, the persistant id is fetched from the page and synced w
 ## Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param  | Required | Description |
 | --- | --- | --- |
 | url | yes | The url endpoint is used to post the MD5 hasheds|

diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md
@@ -204,9 +204,22 @@ The corresponding user id object and the eids array will look like this:
 
 {% assign userid_pages = site.pages | where: "layout", "userid" | sort_natural: "title" %}
 
+<table class="table table-bordered table-striped">
+  <tr>
+    <th>ID System Name</th>
+    <th>Prebid.js Attr: bidRequest.userId</th>
+    <th>EID Source</th>
+    <th>Example</th>
+  </tr>
 {% for page in userid_pages %}
-<li><a href="/{{ page.path | replace: '.md', '.html'}}">{{page.title}}</a></li>
+  <tr>
+    <td><a href="/{{ page.path | replace: '.md', '.html'}}">{{page.title}}</a></td>
+    <td>{{page.bidRequestUserId}}</td>
+    <td>{{page.eidsource}}</td>
+    <td>{{page.example}}</td>
+  </tr>
 {% endfor %}
+</table>
 
 ## Bidder Adapter Implementation
 
@@ -218,53 +231,6 @@ To add a custom data type for the response of `pbjs.getUserIdsAsEids()`, see oth
 
 Bidders that want to support the User ID module in Prebid.js need to update their bidder adapter to read the indicated bidRequest attributes and pass them to their endpoint.
 
-{: .table .table-bordered .table-striped }
-| ID System Name | ID System Host | Prebid.js Attr: bidRequest.userId. | EID Source | Example Value |
-| --- | --- | --- | --- | --- | --- |
-| 33Across ID | 33Across | 33acrossId | 33across.com | "1111" |
-| Admixer ID | Admixer | admixerId | admixer.net | "1111" |
-| adQuery QiD | adQuery | qid | adquery.io | "p9v2dpnuckkzhuc..." |
-| Adriver ID | Adriver | adriverId | adriver.ru | "1111" |
-| Adtelligent ID | Adtelligent | adtelligentId | adtelligent.com | `"1111"` |
-| AMX ID | AMX | amxId | amxdt.net | "3ca11058-..." |
-| BritePool ID | BritePool | britepoolid | britepool.com | "1111" |
-| AudienceOne ID | DAC | dacId | dac.co.jp | {"id": "1111"} |
-| DeepIntent ID | Deep Intent | deepintentId | deepintent.com | "1111" |
-| DMD ID | DMD | dmdId | hcn.health | "1111" |
-| ceeId | ceeId | ceeId | ceeid.eu | "111111" |
-| Czech Ad ID | czechAdId | czechAdId | czechadid.cz | "1111" |
-| CriteoID | Criteo | criteoId | criteo.com | "1111" |
-| Fabrick ID | Neustar | fabrickId | neustar.biz | "1111" |
-| FLoC ID | n/a | flocId | | |
-| GrowthCode ID | GrowthCode | growthCodeId | growthcode.io | "1111" |
-| Hadron ID | Audigent | hadronId | audigent.com | {"hadronId":"user-hadron-id", "auSeg":["segment1", "segment2"]} |
-| ID+ | Zeotap | IDP | zeotap.com | "1111" |
-| ID5 ID | ID5 | id5id | id5-sync.com | {uid: "1111", ext: { linkType: 2, abTestingControlGroup: false } } |
-| IdentityLink | LiveRamp | idl_env | liveramp.com | "1111" |
-| Intent IQ ID | Intent IQ | intentiqid | intentiq.com | "1111" |
-| Kinesso ID | Kinesso | kpuid | kpuid.com | "1111" |
-| LiveIntent ID | Live Intent | lipb.lipbid | liveintent.com | "1111" |
-| Lotame Panorama ID | Lotame | lotamePanoramaId | crwdcntrl.net | "e4b9..." |
-| MediaWallah OpenLink ID | MediaWallah | mwOpenLinkId | mediawallahscript.com | "1111" |
-| merkleID | Merkle | merkleId | merkleinc.com | "1111" |
-| naveggId | Navegg | naveggId | navegg.com | "1111" |
-| netID | netID | netId | netid.de | "fH5A..." |
-| Novatiq ID | Novatiq | novatiqId | novatiq.com | "1111" |
-| Parrable ID | Parrable | parrableId | parrable.com | {"eid":"01.15946..."} |
-| Publisher Link ID | n/a | publinkId | epsilon.com | |
-| PubProvided ID | n/a | pubProvidedId | publisher domain | "1111" |
-| Quantcast ID | n/a | quantcastId | quantcast.com | "1111" |
-| Rewarded Interest ID | Rewarded Interest | rewardedInterestId | rewardedinterest.com | "1111" |
-| Tapad ID | Tapad | tapadId | tapad.com | "1111" |
-| Teads ID | Teads | teadsId | teads.com | "1111" |
-| SharedID (PBJS 5.x) | n/a | pubcid | pubcid.org | "1111" |
-| SharedID (PBJS 4.x)| Prebid | sharedid | sharedid.org | {"id":"01EAJWWN...", "third":"01EAJ..."} |
-| Unified ID | Trade Desk | tdid | adserver.org | "1111" |
-| ConnectID | Yahoo | connectId | yahoo.com | {"connectId": "72d04af6..."} |
-| FreePass ID | FreePass | freepassId | | "1111" |
-| UtiqMtp ID | Utiq | utiqMtpId | utiq-mtp.com | "1111" |
-| Yandex ID | Yandex | yandexId | yandex.com | "11111111111111111" |
-
 For example, the adapter code might do something like:
 
 ```javascript
@@ -355,8 +321,6 @@ If you're an ID provider that wants to get on this page:
   * Add a new row to `/dev-docs/modules/userId.md#prebidjs-adapters`
   * Submit a documentation Pull Request
 
-<a name="getUserIds"></a>
-
 ## ESP Configurations
 
 Google now supports Encrypted Signals for Publishers(ESP), a program that allows publishers can explicitly share encrypted signals on bid requests with third-party bidders. User ID modules now support code which will register the signal sources and encrypted signals are created and are sent to GAM request in a3p parameter. 'encryptedSignal' configuration under userSync Module will help to configure signal sources.

diff --git a/dev-docs/modules/userid-submodules/33across.md b/dev-docs/modules/userid-submodules/33across.md
@@ -3,6 +3,9 @@ layout: userid
 title: 33Across ID
 description: 33Across ID User ID sub-module
 useridmodule: 33acrossIdSystem
+bidRequestUserId: 33acrossId
+eidsource: 33across.com
+example: '"1111"'
 ---
 
 
@@ -21,6 +24,7 @@ gulp build --modules=33acrossIdSystem,userId
 The following configuration parameters are available:
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of this sub-module | `"33acrossId"` |

diff --git a/dev-docs/modules/userid-submodules/admixer.md b/dev-docs/modules/userid-submodules/admixer.md
@@ -3,6 +3,9 @@ layout: userid
 title: AdmixerID
 description: AdmixerID User ID sub-module
 useridmodule: admixerIdSystem
+bidRequestUserId: admixerId
+eidsource: admixer.net
+example: '"1111"'
 ---
 
 
@@ -12,12 +15,14 @@ The Admixer privacy policy is at <https://admixer.com/privacy/>
 
 Add Admixer ID module to your Prebid.js package with:
 
-{: .alert.alert-info :}
+```bash
 gulp build --modules=admixerIdSystem
+```
 
 ## AdmixerID Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | `"admixerId"` | `"admixerId"` |

diff --git a/dev-docs/modules/userid-submodules/adquery.md b/dev-docs/modules/userid-submodules/adquery.md
@@ -3,6 +3,9 @@ layout: userid
 title: adQuery QiD
 description: adQuery QiD User ID sub-module
 useridmodule: adqueryIdSystem
+bidRequestUserId: qid
+eidsource: adquery.io
+example: '"p9v2dpnuckkzhuc"'
 ---
 
 

diff --git a/dev-docs/modules/userid-submodules/adriver.md b/dev-docs/modules/userid-submodules/adriver.md
@@ -3,11 +3,15 @@ layout: userid
 title: Adriver ID
 description: Adriver ID User ID sub-module
 useridmodule: adriverId
+bidRequestUserId: adriverId
+eidsource: adriver.ru
+example: '"1111"'
 ---
 
 ## Adriver ID Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of this module: `"adriverId"` | `"adriverId"` |

diff --git a/dev-docs/modules/userid-submodules/adtelligent.md b/dev-docs/modules/userid-submodules/adtelligent.md
@@ -3,15 +3,19 @@ layout: userid
 title: Adtelligent
 description: Adtelligent User ID sub-module
 useridmodule: adtelligentIdSystem
+bidRequestUserId: adtelligentId
+eidsource: adtelligent.com
+example: '"1111"'
 ---
 
 
 The [Adtelligent](https://adtelligent.com) ID system is a unique per-session user identifier for providing high quality DMP data for advertisers
 
 Add it to your Prebid.js package with:
 
-{: .alert.alert-info :}
+```bash
 gulp build --modules=userId,adtelligentIdSystem
+```
 
 ## Adtelligent Configuration
 

diff --git a/dev-docs/modules/userid-submodules/amxrtb.md b/dev-docs/modules/userid-submodules/amxrtb.md
@@ -3,6 +3,9 @@ layout: userid
 title: AMX ID
 description: AMX ID User ID sub-module
 useridmodule: amxIdSystem
+bidRequestUserId: amxId
+eidsource: amxdt.net
+example: '"3ca11058-..."'
 ---
 
 

diff --git a/dev-docs/modules/userid-submodules/audienceone.md b/dev-docs/modules/userid-submodules/audienceone.md
@@ -3,6 +3,9 @@ layout: userid
 title: AudienceOne ID by DAC
 description: AudienceOne ID by DAC User ID sub-module
 useridmodule: dacIdSystem
+bidRequestUserId: dacId
+eidsource: dac.co.jp
+example: {"id": "1111"}
 ---
 
 
@@ -11,12 +14,14 @@ Please visit [solutions.dac.co.jp/audienceone](https://solutions.dac.co.jp/audie
 
 Add the AudienceOne ID to your Prebid.js Package with:
 
-{: .alert.alert-info :}
+```bash
 gulp build --modules=dacIdSystem
+```
 
 ## AudienceOne ID Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of this module | `"dacId"` |

diff --git a/dev-docs/modules/userid-submodules/britepool.md b/dev-docs/modules/userid-submodules/britepool.md
@@ -4,6 +4,9 @@ title: BritePool
 description: BritePool User ID sub-module
 useridmodule: britepoolIdSystem
 enable_download: false
+bidRequestUserId: britepoolid
+eidsource: britepool.com
+example: '"1111"'
 ---
 
 {: .alert.alert-warning :}
@@ -14,8 +17,9 @@ integration partners (such as PubMatic), are able to maximize revenues without c
 
 Add it to your Prebid.js package with:
 
-{: .alert.alert-info :}
+```bash
 gulp build --modules=britepoolIdSystem
+```
 
 ## BritePool Registration
 
@@ -24,6 +28,7 @@ Please reach out to [[email protected]](mailto:[email protected]) and requ
 ## BritePool Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | `"britepoolId"` | `"britepoolId"` |

diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md
@@ -3,6 +3,9 @@ layout: userid
 title: CEEIdSystem
 description: CEEID User ID sub-module
 useridmodule: ceeIdSystem
+bidRequestUserId: ceeId
+eidsource: ceeid.eu
+example: '"1111"'
 ---
 
 ## Prebid Configuration
@@ -16,6 +19,7 @@ gulp build --modules=ceeIdSystem
 ## CEEID Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of CEEID user ID module. | `"ceeId"` |

diff --git a/dev-docs/modules/userid-submodules/cpexid.md b/dev-docs/modules/userid-submodules/cpexid.md
@@ -3,16 +3,21 @@ layout: userid
 title: Czech Ad ID (czechAdId)
 description: Czech Ad ID (czechAdId) User ID sub-module
 useridmodule: czechAdIdSystem
+bidRequestUserId: czechAdId
+eidsource: czechadid.cz
+example: '"1111"'
 ---
 
 Czech Ad ID is a joint project of publishers of the [CPEx alliance](https://www.cpex.cz/) and [Seznam.cz](https://www.seznam.cz). It is a deterministic user ID that offers cross-domain and cross-device identification. For more information see [czechadid.cz](https://www.czechadid.cz)).
 
-{: .alert.alert-info :}
+```bash
 gulp build --modules=czechAdIdSystem
+```
 
 ## czechAdId Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of this module | `"czechAdId"` |

diff --git a/dev-docs/modules/userid-submodules/criteo.md b/dev-docs/modules/userid-submodules/criteo.md
@@ -3,6 +3,9 @@ layout: userid
 title: Criteo ID for Exchanges
 description: Criteo ID for Exchanges User ID sub-module
 useridmodule: criteoIdSystem
+bidRequestUserId: criteoId
+eidsource: criteo.com
+example: '"1111"'
 ---
 
 
@@ -13,8 +16,9 @@ The Criteo privacy policy is at [www.criteo.com/privacy/](https://www.criteo.com
 
 Add it to your Prebid.js package with:
 
-{: .alert.alert-info :}
+```bash
 gulp build --modules=criteoIdSystem
+```
 
 ## Criteo ID Configuration
 

diff --git a/dev-docs/modules/userid-submodules/deepintent.md b/dev-docs/modules/userid-submodules/deepintent.md
@@ -3,6 +3,9 @@ layout: userid
 title: Deepintent
 description: Deepintent User ID sub-module
 useridmodule: deepintentDpesIdSystem
+bidRequestUserId: deepintentId
+eidsource: deepintent.com
+example: '"1111"'
 ---
 
 
@@ -17,6 +20,7 @@ DPES ID is free to use and requires a simple registration with DeepIntent. Pleas
 ## Deepintent DPES ID Configuration
 
 {: .table .table-bordered .table-striped }
+
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of this module: `"deepintentId"` | `"deepintentId"` |