You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev-docs/modules/neuwoRtdProvider.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,6 +91,7 @@ pbjs.setConfig({
91
91
neuwoApiUrl:"<Your Neuwo Edge API Endpoint URL>",
92
92
neuwoApiToken:"<Your Neuwo API Token>",
93
93
iabContentTaxonomyVersion:"3.0",
94
+
enableCache:true, // Default: true. Caches API responses to avoid redundant requests
94
95
},
95
96
},
96
97
],
@@ -107,14 +108,19 @@ pbjs.setConfig({
107
108
|`params.neuwoApiUrl`| String | Yes || The endpoint URL for the Neuwo Edge API. |
108
109
|`params.neuwoApiToken`| String | Yes || Your unique API token provided by Neuwo. |
109
110
|`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. |
110
112
|`params.stripAllQueryParams`| Boolean | No |`false`| If `true`, strips all query parameters from the URL before analysis. Takes precedence over other stripping options. |
111
113
|`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
114
|`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
115
|`params.stripFragments`| Boolean | No |`false`| If `true`, strips URL fragments (hash, e.g., `#section`) from the URL before analysis. |
114
116
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
+
115
121
### URL Cleaning Options
116
122
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.
0 commit comments