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
Changes from 1 commit
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
61 changes: 61 additions & 0 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,67 @@ pbjs.setConfig({
});
{% endhighlight %}

### Deepintent DPES ID by Deepintent
The Deepintent DPES ID or Healthcare Identity is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The Deepintent DPES ID is designed to respect users' privacy choices and publishers’ preferences throughout the advertising value chain.
sourabhg marked this conversation as resolved.
Show resolved Hide resolved

#### Deepintent DPES ID Registration
The Deepintent DPES ID requires a simple registration with Deepintent. Please reach out to [[email protected]](mailto:[email protected]) to request.

#### 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"` |
| params | Required | Object | Details for the Deepinent DPES ID. | |
| params.siteId | Required | Number | This is the Deepintent site id obtained from registering with deepintent. | `10023` |
| params.identityKey | Required | String | This is identity type which healthcare identity will store by using healthcare identity module by deepintent it will be either "hashedEmail" or "hashedNPI" | `hashedEmai` |
| 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 **required** for storage type `"cookie"`. | `"_di"` |
| 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',
params: {
siteId: 173, // change to the siteId number to the one you recieved from Deepintent.
identityKey: "hashedEmail" // HashedEmail or HashedNPI based on type of your integration
},
storage: {
type: 'cookie', // "html5" is the required storage type option is "html5"
name: '_di', // change to the cookie name you wish to read from, optional if storage type is html5
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',
params: {
siteId: 173, // change to the siteId number to the one you recieved from Deepintent.
identityKey: "hashedEmail" // HashedEmail or HashedNPI based on type of your integration
},
storage: {
type: 'html5' // "html5" is the required storage type option is "html5"
}
}],
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