Intent IQ ID
Module | intentIqIdSystem |
---|---|
EID Source | intentiq.com |
bidRequest.userId | intentiqid |
Example | "1111" |
Intent IQ Universal ID module
By leveraging the Intent IQ identity graph, our module helps publishers, SSPs, and DSPs overcome the challenges of monetizing cookie-less inventory and preparing for a future without 3rd-party cookies. Our solution implements 1st-party data clustering and provides Intent IQ person IDs with over 90% coverage and unmatched accuracy in supported countries while remaining privacy-friendly and CCPA compliant. This results in increased CPMs, higher fill rates, and, ultimately, lifting overall revenue
All you need is a few basic steps to start using our solution
Registration
Navigate to our portal and contact our team for partner ID. check our documentation to get more information about our solution and how utilze it’s full potential
Integration
gulp build –modules=intentIqIdSystem
We recommend including the Intent IQ Analytics adapter module for improved visibility
Configuration
Parameters
Please find below list of parameters that could be used in configuring Intent IQ Universal ID module
Param under userSync.userIds[] | Scope | Type | Description | Example |
---|---|---|---|---|
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.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 |
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.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 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" |
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
pbjs.setConfig({
userSync: {
userIds: [{
name: "intentIqId",
params: {
partner: 123456, // valid partner id
timeoutInMillis: 500,
browserBlackList: "chrome",
callback: (data) => {...}, // your logic here
groupChanged: (group) => console.log('Group is', group),
manualWinReportEnabled: true, // Optional parameter
domainName: "currentDomain.com",
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
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",
name: "intentIqId", // set localstorage with this name
expires: 0,
refreshInSeconds: 0
}
}]
}
});