From 35ffd9411bcda83b0858d8684fcd55072cd7b079 Mon Sep 17 00:00:00 2001 From: dmytro-po Date: Fri, 7 Mar 2025 17:30:41 +0200 Subject: [PATCH 1/8] AGT-403: Add adType parameter description --- dev-docs/analytics/intentiq.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/dev-docs/analytics/intentiq.md b/dev-docs/analytics/intentiq.md index d56f2f7069..45295b975b 100644 --- a/dev-docs/analytics/intentiq.md +++ b/dev-docs/analytics/intentiq.md @@ -80,6 +80,7 @@ originalCpm: 1.5, // Original CPM value. originalCurrency: 'USD', // Original currency. status: 'rendered', // Auction status, e.g., 'rendered'. placementId: 'div-1' // ID of the ad placement. +adType: 'banner' // Specifies the type of ad served } ``` @@ -95,6 +96,7 @@ placementId: 'div-1' // ID of the ad placement. | 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: From a1b63425ca7646e60242813b346f988046f07103 Mon Sep 17 00:00:00 2001 From: dmytro-po Date: Wed, 19 Mar 2025 17:36:32 +0200 Subject: [PATCH 2/8] Merge pull request #2 from DimaIntentIQ/AGT-466-module-reporting-placement-id-unit-code IntentIq ID & Analytics Modules: placementId parameter documentation --- dev-docs/modules/userid-submodules/intentiq.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 449b356983..24d8f155d3 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -48,6 +48,7 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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` | | 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"` | +| 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` | ### Configuration example @@ -60,11 +61,12 @@ pbjs.setConfig({ partner: 123456, // valid partner id timeoutInMillis: 500, browserBlackList: "chrome", - callback: (data, group) => window.pbjs.requestBids(), + callback: (data, group) => {...}, // your logic here manualWinReportEnabled: true, domainName: "currentDomain.com", gamObjectReference: googletag, - gamParameterName: "intent_iq_group" + gamParameterName: "intent_iq_group", + adUnitConfig: 1 // Extracting placementId strategy (adUnitCode or placementId order of priorities) }, storage: { type: "html5", From ef1c3c208611c749aa007ebcf2435780990be019 Mon Sep 17 00:00:00 2001 From: dmytro-po Date: Thu, 27 Mar 2025 15:00:24 +0200 Subject: [PATCH 3/8] IntentIq ID: Documentation for sourceMetaData and sourceMetaDataExternal (#5) * Fix table * AGT-453: Documentation for sourceMetaData --- dev-docs/analytics/intentiq.md | 1 + dev-docs/modules/userid-submodules/intentiq.md | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/dev-docs/analytics/intentiq.md b/dev-docs/analytics/intentiq.md index 45295b975b..c44c28ca73 100644 --- a/dev-docs/analytics/intentiq.md +++ b/dev-docs/analytics/intentiq.md @@ -84,6 +84,7 @@ adType: 'banner' // Specifies the type of ad served } ``` +{: .table .table-bordered .table-striped } | 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 | diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 24d8f155d3..ba0df1dbbf 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -49,6 +49,8 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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` | | 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"` | | 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` | +| 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"` | +| 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` | ### Configuration example @@ -66,7 +68,9 @@ pbjs.setConfig({ domainName: "currentDomain.com", gamObjectReference: googletag, gamParameterName: "intent_iq_group", - adUnitConfig: 1 // Extracting placementId strategy (adUnitCode or placementId order of priorities) + adUnitConfig: 1, // Extracting placementId strategy (adUnitCode or placementId order of priorities) + sourceMetaData: "123.123.123.123", // Optional parameter + sourceMetaDataExternal: 123456, // Optional parameter }, storage: { type: "html5", From 2f03e55bd0039998c9ec4bccca4027257d53d4d8 Mon Sep 17 00:00:00 2001 From: dLepetynskyiIntentiq Date: Wed, 2 Apr 2025 13:48:19 +0300 Subject: [PATCH 4/8] fix docs and add docs (#6) --- dev-docs/modules/userid-submodules/intentiq.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index ba0df1dbbf..594f300458 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -51,7 +51,9 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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` | | 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"` | | 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` | - +| params.iiqServerAddress | Optional | String | The base URL for the IntentIQ API server. If `iiqServerAddress` is provided in `configParams`, it will be used. | `"https://api.example.com"` | +| params.iiqPixelServerAddress | Optional | String | The base URL for the IntentIQ pixel synchronization server. If `iiqPixelServerAddress` is provided in `configParams`, it will be used. | `"https://sync.example.com"` | +| params.reportingServerAddress | Optional | String | The base URL for the IntentIQ reporting server. If `reportingServerAddress` is provided in `configParams`, it will be used.| `"https://reports.exmaple.com/report"` | ### Configuration example ```javascript From aca44de5b658e43ef7d278e973ce0bdd95dcadb2 Mon Sep 17 00:00:00 2001 From: dmytro-po Date: Fri, 4 Apr 2025 15:58:11 +0300 Subject: [PATCH 5/8] AGT-498: reportMethod description (#7) --- .../modules/userid-submodules/intentiq.md | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 594f300458..9c6901ed44 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -41,19 +41,23 @@ 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 | Required | 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 trigered 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.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.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` | +| 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` | | 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"` | -| 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` | -| 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"` | -| 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` | -| params.iiqServerAddress | Optional | String | The base URL for the IntentIQ API server. If `iiqServerAddress` is provided in `configParams`, it will be used. | `"https://api.example.com"` | -| params.iiqPixelServerAddress | Optional | String | The base URL for the IntentIQ pixel synchronization server. If `iiqPixelServerAddress` is provided in `configParams`, it will be used. | `"https://sync.example.com"` | -| params.reportingServerAddress | Optional | String | The base URL for the IntentIQ reporting server. If `reportingServerAddress` is provided in `configParams`, it will be used.| `"https://reports.exmaple.com/report"` | +| 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` | +| 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"` | +| 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` | +| 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"` | +| 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"` | +| 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"` | +| 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"` | + + + ### Configuration example ```javascript @@ -73,6 +77,7 @@ pbjs.setConfig({ adUnitConfig: 1, // Extracting placementId strategy (adUnitCode or placementId order of priorities) sourceMetaData: "123.123.123.123", // Optional parameter sourceMetaDataExternal: 123456, // Optional parameter + reportMethod: "GET" // Optional parameter }, storage: { type: "html5", @@ -83,4 +88,4 @@ pbjs.setConfig({ }] } }); -``` +``` \ No newline at end of file From 73504aecca89d2a3f9c9380db45cf064f1a5b846 Mon Sep 17 00:00:00 2001 From: Eyvaz Ahmadzada Date: Thu, 17 Apr 2025 21:46:06 +0200 Subject: [PATCH 6/8] add groupchanged param docs --- dev-docs/modules/userid-submodules/intentiq.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 9c6901ed44..03410d427a 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -41,7 +41,7 @@ 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 trigered with data | `(data) => console.log({ data })` | | 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` | @@ -56,6 +56,8 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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"` | | 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"` | +| 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)` | + ### Configuration example @@ -69,7 +71,8 @@ pbjs.setConfig({ partner: 123456, // valid partner id timeoutInMillis: 500, browserBlackList: "chrome", - callback: (data, group) => {...}, // your logic here + callback: (data) => {...}, // your logic here + groupChanged: (group) => console.log('Group is', group), manualWinReportEnabled: true, domainName: "currentDomain.com", gamObjectReference: googletag, From 17b066e3f8e183292e9dc314f63b1ced5690b281 Mon Sep 17 00:00:00 2001 From: Eyvaz <62054743+eyvazahmadzada@users.noreply.github.com> Date: Tue, 10 Jun 2025 19:36:37 +0200 Subject: [PATCH 7/8] remove/add new lines --- dev-docs/modules/userid-submodules/intentiq.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 03410d427a..73e5f1bee3 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -58,8 +58,6 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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)` | - - ### Configuration example ```javascript @@ -91,4 +89,4 @@ pbjs.setConfig({ }] } }); -``` \ No newline at end of file +``` From b205df1901f8ec6e8005e2031f8fe235a0d82b6b Mon Sep 17 00:00:00 2001 From: DimaIntentIQ Date: Wed, 11 Jun 2025 09:19:31 +0300 Subject: [PATCH 8/8] Add missed params --- .../modules/userid-submodules/intentiq.md | 30 ++++++++++++++----- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/dev-docs/modules/userid-submodules/intentiq.md b/dev-docs/modules/userid-submodules/intentiq.md index 73e5f1bee3..adc47a0ebd 100644 --- a/dev-docs/modules/userid-submodules/intentiq.md +++ b/dev-docs/modules/userid-submodules/intentiq.md @@ -41,7 +41,7 @@ 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 | `(data) => console.log({ data })` | +| params.callback | Optional | Function | This is a callback which is triggered with data | `(data) => console.log({ data })` | | 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` | @@ -55,8 +55,12 @@ Please find below list of parameters that could be used in configuring Intent IQ | 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"` | | 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"` | | 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"` | - -| 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.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.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]` | ### Configuration example @@ -71,14 +75,26 @@ pbjs.setConfig({ browserBlackList: "chrome", callback: (data) => {...}, // your logic here groupChanged: (group) => console.log('Group is', group), - manualWinReportEnabled: true, + manualWinReportEnabled: true, // Optional parameter domainName: "currentDomain.com", - gamObjectReference: googletag, - gamParameterName: "intent_iq_group", + gamObjectReference: googletag, // Optional parameter + gamParameterName: "intent_iq_group", // Optional parameter adUnitConfig: 1, // Extracting placementId strategy (adUnitCode or placementId order of priorities) sourceMetaData: "123.123.123.123", // Optional parameter sourceMetaDataExternal: 123456, // Optional parameter - reportMethod: "GET" // Optional parameter + reportMethod: "GET", // Optional parameter + additionalParameters: [ // Optional parameter + { + parameterName: "abc", + parameterValue: 123, + destination: [1, 1, 0] // sendWithSync: true, sendWithVr: true, winreport: false + }, + { + parameterName: "xyz", + parameterValue: 111, + destination: [0, 1, 1] // sendWithSync: false, sendWithVr: true, winreport: true + } + ] }, storage: { type: "html5",