diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 92cb9fc8a3..9219b7950c 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -1417,6 +1417,14 @@ 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` | +| 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"` | +| params.useCallbacks | Optional | Boolean | Use callbacks for custom integrations | `false` | +| params.urlParams | Optional | Object | Sync URl configuration for custom integrations | | +| params.urlParams.novatiqId | Optional | String | The name of the parameter used to indicate the Novatiq ID uuid | `snowflake` | +| params.urlParams.useStandardUuid | Optional | Boolean | Use a standard UUID format, or the Novatiq UUID format | `false` | +| params.urlParams.useSspId | Optional | Boolean | Send the sspid (sourceid) along with the sync request
Makes the params.sourceid optional if set | `false` | +| params.urlParams.useSspHost | Optional | Boolean | Send the ssphost along with the sync request | `false` | {: .table .table-bordered .table-striped } @@ -1470,32 +1478,6 @@ pbjs.setConfig({ }); {% 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 | 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 } -
- -#### 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` | -{: .table .table-bordered .table-striped } -
If you have any questions, please reach out to us at [prebid@novatiq.com](mailto:prebid@novatiq.com)