Skip to content

Commit 6193d1e

Browse files
gregneuwogregneuwo
committed
docs: update documentation for url cleaning
Update module documentation to include: - URL cleaning configuration options and examples - Parameter table with stripAllQueryParams, stripQueryParamsForDomains, stripQueryParams, stripFragments - Update contact information
1 parent e735d5e commit 6193d1e

File tree

1 file changed

+68
-23
lines changed

1 file changed

+68
-23
lines changed

‎dev-docs/modules/neuwoRtdProvider.md‎

Lines changed: 68 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
layout: page_v2
33
title: Neuwo RTD Module
4-
display_name: Neuwo RTD Module
4+
display_name: Neuwo RTD Module
55
description: Enrich bids with contextual data from the Neuwo API.
66
page_type: module
77
module_type: rtd
8-
module_code : neuwoRtdProvider
9-
enable_download : true
10-
sidebarType : 1
8+
module_code: neuwoRtdProvider
9+
enable_download: true
10+
sidebarType: 1
1111
---
1212

1313
# Neuwo RTD Module
@@ -71,38 +71,83 @@ ortb2: {
7171
}
7272
```
7373

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/).
74+
To get started, you can generate your API token at [https://neuwo.ai/generatetoken/](https://neuwo.ai/generatetoken/), send us an email to [neuwo-helpdesk@neuwo.ai](mailto:neuwo-helpdesk@neuwo.ai) or [contact us here](https://neuwo.ai/contact-us/).
7575

7676
## Configuration
7777

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/).
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, send us an email to [neuwo-helpdesk@neuwo.ai](mailto:neuwo-helpdesk@neuwo.ai) or [contact us here](https://neuwo.ai/contact-us/).
7979
8080
This module is configured as part of the `realTimeData.dataProviders` object.
8181

8282
```javascript
8383
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-
}
84+
realTimeData: {
85+
auctionDelay: 500, // Value can be adjusted based on the needs
86+
dataProviders: [
87+
{
88+
name: "NeuwoRTDModule",
89+
waitForIt: true,
90+
params: {
91+
neuwoApiUrl: "<Your Neuwo Edge API Endpoint URL>",
92+
neuwoApiToken: "<Your Neuwo API Token>",
93+
iabContentTaxonomyVersion: "3.0",
94+
},
95+
},
96+
],
97+
},
9498
});
9599
```
96100

97101
**Parameters**
98102

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'`. |
103+
| Name | Type | Required | Default | Description |
104+
| :---------------------------------- | :------- | :------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
105+
| `name` | String | Yes | | The name of the module, which is `NeuwoRTDModule`. |
106+
| `params` | Object | Yes | | Container for module-specific parameters. |
107+
| `params.neuwoApiUrl` | String | Yes | | The endpoint URL for the Neuwo Edge API. |
108+
| `params.neuwoApiToken` | String | Yes | | Your unique API token provided by Neuwo. |
109+
| `params.iabContentTaxonomyVersion` | String | No | `'3.0'` | Specifies the version of the IAB Content Taxonomy to be used. Supported values: `'2.2'`, `'3.0'`. |
110+
| `params.stripAllQueryParams` | Boolean | No | `false` | If `true`, strips all query parameters from the URL before analysis. Takes precedence over other stripping options. |
111+
| `params.stripQueryParamsForDomains` | String[] | No | `[]` | List of domains for which to strip **all** query parameters. When a domain matches, all query params are removed for that domain and all its subdomains (e.g., `'example.com'` strips params for both `'example.com'` and `'sub.example.com'`). This option takes precedence over `stripQueryParams` for matching domains. |
112+
| `params.stripQueryParams` | String[] | No | `[]` | List of specific query parameter names to strip from the URL (e.g., `['utm_source', 'fbclid']`). Other parameters are preserved. Only applies when the domain does not match `stripQueryParamsForDomains`. |
113+
| `params.stripFragments` | Boolean | No | `false` | If `true`, strips URL fragments (hash, e.g., `#section`) from the URL before analysis. |
114+
115+
### URL Cleaning Options
116+
117+
The module provides optional URL cleaning capabilities to strip query parameters and/or fragments from the analyzed URL before sending it to the Neuwo API. This can be useful for privacy, caching, or analytics purposes.
118+
119+
**Example with URL cleaning:**
120+
121+
```javascript
122+
pbjs.setConfig({
123+
realTimeData: {
124+
auctionDelay: 500, // Value can be adjusted based on the needs
125+
dataProviders: [
126+
{
127+
name: "NeuwoRTDModule",
128+
waitForIt: true,
129+
params: {
130+
neuwoApiUrl: "<Your Neuwo Edge API Endpoint URL>",
131+
neuwoApiToken: "<Your Neuwo API Token>",
132+
iabContentTaxonomyVersion: "3.0",
133+
134+
// Option 1: Strip all query parameters from the URL
135+
stripAllQueryParams: true,
136+
137+
// Option 2: Strip all query parameters only for specific domains
138+
// stripQueryParamsForDomains: ['example.com', 'another-domain.com'],
139+
140+
// Option 3: Strip specific query parameters by name
141+
// stripQueryParams: ['utm_source', 'utm_campaign', 'fbclid'],
142+
143+
// Optional: Strip URL fragments (hash)
144+
stripFragments: true,
145+
},
146+
},
147+
],
148+
},
149+
});
150+
```
106151

107152
## Installation
108153

0 commit comments

Comments
 (0)