Skip to content

Commit 14d6cb4

Browse files
DimaIntentIQeyvazahmadzadadmytro-podLepetynskyiIntentiqEyvaz Ahmadzada
authored
IntentIq ID & Analytics Modules: Supports additional configuration parameters (prebid#6043)
* fix spelling * Agt 454 group changes (#13) * AGT-403: Add adType parameter description * Merge pull request #2 from DimaIntentIQ/AGT-466-module-reporting-placement-id-unit-code IntentIq ID & Analytics Modules: placementId parameter documentation * IntentIq ID: Documentation for sourceMetaData and sourceMetaDataExternal (#5) * Fix table * AGT-453: Documentation for sourceMetaData * fix docs and add docs (#6) * AGT-498: reportMethod description (#7) * add groupchanged param docs * remove/add new lines * Add missed params --------- Co-authored-by: dmytro-po <[email protected]> Co-authored-by: DimaIntentIQ <[email protected]> Co-authored-by: dLepetynskyiIntentiq <[email protected]> Co-authored-by: Eyvaz Ahmadzada <[email protected]> Co-authored-by: DimaIntentIQ <[email protected]> --------- Co-authored-by: Eyvaz <[email protected]> Co-authored-by: dmytro-po <[email protected]> Co-authored-by: dLepetynskyiIntentiq <[email protected]> Co-authored-by: Eyvaz Ahmadzada <[email protected]>
1 parent 4600da3 commit 14d6cb4

File tree

2 files changed

+41
-8
lines changed

2 files changed

+41
-8
lines changed

‎dev-docs/analytics/intentiq.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,11 @@ originalCpm: 1.5, // Original CPM value.
8080
originalCurrency: 'USD', // Original currency.
8181
status: 'rendered', // Auction status, e.g., 'rendered'.
8282
placementId: 'div-1' // ID of the ad placement.
83+
adType: 'banner' // Specifies the type of ad served
8384
}
8485
```
8586

87+
{: .table .table-bordered .table-striped }
8688
| Field | Data Type | Description | Example | Mandatory |
8789
|--------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----------|
8890
| 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 |
@@ -95,6 +97,7 @@ placementId: 'div-1' // ID of the ad placement.
9597
| originalCurrency | String | Currency of the original auction | USD | No |
9698
| status | String | Status of the impression. Leave empty or undefined if Prebid is not the bidding platform | rendered | No |
9799
| placementId | String | Unique identifier of the ad unit on the webpage that showed this ad | div-1 | No |
100+
| adType | String | Specifies the type of ad served. Possible values: “banner“, “video“, “native“, “audio“. | banner | No |
98101

99102
To report the auction win, call the function as follows:
100103

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

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,26 @@ Please find below list of parameters that could be used in configuring Intent IQ
4141
| params.partner | Required | Number | This is the partner ID value obtained from registering with IntentIQ. | `1177538` |
4242
| params.pcid | Optional | String | This is the partner cookie ID, it is a dynamic value attached to the request. | `"g3hC52b"` |
4343
| params.pai | Optional | String | This is the partner customer ID / advertiser ID, it is a dynamic value attached to the request. | `"advertiser1"` |
44-
| params.callback | Optional | Function | This is a callback which is trigered with data and AB group | `(data, group) => console.log({ data, group })` |
44+
| params.callback | Optional | Function | This is a callback which is triggered with data | `(data) => console.log({ data })` |
4545
| 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` |
46-
| params.browserBlackList | Optional |  String | This is the name of a browser that can be added to a blacklist. | `"chrome"` |
47-
| 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`|
46+
| params.browserBlackList | Optional | String | This is the name of a browser that can be added to a blacklist. | `"chrome"` |
47+
| 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` |
4848
| 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"` |
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` |
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` |
5050
| 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"` |
51+
| 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` |
52+
| 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"` |
53+
| 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` |
54+
| 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"` |
55+
| 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"` |
56+
| 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"` |
57+
| 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"` |
58+
| 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` |
59+
| 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)` |
60+
| 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] } ]` |
61+
| params.additionalParameters [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
62+
| params.additionalParameters [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` |
63+
| 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]` |
5164

5265
### Configuration example
5366

@@ -60,11 +73,28 @@ pbjs.setConfig({
6073
partner: 123456, // valid partner id
6174
timeoutInMillis: 500,
6275
browserBlackList: "chrome",
63-
callback: (data, group) => window.pbjs.requestBids(),
64-
manualWinReportEnabled: true,
76+
callback: (data) => {...}, // your logic here
77+
groupChanged: (group) => console.log('Group is', group),
78+
manualWinReportEnabled: true, // Optional parameter
6579
domainName: "currentDomain.com",
66-
gamObjectReference: googletag,
67-
gamParameterName: "intent_iq_group"
80+
gamObjectReference: googletag, // Optional parameter
81+
gamParameterName: "intent_iq_group", // Optional parameter
82+
adUnitConfig: 1, // Extracting placementId strategy (adUnitCode or placementId order of priorities)
83+
sourceMetaData: "123.123.123.123", // Optional parameter
84+
sourceMetaDataExternal: 123456, // Optional parameter
85+
reportMethod: "GET", // Optional parameter
86+
additionalParameters: [ // Optional parameter
87+
{
88+
parameterName: "abc",
89+
parameterValue: 123,
90+
destination: [1, 1, 0] // sendWithSync: true, sendWithVr: true, winreport: false
91+
},
92+
{
93+
parameterName: "xyz",
94+
parameterValue: 111,
95+
destination: [0, 1, 1] // sendWithSync: false, sendWithVr: true, winreport: true
96+
}
97+
]
6898
},
6999
storage: {
70100
type: "html5",

0 commit comments

Comments
 (0)