Skip to content
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

Update documentation #5461

Merged
merged 3 commits into from
Jul 2, 2024
Merged

Update documentation #5461

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2609097
Update documentation
DimaIntentIQ Jun 27, 2024
485cc52
Merge branch 'master' into identity_module_doc
DimaIntentIQ Jun 27, 2024
0aed216
Merge branch 'master' into identity_module_doc
DimaIntentIQ Jun 27, 2024
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
33 changes: 17 additions & 16 deletions dev-docs/modules/userid-submodules/intentiq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,16 @@ Please find below list of parameters that could be used in configuring Intent IQ

{: .table .table-bordered .table-striped }

| 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.percentage | Required | Number | This a percentage value for our A/B testing group distribution. The values supposed to be in range of 0 to 100. We suggest to set it to 95 percent for optimal balance ofbetween prefromance and preceision. | `95` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't removing this and adding callback break implementations?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it doesn't break the implementation. We now receive the percentage and A/B testing group from our server. Additionally, a callback is added to synchronize partners with us, as they typically have their own logic implemented on the page based on the callback.

| 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.enableCookieStorage | Optional | Boolean | This is a parameter allowing to enable or disable cookie storage. Defaults to false. | `"true"` |
| 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 | Required | 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"` |

### Configuration example

Expand All @@ -51,14 +52,13 @@ pbjs.setConfig({
name: "intentIqId",
params: {
partner: 123456, // valid partner id
percentage: 95,
enableCookieStorage: true
callback: (data, group) => window.pbjs.requestBids(),
},
storage: {
type: "html5",
name: "intentIqId", // set localstorage with this name
expires: 60,
refreshInSeconds: 4 * 3600, // refresh ID every 4 hours to ensure it's fresh
expires: 0,
refreshInSeconds: 0,
},
},
],
Expand All @@ -76,13 +76,14 @@ pbjs.setConfig({
partner: 123456 // valid partner id
pcid: PCID_VARIABLE, // string value, dynamically loaded into a variable before setting the configuration
pai: PAI_VARIABLE , // string value, dynamically loaded into a variable before setting the configuration
percentage: 95,
enableCookieStorage: false
timeoutInMillis: 500,
browserBlackList: "chrome",
callback: (data, group) => window.pbjs.requestBids()
},
storage: {
type: "html5",
name: "intentIqId", // set localstorage with this name
expires: 60
expires: 0
}
}],
syncDelay: 3000
Expand Down