From 7bcabc6607ebd8dfa1f3496dbcc9f21bd37a8ec6 Mon Sep 17 00:00:00 2001 From: DimaIntentIQ Date: Fri, 23 May 2025 17:34:28 +0300 Subject: [PATCH 1/7] fix spelling --- dev-docs/modules/userid-submodules/intentiq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 4e3044de0e..b0d739e82b 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -41,9 +41,9 @@ Please find below list of parameters that could be used in configuring Intent IQ | params.partner | Required | Number | This is the partner ID value obtained from registering with IntentIQ. | `1177538` | | params.pcid | Optional | String | This is the partner cookie ID, it is a dynamic value attached to the request. | `"g3hC52b"` | | params.pai | Optional | String | This is the partner customer ID / advertiser ID, it is a dynamic value attached to the request. | `"advertiser1"` | -| params.callback | Optional | Function | This is a callback which is trigered with data and AB group | `(data, group) => console.log({ data, group })` | +| params.callback | Optional | Function | This is a callback which is triggered with data and AB group | `(data, group) => console.log({ data, group })` | | 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.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"` | | 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` | From 315df096c80f0296affdd2c102e8e3dca6344389 Mon Sep 17 00:00:00 2001 From: dmytro-po Date: Tue, 11 Nov 2025 13:30:06 +0200 Subject: [PATCH 2/7] AGT-705: abPercentage parameter (#16) --- dev-docs/modules/userid-submodules/intentiq.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 2ae2bb46ea..3b8d5ce4c8 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -59,6 +59,7 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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` | | 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)` | | params.chTimeout | Optional | Number | Maximum time (in milliseconds) to wait for Client Hints from the browser before sending request. Default value is `10ms` | `30` | +| params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` | | 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] } ]` | | params.additionalParameters [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` | | params.additionalParameters [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` | @@ -86,6 +87,7 @@ pbjs.setConfig({ sourceMetaDataExternal: 123456, // Optional parameter reportMethod: "GET", // Optional parameter chTimeout: 10, // Optional parameter + abPercentage: 95, // Optional parameter additionalParameters: [ // Optional parameter { parameterName: "abc", From 058d452b62a00b51f9a2efa8de2923717a51cbc3 Mon Sep 17 00:00:00 2001 From: DimaIntentIQ Date: Fri, 12 Dec 2025 20:49:23 +0200 Subject: [PATCH 3/7] add group parameters --- dev-docs/analytics/intentiq.md | 6 ++++++ dev-docs/modules/userid-submodules/intentiq.md | 2 ++ 2 files changed, 8 insertions(+) diff --git a/dev-docs/analytics/intentiq.md b/dev-docs/analytics/intentiq.md index b5ba04fc86..4aebd60eb5 100644 --- a/dev-docs/analytics/intentiq.md +++ b/dev-docs/analytics/intentiq.md @@ -22,11 +22,16 @@ No registration for this module is required. {: .table .table-bordered .table-striped } | Parameter | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | +| params.partner| Required | Number | This is the partner ID value obtained from registering with IntentIQ. | `1177538` | | 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` | | 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"` | | 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"` | | 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` | | 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` | +| 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` | +| params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` | +| params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` | + #### Example Configuration @@ -34,6 +39,7 @@ No registration for this module is required. pbjs.enableAnalytics({ provider: 'iiqAnalytics', options: { + partner: 1177538, manualWinReportEnabled: false, reportMethod: "GET", adUnitConfig: 1, diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index f07fe70489..b64cc8505e 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -55,7 +55,9 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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` | | 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)` | | params.chTimeout | Optional | Number | Maximum time (in milliseconds) to wait for Client Hints from the browser before sending request. Default value is `10ms` | `30` | +| 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` | | params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` | +| params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` | | 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] } ]` | | params.additionalParameters [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` | | params.additionalParameters [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` | From 2a9329121aae1192992dcc8ab568d84a840c2d86 Mon Sep 17 00:00:00 2001 From: DimaIntentIQ Date: Fri, 12 Dec 2025 20:53:13 +0200 Subject: [PATCH 4/7] remove extra line --- dev-docs/analytics/intentiq.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev-docs/analytics/intentiq.md b/dev-docs/analytics/intentiq.md index 4aebd60eb5..a715ef5c72 100644 --- a/dev-docs/analytics/intentiq.md +++ b/dev-docs/analytics/intentiq.md @@ -32,7 +32,6 @@ No registration for this module is required. | params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` | | params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` | - #### Example Configuration ```js From 662d02cde9e40ffc0ca3b24d56f33def2a451579 Mon Sep 17 00:00:00 2001 From: DimaIntentIQ Date: Mon, 15 Dec 2025 22:06:39 +0200 Subject: [PATCH 5/7] add more params to analytical adapter --- dev-docs/analytics/intentiq.md | 16 ++++++++++++---- dev-docs/modules/userid-submodules/intentiq.md | 10 +++++----- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/dev-docs/analytics/intentiq.md b/dev-docs/analytics/intentiq.md index a715ef5c72..8ef946a293 100644 --- a/dev-docs/analytics/intentiq.md +++ b/dev-docs/analytics/intentiq.md @@ -22,15 +22,22 @@ No registration for this module is required. {: .table .table-bordered .table-striped } | Parameter | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | -| params.partner| Required | Number | This is the partner ID value obtained from registering with IntentIQ. | `1177538` | +| options.partner| Required | Number | This is the partner ID value obtained from registering with IntentIQ. | `1177538` | | 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` | | 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"` | | 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"` | | 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` | | 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` | -| 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` | -| params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` | -| params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` | +| 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` | +| options.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` | +| options.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` | +| 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`| +| options.browserBlackList | Optional | String | This is the name of a browser that can be added to a blacklist.| `"chrome"`| +| 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"`| +| 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] } ]` | +| options. additionalParams[0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` | +| options. additionalParams[0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` | +| 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]` | #### Example Configuration @@ -42,6 +49,7 @@ pbjs.enableAnalytics({ manualWinReportEnabled: false, reportMethod: "GET", adUnitConfig: 1, + domainName: "currentDomain.com", gamPredictReporting: false } }); diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index b64cc8505e..8c734a863d 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -58,10 +58,10 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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` | | params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` | | params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` | -| 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] } ]` | -| params.additionalParameters [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` | -| params.additionalParameters [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` | -| 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]` | +| 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] } ]` | +| params.additionalParams [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` | +| params.additionalParams [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` | +| 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]` | ### Configuration example @@ -83,7 +83,7 @@ pbjs.setConfig({ sourceMetaDataExternal: 123456, // Optional parameter chTimeout: 10, // Optional parameter abPercentage: 95, // Optional parameter - additionalParameters: [ // Optional parameter + additionalParams: [ // Optional parameter { parameterName: "abc", parameterValue: 123, From 611c314befcb6111a8888be715197bb422da483d Mon Sep 17 00:00:00 2001 From: DimaIntentIQ Date: Thu, 5 Mar 2026 13:45:01 +0200 Subject: [PATCH 6/7] update documentation --- dev-docs/analytics/intentiq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/analytics/intentiq.md b/dev-docs/analytics/intentiq.md index 8ef946a293..ec69c14616 100644 --- a/dev-docs/analytics/intentiq.md +++ b/dev-docs/analytics/intentiq.md @@ -101,7 +101,7 @@ adType: 'banner' // Specifies the type of ad served | biddingPlatformId | Integer | Specify the platform in which this ad impression was rendered – 1 – Prebid, 2 – Amazon, 3 – Google, 4 – Open RTB (including your local Prebid server) | 1 | Yes | | partnerAuctionId | String | Use this when you are running multiple auction solutions across your assets and have a unified identifier for auctions | 3d44542d-xx-4662-xxxx-4xxxx3d8e | No | | bidderCode | String | Specifies the name of the bidder that won the auction as reported by Prebid and all other bidding platforms | newAppnexus | Yes | -| prebidAuctionId | String | Specifies the identifier of the Prebid auction. Leave empty or undefined if Prebid is not the bidding platform | | | +| prebidAuctionId | String | Specifies the identifier of the Prebid auction. Leave empty or undefined if Prebid is not the bidding platform | 3513ce01-de02-490b-9d87-bfc137697f82 | No | | cpm | Decimal | Cost per mille of the impression as received from the demand-side auction (without modifications or reductions) | 5.62 | Yes | | currency | String | Currency of the auction | USD | Yes | | originalCpm | Decimal | Leave empty or undefined if Prebid is not the bidding platform | 5.5 | No | From c95e65ab3fd39ffa0dce15348ac8df6a6185a4e9 Mon Sep 17 00:00:00 2001 From: DimaIntentIQ Date: Thu, 5 Mar 2026 14:03:40 +0200 Subject: [PATCH 7/7] refactoring --- dev-docs/analytics/intentiq.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/dev-docs/analytics/intentiq.md b/dev-docs/analytics/intentiq.md index ec69c14616..18ba37fdb5 100644 --- a/dev-docs/analytics/intentiq.md +++ b/dev-docs/analytics/intentiq.md @@ -96,22 +96,22 @@ adType: 'banner' // Specifies the type of ad served ``` {: .table .table-bordered .table-striped } -| Field | Data Type | Description | Example | Mandatory | +| Field | Data Type | Description | Example | Mandatory | |--------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----------| -| biddingPlatformId | Integer | Specify the platform in which this ad impression was rendered – 1 – Prebid, 2 – Amazon, 3 – Google, 4 – Open RTB (including your local Prebid server) | 1 | Yes | -| partnerAuctionId | String | Use this when you are running multiple auction solutions across your assets and have a unified identifier for auctions | 3d44542d-xx-4662-xxxx-4xxxx3d8e | No | -| bidderCode | String | Specifies the name of the bidder that won the auction as reported by Prebid and all other bidding platforms | newAppnexus | Yes | -| prebidAuctionId | String | Specifies the identifier of the Prebid auction. Leave empty or undefined if Prebid is not the bidding platform | 3513ce01-de02-490b-9d87-bfc137697f82 | No | -| cpm | Decimal | Cost per mille of the impression as received from the demand-side auction (without modifications or reductions) | 5.62 | Yes | -| currency | String | Currency of the auction | USD | Yes | -| originalCpm | Decimal | Leave empty or undefined if Prebid is not the bidding platform | 5.5 | No | -| originalCurrency | String | Currency of the original auction | USD | No | -| status | String | Status of the impression. Leave empty or undefined if Prebid is not the bidding platform | rendered | No | -| placementId | String | Unique identifier of the ad unit on the webpage that showed this ad | div-1 | No | -| adType | String | Specifies the type of ad served. Possible values: “banner“, “video“, “native“, “audio“. | banner | No | +| biddingPlatformId | Integer | Specify the platform in which this ad impression was rendered – 1 – Prebid, 2 – Amazon, 3 – Google, 4 – Open RTB (including your local Prebid server) | 1 | Yes | +| partnerAuctionId | String | Use this when you are running multiple auction solutions across your assets and have a unified identifier for auctions | 3d44542d-xx-4662-xxxx-4xxxx3d8e | No | +| bidderCode | String | Specifies the name of the bidder that won the auction as reported by Prebid and all other bidding platforms | newAppnexus | Yes | +| prebidAuctionId | String | Specifies the identifier of the Prebid auction. Leave empty or undefined if Prebid is not the bidding platform | 3513ce01-de02-490b-9d87-bfc137697f82 | No | +| cpm | Decimal | Cost per mille of the impression as received from the demand-side auction (without modifications or reductions) | 5.62 | Yes | +| currency | String | Currency of the auction | USD | Yes | +| originalCpm | Decimal | Leave empty or undefined if Prebid is not the bidding platform | 5.5 | No | +| originalCurrency | String | Currency of the original auction | USD | No | +| status | String | Status of the impression. Leave empty or undefined if Prebid is not the bidding platform | rendered | No | +| placementId | String | Unique identifier of the ad unit on the webpage that showed this ad | div-1 | No | +| adType | String | Specifies the type of ad served. Possible values: “banner“, “video“, “native“, “audio“. | banner | No | To report the auction win, call the function as follows: ```js -window.intentIqAnalyticsAdapter_[partner_id].reportExternalWin(reportData) +window.intentIqAnalyticsAdapter_[partner_id].reportExternalWin(reportData); ```