-
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.
SemantIQ RTD Provider: initial release (#5904)
- Loading branch information
1 parent
7fdc856
commit 0777625
Showing
1 changed file
with
57 additions
and
0 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,57 @@ | ||
--- | ||
layout: page_v2 | ||
title: SemantIQ RTD module | ||
display_name : SemantIQ | ||
description: SemantIQ RTD module allows to retrieve real-time data from the SemantIQ service. | ||
page_type: module | ||
module_type: rtd | ||
module_code: semantiqRtdProvider | ||
enable_download: true | ||
sidebarType: 1 | ||
vendor_specific: true | ||
|
||
--- | ||
|
||
# Semantiq Rtd Provider | ||
|
||
## Description | ||
|
||
This module retrieves real-time data from the SemantIQ service and populates ORTB data. | ||
|
||
You need to obtain a company ID from [Audienzz](https://audienzz.com) for the module to function properly. Contact [[email protected]](mailto:[email protected]) for details. | ||
|
||
## Integration | ||
|
||
1. Include the module into your `Prebid.js` build. | ||
|
||
```sh | ||
gulp build --modules='rtdModule,semantiqRtdProvider,...' | ||
``` | ||
|
||
1. Configure the module via `pbjs.setConfig`. | ||
|
||
```js | ||
pbjs.setConfig({ | ||
... | ||
realTimeData: { | ||
dataProviders: [ | ||
{ | ||
name: 'semantiq', | ||
waitForIt: true, | ||
params: { | ||
companyId: 12345, | ||
timeout: 1000, | ||
}, | ||
}, | ||
], | ||
}, | ||
}); | ||
``` | ||
|
||
## Parameters | ||
|
||
{: .table .table-bordered .table-striped } | ||
|Name |Required|Description |Type |Default value|Example | | ||
|---------+--------+------------------------------------------------------------+--------+-------------+---------------------| | ||
|companyId|No |Company ID obtained from [Audienzz](https://audienzz.com). |number \| number[] |- |12345 | | ||
|timeout |No |The maximum time to wait for a response in milliseconds. |number |1000 |3000 | |