Hadrn 1004 (#5693)

* Fix `modulecode` for the ATS analytics adapter (#3756) * updating the documentation to follow the main repo * shorting the hadronId shown in the table --------- Co-authored-by: Demetrio Girardi <[email protected]>
prebid · Nov 20, 2024 · 8d1de54 · 8d1de54
1 parent 9598da0
commit 8d1de54
Showing 1 changed file with 12 additions and 9 deletions.
diff --git a/dev-docs/modules/userid-submodules/hadron.md b/dev-docs/modules/userid-submodules/hadron.md
@@ -27,7 +27,7 @@ pbjs.setConfig({
                 type: 'html5'
             },
             params: {
-                partnerId: 1234
+                partnerId: 1234   // change it to the Partner ID you got from Audigent
             }
         }]
     }
@@ -38,17 +38,20 @@ The `request.userId.hadronId` will contain the Audigent HadronId:
 
 ```json
 {
-  "hadronId": "0201chpvai07jv2yg08xizqr0bwpa1w0evvmq014d2ykn0b5oe"
+  "hadronId": "0aRSTUAackg79ijgd8e8j6kah9ed9j6hdfgb6cl00volopxo00npzjmmb"
 }
 ```
 
 The following configuration parameters are available:
 
 {: .table .table-bordered .table-striped }
-| Param under usersync.userIds[] | Scope | Type | Description | Example |
-| --- | --- | --- | --- | --- |
-| name | Required | String | ID value for the HadronID module - `"hadronId"` | `"hadronId"` |
-| params | Optional | Object | Used to store params for the HadronId system |
-| params.url | Optional | String | Set an alternate GET url for HadronId with this parameter |
-| params.urlArg | Optional | Object | Optional url parameter for params.url |
-| params.partnerId | Required | Number | This is the Audigent Partner ID obtained from Audigent. |
+| Param under usersync.userIds[] | Scope    | Type    | Description                                                                                                                                                                                                                 | Example                                     |
+|--------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
+| name                           | Required | String  | ID value for the HadronID module - `"hadronId"`                                                                                                                                                                             | `"hadronId"`                                |
+| 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 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. The recommended value is `hadronId`.                                                                                                        | `"auHadronId"`                              |
+| storage.expires                | Optional | Integer | How long (in days) the user ID information will be stored. The recommended value is 14 days.                                                                                                                                | `14`                                        |
+| value                          | Optional | Object  | Used only if the page has a separate mechanism for storing the Hadron 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 | `{"hadronId": "0a..mb"}`                    |
+| params                         | Optional | Object  | Used to store params for the id system                                                                                                                                                                                      |                                             |
+| params.partnerId               | Required | Number  | This is the Audigent Partner ID obtained from Audigent.                                                                                                                                                                     | `1234`                                      |