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

adtelligentIdSytem doc update #3032

Merged
merged 10 commits into from
Aug 4, 2021
46 changes: 45 additions & 1 deletion dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ of sub-objects. The table below has the options that are common across ID system
{: .table .table-bordered .table-striped }
| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | May be: `"admixerId"`, `"amxId"`, `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"flocId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"mwOpenLinkId"`, `"netId"`, `"novatiqId"`, `"parrableId"`, `"quantcastId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`,`"uid2"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"`
| name | Required | String | May be: `"admixerId"`, `"adtelligentId"`, `"amxId"`, `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"flocId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"mwOpenLinkId"`, `"netId"`, `"novatiqId"`, `"parrableId"`, `"quantcastId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`,`"uid2"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"`
| params | Based on User ID sub-module | Object | | |
| bidders | Optional | Array of Strings | An array of bidder codes to which this user ID may be sent. | `['bidderA', 'bidderB']` |
| storage | Optional | Object | The publisher can specify some kind of local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. This is not needed when `value` is specified or the ID system is managing its own storage | |
Expand Down Expand Up @@ -186,6 +186,49 @@ gulp build --modules=admixerIdSystem
});
{% endhighlight %}

### Adtelligent

The [Adtelligent](https://adtelligent.com) ID system is a uniq per-session user identifier for providing high quality DMP data for advertisers

Add it to your Prebid.js package with:

{: .alert.alert-info :}
gulp build --modules=userId,adtelligentIdSystem

#### Adtelligent Configuration

adtelligentIdSystem adapter doesn't require any configuration or storage params. The adapter performs asynchronously and to achieve better performance it is recommended to set the `storage` object `refreshInSeconds` to a short period, such as ten minutes. At the end of the set storage refresh the adapter will refresh its configuration.

#### Adtelligent Example

{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [{
name: 'adtelligent'
}]
}
});
{% endhighlight %}

Example with a short storage for ~10 minutes and refresh in 5 minutes:

{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [{
name: 'adtelligent',
storage: {
type: "html5",
name: "adt_id",
expires:0.003,
refreshInSeconds: 60 * 5
}
}]
}
});
{% endhighlight %}

### BritePool

The [BritePool](https://britepool.com) ID is a persistent identifier that enables identity resolution for people-based marketing in the cookieless world. Every BritePool ID is associated with a real identity. As a result, publishers, SSPs and DSPs that integrate with BritePool, or automated
Expand Down Expand Up @@ -1733,6 +1776,7 @@ Bidders that want to support the User ID module in Prebid.js, need to update the
| ID System Name | ID System Host | Prebid.js Attr: bidRequest.userId. | EID Source | Example Value |
| --- | --- | --- | --- | --- | --- | --- |
| Admixer ID | Admixer | admixerId | admixer.net | "1111" |
| Adtelligent ID | Adtelligent | bidRequest.userId.adtelligentId | `"1111"` |
| AMX RTB ID | AMX RTB | amxId | amxrtb.com | "3ca11058-..." |
| BritePool ID | BritePool | britepoolid | britepool.com | "1111" |
| DeepIntent ID | Deep Intent | deepintentId | deepintent.com | "1111" |
Expand Down