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

User id intentiq update #2889

Merged
merged 3 commits into from
Apr 29, 2021
Merged
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: 35 additions & 17 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -585,22 +585,35 @@ pbjs.setConfig({
});
{% endhighlight %}

### IntentIQ ID
### Intent IQ ID

Intent IQ’s universal ID with its unparalleled coverage of over 80% of ad inventory, protects publishers’ ability to rely on advertising as their main revenue source while preserving user privacy in a third party cookieless world.

The universal ID is an Intent IQ generated alphanumeric characters ID representing a person. This ID is not matched with personal information and remains anonymous to Intent IQ.

Intent IQ universal ID enables partners - publishers, SSPs, DSPs, DMPs and advertisers to support, in a privacy-friendly way, and on a person level, core elements of the advertising business model -

- Targeting across sites and devices
- Frequency capping
- Attribution measurement across sites and devices

Intent IQ's universal ID works across IP addresses and user-agent changes.

Intent IQ's universal ID truly stands out in the coverage and accuracy it provides. Intent IQ's universal ID covers over 80% of ad inventory with 90% accuracy. By contrast, third-party cookies offer 56% coverage and log-in solutions offer coverage of less than 20%.

The IntentIQ ID solution is provided by intentiq.com.

Add it to your Prebid.js package with:

{: .alert.alert-info :}
gulp build --modules=intentIqIdSystem

#### IntentIQ ID Registration
#### Intent IQ ID Registration

You can set up IntentIQ ID by contacting our operations team at [IntentIQ Contact Us] (https://www.intentiq.com/contact-us) and getting your partner id.
You can set up Intent IQ ID by contacting our operations team at [Intent IQ Contact Us] (https://www.intentiq.com/contact-us) and getting your partner id.

The IntentIQ ID privacy is covered under the [IntentIQ Privacy Policy](https://www.intentiq.com/technology-privacy-policy).
The Intent IQ ID privacy is covered under the [Intent IQ Privacy Policy](https://www.intentiq.com/technology-privacy-policy).

#### IntentIQ ID Configuration
#### Intent IQ ID Configuration

{: .table .table-bordered .table-striped }
| Param under userSync.userIds[] | Scope | Type | Description | Example |
Expand All @@ -611,9 +624,12 @@ The IntentIQ ID privacy is covered under the [IntentIQ Privacy Policy](https://w
| params.pcid | Optional | String | This is the partner cookie ID, it is a dynamic value attached to the request. | `"g3hC52b"` |
| params.pai | Optional | String | This is the partner customer ID / advertiser ID, it is a dynamic value attached to the request. | `"advertiser1"` |

#### IntentIQ ID Examples
{: .alert.alert-info :}
**NOTE:** The Intent IQ ID is encrypted with a key that changes every several hours. Demand partners utilize the latest key to decrypt the ID and use it. Therefore, to enable demand partners have an ID they can use, we highly recommend calling Intent IQ every 4 hours by setting storage.refreshInSeconds to 4 hours (4*3600 seconds)

#### Intent IQ ID Examples

1) Publisher has a partner ID from IntentIQ and cookies.
1) Publisher has a partner ID from Intent IQ and cookies.

{: .alert.alert-warning :}
{% highlight javascript %}
Expand All @@ -622,33 +638,35 @@ pbjs.setConfig({
userIds: [{
name: "intentIqId",
params: {
partner: 123456 // valid partner id
partner: 123456 // valid partner id
},
storage: {
type: "cookie",
name: "intentIqId", // create a cookie with this name
expires: 60 // cookie can last for 60 days
}
name: "intentIqId", // create a cookie with this name
expires: 60, // cookie can last for 60 days
refreshInSeconds: 4*3600 // refresh ID every 4 hours to ensure it's fresh
}
}],
syncDelay: 3000 // 3 seconds after the first auction
}
});
{% endhighlight %}

2) Publisher supports IntentIQ and HTML5 local storage.
2) Publisher supports Intent IQ and HTML5 local storage.

{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [{
name: "intentIqId",
params: {
partner: 123456 // valid partner id
partner: 123456 // valid partner id
},
storage: {
type: "html5",
name: "intentIqId", // set localstorage with this name
expires: 60
name: "intentIqId", // set localstorage with this name
expires: 60,
refreshInSeconds: 4*3600 // refresh ID every 4 hours to ensure it's fresh
}
}],
syncDelay: 3000
Expand Down Expand Up @@ -1588,7 +1606,7 @@ Bidders that want to support the User ID module in Prebid.js, need to update the
| ID+ | Zeotap | bidRequest.userId.IDP | `"1111"` |
| ID5 ID | ID5 | bidRequest.userId.id5id | `{ uid: "1111", ext: { linkType: 2, abTestingControlGroup: false } }` |
| IdentityLink | Trade Desk | bidRequest.userId.idl_env | `"1111"` |
| IntentIQ ID | IntentIQ | bidRequest.userId.intentiqid | `"1111"` |
| Intent IQ ID | Intent IQ | bidRequest.userId.intentiqid | `"1111"` |
| LiveIntent ID | Live Intent | bidRequest.userId.lipb.lipbid | `"1111"` |
| Lotame Panorama ID | Lotame | bidRequest.userId.lotamePanoramaId | `"e4b96a3d9a8e8761cef5656fb05f16d53938069f1684df4b2257e276e8b89a0e"` |
| merkleID | Merkle | bidRequest.userId.merkleId | `"1111"` |
Expand Down