Intent IQ Analytics Adapter: Support domainName parameter (#5701)

* update documentation * White space fixes * Apply suggestions from code review Co-authored-by: bretg <[email protected]> * Add example and link to Universal ID configuration * Support domainName parameter --------- Co-authored-by: DimaIntentIQ <[email protected]> Co-authored-by: DimaIntentIQ <[email protected]> Co-authored-by: bretg <[email protected]>
prebid · Dec 12, 2024 · 60be8ab · 60be8ab
1 parent 9c2625f
commit 60be8ab
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md
@@ -45,6 +45,7 @@ Please find below list of parameters that could be used in configuring Intent IQ
 | params.timeoutInMillis         | Optional | Number   | This is the timeout in milliseconds, which defines the maximum duration before the callback is triggered. The default value is 500.                                                                                                                                                                                                       | `450`                                         |
 | params.browserBlackList        | Optional |  String  | This is the name of a browser that can be added to a blacklist.                                                                                                                                                                                                                                                                           | `"chrome"`                                    |
 | params.manualWinReportEnabled  | Optional | Boolean  | This variable determines whether the bidWon event is triggered automatically. If set to false, the event will occur automatically, and manual reporting with reportExternalWin will be disabled. If set to true, the event will not occur automatically, allowing manual reporting through reportExternalWin. The default value is false. | `true`|
+| params.domainName              | Optional | String   | Specifies the domain of the page in which the IntentIQ object is currently running and serving the impression. This domain will be used later in the revenue reporting breakdown by domain. For example, cnn.com. It identifies the primary source of requests to the IntentIQ servers, even within nested web pages.                     | `"currentDomain.com"`                         |
 
 ### Configuration example
 
@@ -58,7 +59,8 @@ pbjs.setConfig({
                 timeoutInMillis: 500,
                 browserBlackList: "chrome",
                 callback: (data, group) => window.pbjs.requestBids(),
-                manualWinReportEnabled: true
+                manualWinReportEnabled: true,
+                domainName: "currentDomain.com"
             },
             storage: {
                 type: "html5",