-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
LiveIntent Rtd Provider: add doc (#5795)
* update liveintent docs * update liveintentRtdProvider doc
- Loading branch information
Showing
2 changed files
with
62 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters