Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added The Newco userId module - TNCID documentation #5703

Merged
merged 10 commits into from
Nov 19, 2024
34 changes: 27 additions & 7 deletions dev-docs/modules/userid-submodules/tncIdSystem.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# TNCID UserID Module
---
layout: userid
title: TNCID by The Newco
description: TNCID UserID sub-module
useridmodule: tncIdSystem
annavane marked this conversation as resolved.
Show resolved Hide resolved
bidRequestUserId: tncId
eidsource: thenewco.it
example: '"1111"'
---

TNCID is a shared persistent identifier that improves user recognition compared to both third-party and first-party cookies. This enhanced identification capability enables publishers and advertisers to consistently recognize their audiences, leading to improved monetization and more precise targeting. The Newco User ID sub-module adds powerful TNCID user identification technology to your Prebid.js bidstream.
For more details, visit our <a href="https://www.thenewco.tech">website</a> and contact us to request your publisher-id and the on-page tag.

## Prebid Configuration

Expand All @@ -8,7 +19,7 @@ First, make sure to add the TNCID submodule to your Prebid.js package with:
gulp build --modules=tncIdSystem,userId
```

## TNCIDIdSystem module Configuration
## TNCIdSystem module Configuration

Disclosure: This module loads external script unreviewed by the prebid.js community

Expand All @@ -20,7 +31,12 @@ pbjs.setConfig({
userIds: [{
name: 'tncId',
params: {
url: 'https://js.tncid.app/remote.min.js' //Optional
url: 'TNC-fallback-script-url' // Fallback url, not required if onpage tag is present (ask TNC for it)
},
storage: {
type: "cookie",
name: "tncid",
expires: 365 // in days
}
}],
syncDelay: 5000
Expand All @@ -30,7 +46,11 @@ pbjs.setConfig({

## Configuration Params

| Param Name | Required | Type | Description |
| --- | --- | --- | --- |
| name | Required | String | ID value for the TNCID module: `"tncId"` |
| params.url | Optional | String | Provide TNC fallback script URL, this script is loaded if there is no TNC script on page |
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 | `"tncId"` |
| params ||| Details for the sub-module initialization ||
| params.url | Required | String | TNC script fallback URL - This script is loaded if there is no TNC script on page | `"https://js.tncid.app/remote.min.js"` |