Skip to content

IntentIq ID & Analytics Modules: Client Hints timeout documentation #6246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisHuie merged 2 commits into from
Sep 15, 2025
Merged

IntentIq ID & Analytics Modules: Client Hints timeout documentation #6246

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8af990d
AGT-659: partnerClientId documentation (#15)
dmytro-po Aug 6, 2025
775cc2b
AGT-667: chTimeout parameter description
dmytro-po Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion dev-docs/modules/userid-submodules/intentiq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ Please find below list of parameters that could be used in configuring Intent IQ
| name | Required | String | The name of this module: "intentIqId" | `"intentIqId"` |
| params | Required | Object | Details for IntentIqId initialization. | |
| 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.partnerClientId | Optional | String | A specific user identifier that should be dynamically initialized by the partner. | `"client-id"` |
| params.partnerClientIdType | Optional | Number | Specifies the type of the partnerClientId. Possible values: `0` – 3rd-party cookie, `1` – IDFV (Identifier for Vendor on iOS), `3` – First-party ID, `4` – MAID / AAID (Mobile Advertising ID for Android/iOS) | `0` |
| 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 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` |
Expand All @@ -57,6 +58,7 @@ Please find below list of parameters that could be used in configuring Intent IQ
| 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.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.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` |
Expand All @@ -83,6 +85,7 @@ pbjs.setConfig({
sourceMetaData: "123.123.123.123", // Optional parameter
sourceMetaDataExternal: 123456, // Optional parameter
reportMethod: "GET", // Optional parameter
chTimeout: 10, // Optional parameter
additionalParameters: [ // Optional parameter
{
parameterName: "abc",
Expand Down