Skip to content

Commit

Permalink
LiveIntent Rtd Provider: add doc (#5795)
Browse files Browse the repository at this point in the history
* update liveintent docs

* update liveintentRtdProvider doc
  • Loading branch information
wi101 authored Jan 17, 2025
1 parent dcca789 commit e95e09c
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 2 deletions.
55 changes: 55 additions & 0 deletions dev-docs/modules/liveIntentRtdProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
layout: page_v2
title: LiveIntent RTD Module
display_name: LiveIntent RTD Module
description: LiveIntent Real Time Data Module
page_type: module
module_type: rtd
module_code : liveIntentRtdProvider
enable_download : true
vendor_specific: true
sidebarType : 1
---

# LiveIntent RTD Module

{% include dev-docs/loads-external-javascript.md %}

The LiveIntent RTD module loads a script to extract segment information from bid requests.
These segments are resolved using the LiveIntent user ID module and are then supplied as user data segments in OpenRTB.

Please visit [LiveIntent](https://www.liveIntent.com/) for more information.

## Integration

1) Build the LiveIntent RTD Module into the Prebid.js package with:

```bash
gulp build --modules=rtdModule,liveIntentRtdProvider,...
```

2) Use `setConfig` to instruct Prebid.js to initialize the LiveIntent RTD module, as specified below.

## Configuration

```javascript
pbjs.setConfig({
realTimeData: {
auctionDelay: 1000,
dataProviders: [
{
name: "liveintent",
waitForIt: true
}
]
}
});
```

## Parameters

{: .table .table-bordered .table-striped }
| Name |Type | Description |Required | Notes |
| :--------------- | :------------ | :------------------------------------------------------------------ |:---------|:------------ |
| `name` | String | Real time data module name | yes | Always 'liveIntent' |
| `waitForIt` | Boolean | Should be `true` if there's an `auctionDelay` defined (recommended) | no | Default `false` |
9 changes: 7 additions & 2 deletions dev-docs/modules/userid-submodules/liveintent.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,12 @@ pbjs.setConfig({
### Multiple user IDs
The attributes `uid2`, `medianet`, `magnite`, `bidswitch`, `pubmatic`, `openx`, `sharethrough`, `sovrn`, `index`, `thetradedesk`, `vidazoo` and `fpid` are treated specially by LiveIntent's user ID sub-module. Each of these attributes will result in a separate ID returned by the sub-module. Note: `thetradedesk` will be exposed as `tdid` because of historical reasons.
The attributes `uid2`, `medianet`, `magnite`, `bidswitch`, `pubmatic`, `openx`, , `sharethrough`, `sovrn`, `index`, `thetradedesk`, `vidazoo` and `fpid` are treated specially by LiveIntent's user ID sub-module. Each of these attributes will result in a separate ID returned by the sub-module.

#### Note

* `thetradedesk` will be exposed as `tdid` because of historical reasons.
* In order for `segments` to be present in `ortb2.user.data` of the bid requests, you need to configure the [liveIntentRTDProvider](/dev-docs/modules/liveIntentRtdProvider.html) module.

For example, in case `uid2` is configured to be requested in addition to the `nonID`, the `request.userId` object would look like the following:

Expand Down Expand Up @@ -204,7 +209,7 @@ NOTE: For optimal performance, the LiveIntent ID sub-module should be called at
| params.ajaxTimeout |Optional| Number |This configuration parameter defines the maximum duration of a call to the `IdentityResolution` endpoint. By default, 5000 milliseconds.|`5000`|
| params.partner | Optional| String |The name of the partner whose data will be returned in the response.|`prebid`|
| params.identifiersToResolve |Optional| Array[String] |Used to send additional identifiers in the request for LiveIntent to resolve against the LiveIntent ID and additional attributes.|`['my-id']`|
| params.requestedAttributesOverrides | Optional | Object | Object containing booleans used to override the default resolution. Attributes set to `true` will be added to the resolved list, while attributes set to `false` will be removed. Valid attributes are `nonId`, `uid2`, `medianet`, `magnite`, `bidswitch`, `pubmatic`, `openx`, `sovrn`, `index`, `thetradedesk` (`tdid`), `sharethrough`, `vidazoo` and `fpid`. | `{'uid2': true}` |
| params.requestedAttributesOverrides | Optional | Object | Object containing booleans used to override the default resolution. Attributes set to `true` will be added to the resolved list, while attributes set to `false` will be removed. Valid attributes are `nonId`, `uid2`, `medianet`, `magnite`, `bidswitch`, `pubmatic`, `openx`, `sovrn`, `index`, `thetradedesk` (`tdid`), `sharethrough`, `vidazoo`, `segments` and `fpid`. | `{'uid2': true}` |
| params.emailHash |Optional| String |The hashed email address of a user. We can accept the hashes, which use the following hashing algorithms: md5, sha1, sha2.|`1a79a4d60de6718e8e5b326e338ae533`|
| params.url | Optional| String |Use this to change the default endpoint URL if you can call the LiveIntent Identity Exchange within your own domain.|`https://idx.my-domain.com`|
| params.liCollectConfig |Optional| Object |Container of all collector params.||
Expand Down

0 comments on commit e95e09c

Please sign in to comment.