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/analytics/intentiq.md
+17-19Lines changed: 17 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,13 +17,28 @@ No registration for this module is required.
17
17
18
18
**IMPORTANT**: only effective when Intent IQ Universal ID module be installed and configured. [(How-To)](https://docs.prebid.org/dev-docs/modules/userid-submodules/intentiq.html)
19
19
20
-
No additional configuration for this module is required. We will use the configuration provided for Intent IQ Universal IQ module.
20
+
### Analytics Options
21
+
22
+
{: .table .table-bordered .table-striped }
23
+
| Parameter | Scope | Type | Description | Example |
24
+
| --- | --- | --- | --- | --- |
25
+
| options.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. |`false`|
26
+
| options.reportMethod | Optional | String | Defines the HTTP method used to send the analytics report. If set to `"POST"`, the report payload will be sent in the body of the request. If set to `"GET"` (default), the payload will be included as a query parameter in the request URL. |`"GET"`|
27
+
| options.reportingServerAddress | Optional | String | The base URL for the IntentIQ reporting server. If parameter is provided in `configParams`, it will be used. |`"https://domain.com"`|
28
+
| options.adUnitConfig | Optional | Number | Determines how the `placementId` parameter is extracted in the report (default is 1). Possible values: 1 – adUnitCode first, 2 – placementId first, 3 – only adUnitCode, 4 – only placementId. |`1`|
29
+
| options.gamPredictReporting | Optional | Boolean | This variable controls whether the GAM prediction logic is enabled or disabled. The main purpose of this logic is to extract information from a rendered GAM slot when no Prebid bidWon event is available. In that case, we take the highest CPM from the current auction and add 0.01 to that value. |`false`|
21
30
22
31
#### Example Configuration
23
32
24
33
```js
25
34
pbjs.enableAnalytics({
26
-
provider:'iiqAnalytics'
35
+
provider:'iiqAnalytics',
36
+
options: {
37
+
manualWinReportEnabled:false,
38
+
reportMethod:"GET",
39
+
adUnitConfig:1,
40
+
gamPredictReporting:false
41
+
}
27
42
});
28
43
```
29
44
@@ -33,23 +48,6 @@ The reportExternalWin function allows for manual reporting, meaning that reports
33
48
34
49
To enable this manual reporting functionality, you must set the manualWinReportEnabled parameter in Intent IQ Unified ID module configuration is true. Once enabled, reports can be manually triggered using the reportExternalWin function.
35
50
36
-
```js
37
-
pbjs.setConfig({
38
-
userSync: {
39
-
userIds: [{
40
-
name:"intentIqId",
41
-
params: {
42
-
partner:123456, // valid partner id
43
-
browserBlackList:"chrome",
44
-
manualWinReportEnabled:true
45
-
}
46
-
}]
47
-
}
48
-
});
49
-
```
50
-
51
-
You can find more information and configuration examples in the [Intent IQ Universal ID module](https://docs.prebid.org/dev-docs/modules/userid-submodules/intentiq.html#configuration)
52
-
53
51
### Calling the reportExternalWin Function
54
52
55
53
To call the reportExternalWin function, you need to pass the partner_id parameter as shown in the example below:
Copy file name to clipboardExpand all lines: dev-docs/modules/userid-submodules/intentiq.md
+5-12Lines changed: 5 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,24 +45,20 @@ Please find below list of parameters that could be used in configuring Intent IQ
45
45
| params.callback | Optional | Function | This is a callback which is triggered with data |`(data) => console.log({ data })`|
46
46
| 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`|
47
47
| params.browserBlackList | Optional | String | This is the name of a browser that can be added to a blacklist. |`"chrome"`|
48
-
| 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`|
49
48
| 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"`|
50
49
| params.gamObjectReference | Optional | Object | This is a reference to the Google Ad Manager (GAM) object, which will be used to set targeting. If this parameter is not provided, the group reporting will not be configured. |`googletag`|
51
50
| params.gamParameterName | Optional | String | The name of the targeting parameter that will be used to pass the group. If not specified, the default value is `intent_iq_group`. |`"intent_iq_group"`|
52
-
| params.adUnitConfig | Optional | Number | Determines how the `placementId` parameter is extracted in the report (default is 1). Possible values: 1 – adUnitCode first, 2 – placementId first, 3 – only adUnitCode, 4 – only placementId |`1`|
53
51
| params.sourceMetaData | Optional | String | This metadata can be provided by the partner and will be included in the requests URL as a query parameter |`"123.123.123.123"`|
54
52
| params.sourceMetaDataExternal | Optional | Number | This metadata can be provided by the partner and will be included in the requests URL as a query parameter |`123456`|
55
53
| params.iiqServerAddress | Optional | String | The base URL for the IntentIQ API server. If parameter is provided in `configParams`, it will be used. |`"https://domain.com"`|
56
54
| params.iiqPixelServerAddress | Optional | String | The base URL for the IntentIQ pixel synchronization server. If parameter is provided in `configParams`, it will be used. |`"https://domain.com"`|
57
-
| params.reportingServerAddress | Optional | String | The base URL for the IntentIQ reporting server. If parameter is provided in `configParams`, it will be used. |`"https://domain.com"`|
58
-
| params.reportMethod | Optional | String | Defines the HTTP method used to send the analytics report. If set to `"POST"`, the report payload will be sent in the body of the request. If set to `"GET"` (default), the payload will be included as a query parameter in the request URL. |`"GET"`|
59
55
| params.siloEnabled | Optional | Boolean | Determines if first-party data is stored in a siloed storage key. When set to `true`, first-party data is stored under a modified key that appends `_p_` plus the partner value rather than using the default storage key. The default value is `false`. |`true`|
60
56
| params.groupChanged | Optional | Function | A callback that is triggered every time the user’s A/B group is set or updated. |`(group) => console.log('Group changed:', group)`|
61
57
| params.chTimeout | Optional | Number | Maximum time (in milliseconds) to wait for Client Hints from the browser before sending request. Default value is `10ms`|`30`|
62
-
| params.additionalParameters| Optional | Array | This parameter allows sending additional custom key-value parameters with specific destination logic (sync, VR, winreport). Each custom parameter is defined as an object in the array. |`[ { parameterName: “abc”, parameterValue: 123, destination: [1,1,0] } ]`|
63
-
| params.additionalParameters[0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. |`"abc"`|
64
-
| params.additionalParameters[0].parameterValue | Required | String / Number | Value to assign to the parameter. |`123`|
65
-
| params.additionalParameters[0].destination | Required | Array | Array of numbers either `1` or `0`. Controls where this parameter is sent `[sendWithSync, sendWithVr, winreport]`. |`[1, 0, 0]`|
58
+
| params.additionalParams| Optional | Array | This parameter allows sending additional custom key-value parameters with specific destination logic (sync, VR, winreport). Each custom parameter is defined as an object in the array. |`[ { parameterName: “abc”, parameterValue: 123, destination: [1,1,0] } ]`|
59
+
| params.additionalParams[0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. |`"abc"`|
60
+
| params.additionalParams[0].parameterValue | Required | String / Number | Value to assign to the parameter. |`123`|
61
+
| params.additionalParams[0].destination | Required | Array | Array of numbers either `1` or `0`. Controls where this parameter is sent `[sendWithSync, sendWithVr, winreport]`. |`[1, 0, 0]`|
0 commit comments