Skip to content

Commit 8b4d918

Browse files
authored
add more params to analytical adapter (#17)
1 parent 7553e69 commit 8b4d918

2 files changed

Lines changed: 17 additions & 9 deletions

File tree

dev-docs/analytics/intentiq.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,22 @@ No registration for this module is required.
2222
{: .table .table-bordered .table-striped }
2323
| Parameter | Scope | Type | Description | Example |
2424
| --- | --- | --- | --- | --- |
25-
| params.partner| Required | Number | This is the partner ID value obtained from registering with IntentIQ. | `1177538` |
25+
| options.partner| Required | Number | This is the partner ID value obtained from registering with IntentIQ. | `1177538` |
2626
| 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` |
2727
| 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"` |
2828
| 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"` |
2929
| 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` |
3030
| 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` |
31-
| params.ABTestingConfigurationSource | Optional | String | Determines how AB group will be defined. Possible values: `"IIQServer"` – group defined by IIQ server, `"percentage"` – generated group based on abPercentage, `"group"` – define group based on value provided by partner. | `IIQServer` |
32-
| params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` |
33-
| params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` |
31+
| options. ABTestingConfigurationSource | Optional | String | Determines how AB group will be defined. Possible values: `"IIQServer"` – group defined by IIQ server, `"percentage"` – generated group based on abPercentage, `"group"` – define group based on value provided by partner. | `IIQServer` |
32+
| options.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` |
33+
| options.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` |
34+
| options.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`|
35+
| options.browserBlackList | Optional | String | This is the name of a browser that can be added to a blacklist.| `"chrome"`|
36+
| options.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"`|
37+
| options. 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] } ]` |
38+
| options. additionalParams[0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
39+
| options. additionalParams[0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` |
40+
| options. additionalParams[0].destination | Required | Array | Array of numbers either `1` or `0`. Controls where this parameter is sent `[sendWithSync, sendWithVr, winreport]`. | `[1, 0, 0]` |
3441

3542
#### Example Configuration
3643

@@ -42,6 +49,7 @@ pbjs.enableAnalytics({
4249
manualWinReportEnabled: false,
4350
reportMethod: "GET",
4451
adUnitConfig: 1,
52+
domainName: "currentDomain.com",
4553
gamPredictReporting: false
4654
}
4755
});

dev-docs/modules/userid-submodules/intentiq.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ Please find below list of parameters that could be used in configuring Intent IQ
5858
| params. ABTestingConfigurationSource| Optional | String | Determines how AB group will be defined. Possible values: `"IIQServer"` – group defined by IIQ server, `"percentage"` – generated group based on abPercentage, `"group"` – define group based on value provided by partner. | `IIQServer` |
5959
| params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` |
6060
| params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` |
61-
| 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] } ]` |
62-
| params.additionalParameters [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
63-
| params.additionalParameters [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` |
64-
| 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]` |
61+
| 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] } ]` |
62+
| params.additionalParams [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
63+
| params.additionalParams [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` |
64+
| 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]` |
6565

6666
### Configuration example
6767

@@ -83,7 +83,7 @@ pbjs.setConfig({
8383
sourceMetaDataExternal: 123456, // Optional parameter
8484
chTimeout: 10, // Optional parameter
8585
abPercentage: 95, // Optional parameter
86-
additionalParameters: [ // Optional parameter
86+
additionalParams: [ // Optional parameter
8787
{
8888
parameterName: "abc",
8989
parameterValue: 123,

0 commit comments

Comments
 (0)