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

deepintent docs added #2830

Merged
merged 3 commits into from
Apr 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,58 @@ pbjs.setConfig({
});
{% endhighlight %}

### Deepintent DPES ID by Deepintent
The Deepintent Id is a shared, healthcare identifier which helps publisher in absence of the 3rd Party cookie matching. This lets publishers set and bid with healthcare identity . Deepintent lets users protect their privacy through advertising value chain, where Healthcare identity when setting the identity takes in consideration of users choices, as well as when passing identity on the cookie itself privacy consent strings are checked. The healthcare identity when set is not stored on Deepintent's servers but is stored on users browsers itself. User can still opt out of the ads by https://option.deepintent.com/adchoices

#### Deepintent DPES ID Registration
The Deepintent DPES ID is free to use, but requires a simple registration with Deepintent. Please reach to [email protected] to get started.
Once publisher registers with deepintents platform for healthcare identity Deepintent provides the Tag code to be placed on the page, this tag code works to capture and store information as per publishers and users agreement. DPES User ID module uses this stored id and passes it on the deepintent prebid adapter.

#### 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"` |
| storage | Required | Object | Storage settings for how the User Id module will cache the Deepintent ID locally | |
| storage.type | Required | String | This is where the results of the user ID will be stored. Deepintent`"html5"` or `"cookie"`. | `"html5"` |
| storage.name | Optional | String | The name of the local storage where the user ID will be stored. Deepintent | `"_dpes_id"` |
| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. Deepintent recommends `90`. | `90` |

#### Deepintent DPES ID Examples
1) Publisher stores the hashed identity from healthcare identity in cookie
{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [{
name: 'deepintentId',
storage: {
type: 'cookie', // "html5" is the required storage type option is "html5"
name: '_dpes_id',
expires: 90 // storage lasts for 90 days, optional if storage type is html5
}
}],
auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules
}
});
{% endhighlight %}

2) Publisher stores the hashed identity from healthcare identity in localstorage
{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [{
name: 'deepintentId',
storage: {
type: 'html5' // "html5" is the required storage type option is "html5"
name: '_dpes_id'
}
}],
auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules
}
});
{% endhighlight %}


### Fabrick ID by Neustar

[Neustar Fabrick™](https://www.home.neustar/fabrick) is a unified identity ecosystem that powers connections between brands, publishers, and consumers to accelerate marketing performance across online and offline channels.
Expand Down
3 changes: 3 additions & 0 deletions download.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,9 @@ Prebid.js is open source software that is offered for free as a convenience. Whi
<label><input type="checkbox" moduleCode="criteoIdSystem" class="bidder-check-box"> Criteo ID</label>
</div></div>
<div class="col-md-4"><div class="checkbox">
<label><input type="checkbox" moduleCode="deepintentDpesIdSystem" class="bidder-check-box"> Deepintent DPES ID</label>
</div></div>
<div class="col-md-4"><div class="checkbox">
<label><input type="checkbox" moduleCode="fabrickIdSystem" class="bidder-check-box"> Neustar Fabrick ID</label>
</div></div>
<div class="col-md-4"><div class="checkbox">
Expand Down