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

SemantIQ RTD Provider: initial release #5904

Merged
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
57 changes: 57 additions & 0 deletions dev-docs/modules/semantiqRtdProvider.md
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 |