Skip to content

Commit 87123e7

Browse files
committed
Neuwo RTD Module docs: add caching documentation
1 parent 163ac2b commit 87123e7

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

dev-docs/modules/neuwoRtdProvider.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ pbjs.setConfig({
9191
neuwoApiUrl: "<Your Neuwo Edge API Endpoint URL>",
9292
neuwoApiToken: "<Your Neuwo API Token>",
9393
iabContentTaxonomyVersion: "3.0",
94+
enableCache: true, // Default: true. Caches API responses to avoid redundant requests
9495
},
9596
},
9697
],
@@ -107,14 +108,19 @@ pbjs.setConfig({
107108
| `params.neuwoApiUrl` | String | Yes | | The endpoint URL for the Neuwo Edge API. |
108109
| `params.neuwoApiToken` | String | Yes | | Your unique API token provided by Neuwo. |
109110
| `params.iabContentTaxonomyVersion` | String | No | `'3.0'` | Specifies the version of the IAB Content Taxonomy to be used. Supported values: `'2.2'`, `'3.0'`. |
111+
| `params.enableCache` | Boolean | No | `true` | If `true`, caches API responses to avoid redundant requests for the same page during the session. Set to `false` to disable caching and make a fresh API call on every bid request. |
110112
| `params.stripAllQueryParams` | Boolean | No | `false` | If `true`, strips all query parameters from the URL before analysis. Takes precedence over other stripping options. |
111113
| `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. |
112114
| `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`. |
113115
| `params.stripFragments` | Boolean | No | `false` | If `true`, strips URL fragments (hash, e.g., `#section`) from the URL before analysis. |
114116

117+
### API Response Caching
118+
119+
By default, the module caches API responses during the page session to optimise performance and reduce redundant API calls. This behaviour can be disabled by setting `enableCache: false` if needed for dynamic content scenarios.
120+
115121
### URL Cleaning Options
116122

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.
123+
The module provides optional URL cleaning capabilities to strip query parameters and/or fragments from the analysed URL before sending it to the Neuwo API. This can be useful for privacy, caching, or analytics purposes.
118124

119125
**Example with URL cleaning:**
120126

0 commit comments

Comments
 (0)