Skip to content

Commit a5362e1

Browse files
gregneuwogregneuwo
authored
docs: Update Neuwo RTD module documentation to reflect new API support (prebid#6294)
1 parent 4853a83 commit a5362e1

File tree

1 file changed

+90
-26
lines changed

1 file changed

+90
-26
lines changed

‎dev-docs/modules/neuwoRtdProvider.md‎

Lines changed: 90 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,121 @@
11
---
22
layout: page_v2
3-
title: Neuwo Real-Time Data Module
4-
display_name: Neuwo Real-Time Data Module
5-
description: Enrich bids using neuwo.ai
3+
title: Neuwo RTD Module
4+
display_name: Neuwo RTD Module
5+
description: Enrich bids with contextual data from the Neuwo API.
66
page_type: module
77
module_type: rtd
88
module_code : neuwoRtdProvider
99
enable_download : true
1010
sidebarType : 1
1111
---
1212

13-
# Neuwo Real-Time Data Module
13+
# Neuwo RTD Module
1414

1515
## Overview
1616

17-
The Neuwo AI RTD module is an advanced AI solution for real-time data processing in the field of contextual targeting and advertising. With its cutting-edge algorithms, it allows advertisers to target their audiences with the highest level of precision based on context, while also delivering a seamless user experience.
17+
The Neuwo RTD provider fetches real-time contextual data from the Neuwo API. When installed, the module retrieves IAB content and audience categories relevant to the current page's content.
1818

19-
The module provides advertisers with valuable insights and real-time contextual bidding capabilities. Whether you're a seasoned advertising professional or just starting out, Neuwo AI RTD module is the ultimate tool for contextual targeting and advertising.
19+
This data is then added to the bid request by populating the OpenRTB 2.x objects `ortb2.site.content.data` (for IAB Content Taxonomy) and `ortb2.user.data` (for IAB Audience Taxonomy). This enrichment allows bidders to leverage Neuwo's contextual analysis for more precise targeting and decision-making.
2020

21-
The benefit of Neuwo AI RTD module is that it provides an alternative solution for advertisers to target their audiences and deliver relevant advertisements, as the widespread use of cookies for tracking and targeting is becoming increasingly limited.
21+
Here is an example scheme of the data injected into the `ortb2` object by our module:
2222

23-
The RTD module uses cutting-edge algorithms to process real-time data, allowing advertisers to target their audiences based on contextual information, such as segments, IAB Tiers and brand safety. The RTD module is designed to be flexible and scalable, making it an ideal solution for advertisers looking to stay ahead of the curve in the post-cookie era.
23+
```javascript
24+
ortb2: {
25+
site: {
26+
content: {
27+
// IAB Content Taxonomy data is injected here
28+
data: [{
29+
name: "www.neuwo.ai",
30+
segment: [{
31+
id: "274",
32+
name: "Home & Garden",
33+
},
34+
{
35+
id: "42",
36+
name: "Books and Literature",
37+
},
38+
{
39+
id: "210",
40+
name: "Food & Drink",
41+
},
42+
],
43+
ext: {
44+
segtax: 7,
45+
},
46+
}, ],
47+
},
48+
},
49+
user: {
50+
// IAB Audience Taxonomy data is injected here
51+
data: [{
52+
name: "www.neuwo.ai",
53+
segment: [{
54+
id: "49",
55+
name: "Demographic | Gender | Female |",
56+
},
57+
{
58+
id: "161",
59+
name: "Demographic | Marital Status | Married |",
60+
},
61+
{
62+
id: "6",
63+
name: "Demographic | Age Range | 30-34 |",
64+
},
65+
],
66+
ext: {
67+
segtax: 4,
68+
},
69+
}, ],
70+
},
71+
}
72+
```
2473

25-
Generate your token at: [neuwo.ai/generatetoken/]
74+
To get started, you can generate your API token at [https://neuwo.ai/generatetoken/](https://neuwo.ai/generatetoken/) or [contact us here](https://neuwo.ai/contact-us/).
2675

2776
## Configuration
2877

29-
| Name | Scope | Description | Example | Type |
30-
|------------|----------|----------------------------------------|---------------|----------|
31-
| `name` | required | Handle of the module used in real-time data providers; for this, use 'NeuwoRTDModule' | 'NeuwoRTDModule' | static |
32-
| `params.publicToken` | required | Your neuwo.ai public token | `neu23-te45-idkf-44aa` (format example) | `string` |
33-
| `params.apiUrl` | required | Your neuwo.ai API url | `https://some-api-url.neuwo.ai/a/b/c` (format example) | `string` |
78+
> **Important:** You must add the domain (origin) where Prebid.js is running to the list of allowed origins in Neuwo Edge API configuration. If you have problems, [contact us here](https://neuwo.ai/contact-us/).
79+
80+
This module is configured as part of the `realTimeData.dataProviders` object.
3481

3582
```javascript
36-
const neuwoDataProvider = {
37-
name: 'NeuwoRTDModule',
38-
params: {
39-
publicToken: '<public token here>',
40-
apiUrl: '<api url here>'
41-
}
42-
}
43-
pbjs.setConfig({realTimeData: { dataProviders: [ neuwoDataProvider ]}})
83+
pbjs.setConfig({
84+
realTimeData: {
85+
dataProviders: [{
86+
name: 'NeuwoRTDModule',
87+
params: {
88+
neuwoApiUrl: '<Your Neuwo Edge API Endpoint URL>',
89+
neuwoApiToken: '<Your Neuwo API Token>',
90+
iabContentTaxonomyVersion: '3.0',
91+
}
92+
}]
93+
}
94+
});
4495
```
4596

97+
**Parameters**
98+
99+
| Name | Type | Required | Default | Description |
100+
| :--------------------------------- | :----- | :------- | :------ | :------------------------------------------------------------------------------------------------ |
101+
| `name` | String | Yes | | The name of the module, which is `NeuwoRTDModule`. |
102+
| `params` | Object | Yes | | Container for module-specific parameters. |
103+
| `params.neuwoApiUrl` | String | Yes | | The endpoint URL for the Neuwo Edge API. |
104+
| `params.neuwoApiToken` | String | Yes | | Your unique API token provided by Neuwo. |
105+
| `params.iabContentTaxonomyVersion` | String | No | `'3.0'` | Specifies the version of the IAB Content Taxonomy to be used. Supported values: `'2.2'`, `'3.0'`. |
106+
46107
## Installation
47108

48109
### Step 1: Install Prebid.js
49110

50-
- Option 1: Use Prebid [Download](/download.html) page to build the Prebid.js package
51-
- Include Neuwo Real-Time Data Module
111+
#### Option 1
112+
113+
Use Prebid [Download](https://docs.prebid.org/download.html) page to build the Prebid.js package and include Neuwo RTD Module
114+
115+
#### Option 2
52116

53-
- Option 2: Include `neuwoRtdProvider` in build: `gulp build --modules=rtdModule,neuwoRtdProvider,...`
117+
Include `neuwoRtdProvider` in build: `gulp build --modules=rtdModule,neuwoRtdProvider,...`
54118

55119
### Step 2: Set configuration
56120

57-
Enable Neuwo Real-Time Data Module using `pbjs.setConfig` in a related Javascript context. Command example is provided in Configuration section.
121+
Enable Neuwo Real-Time Data Module using `pbjs.setConfig` in a related Javascript context. Command example is provided in [Configuration](#configuration) section.

0 commit comments

Comments
 (0)