Skip to content

Commit 8a82246

Browse files
authored
AGT-552: Additional query params doc (#12)
1 parent 0ab2527 commit 8a82246

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

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

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,13 @@ Please find below list of parameters that could be used in configuring Intent IQ
5555
| 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"` |
5656
| 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"` |
5757
| 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` |`1` |
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)` |
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]`
64+
6065

6166
### Configuration example
6267

@@ -78,7 +83,19 @@ pbjs.setConfig({
7883
adUnitConfig: 1, // Extracting placementId strategy (adUnitCode or placementId order of priorities)
7984
sourceMetaData: "123.123.123.123", // Optional parameter
8085
sourceMetaDataExternal: 123456, // Optional parameter
81-
reportMethod: "GET" // Optional parameter
86+
reportMethod: "GET", // Optional parameter
87+
additionalParameters: [
88+
{
89+
parameterName: "abc",
90+
parameterValue: 123,
91+
destination: [1, 1, 0] // sendWithSync: true, sendWithVr: true, winreport: false
92+
},
93+
{
94+
parameterName: "xyz",
95+
parameterValue: 111,
96+
destination: [0, 1, 1] // sendWithSync: false, sendWithVr: true, winreport: true
97+
}
98+
]
8299
},
83100
storage: {
84101
type: "html5",

0 commit comments

Comments
 (0)