Skip to content

Commit bb1a905

Browse files
Intent IQ: Fix additional parameters doc (#6462)
* fix spelling * AGT-705: abPercentage parameter (#16) * add group parameters * remove extra line * add more params to analytical adapter * AGT-790: Fix documentation (#19) * update documentation * refactoring * add id sample --------- Co-authored-by: DimaIntentIQ <dmytro.piskun@intentiq.com> Co-authored-by: DimaIntentIQ <139111483+DimaIntentIQ@users.noreply.github.com>
1 parent 56b55bd commit bb1a905

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

dev-docs/analytics/intentiq.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ No registration for this module is required.
3535
| options.browserBlackList | Optional | String | This is the name of a browser that can be added to a blacklist.| `"chrome"`|
3636
| options.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"`|
3737
| options. additionalParams | 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] } ]` |
38-
| options. additionalParams[0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
39-
| options. additionalParams[0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` |
40-
| options. additionalParams[0].destination | Required | Array | Array of numbers either `1` or `0`. Controls where this parameter is sent `[sendWithSync, sendWithVr, winreport]`. | `[1, 0, 0]` |
38+
| options. additionalParams[0].parameterName | Optional | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
39+
| options. additionalParams[0].parameterValue | Optional | String / Number | Value to assign to the parameter. | `123` |
40+
| options. additionalParams[0].destination | Optional | Array | Array of numbers either `1` or `0`. Controls where this parameter is sent `[sendWithSync, sendWithVr, winreport]`. | `[1, 0, 0]` |
4141

4242
#### Example Configuration
4343

@@ -95,12 +95,12 @@ pos: 0 // The following values are defined in the ORTB 2.5 spec
9595
```
9696

9797
{: .table .table-bordered .table-striped }
98-
| Field | Data Type | Description | Example | Mandatory |
98+
| Field | Data Type | Description | Example | Mandatory |
9999
|--------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----------|
100100
| 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 |
101101
| partnerAuctionId | String | Use this when you are running multiple auction solutions across your assets and have a unified identifier for auctions | 3d44542d-xx-4662-xxxx-4xxxx3d8e | No |
102102
| bidderCode | String | Specifies the name of the bidder that won the auction as reported by Prebid and all other bidding platforms | newAppnexus | Yes |
103-
| prebidAuctionId | String | Specifies the identifier of the Prebid auction. Leave empty or undefined if Prebid is not the bidding platform | | |
103+
| prebidAuctionId | String | Specifies the identifier of the Prebid auction. Leave empty or undefined if Prebid is not the bidding platform | 3513ce01-de02-490b-9d87-bfc137697f82 | No |
104104
| cpm | Decimal | Cost per mille of the impression as received from the demand-side auction (without modifications or reductions) | 5.62 | Yes |
105105
| currency | String | Currency of the auction | USD | Yes |
106106
| originalCpm | Decimal | Leave empty or undefined if Prebid is not the bidding platform | 5.5 | No |
@@ -114,5 +114,5 @@ pos: 0 // The following values are defined in the ORTB 2.5 spec
114114
To report the auction win, call the function as follows:
115115

116116
```js
117-
window.intentIqAnalyticsAdapter_[partner_id].reportExternalWin(reportData)
117+
window.intentIqAnalyticsAdapter_[partner_id].reportExternalWin(reportData);
118118
```

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Please find below list of parameters that could be used in configuring Intent IQ
6060
| params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` |
6161
| params.region | Optional | String | Optional region identifier used to automatically build server endpoints. When specified, region-specific endpoints will be used. (`gdpr`,`emea`, `apac`) | `"gdpr"` |
6262
| params.additionalParams | 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] } ]` |
63-
| params.additionalParams [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
64-
| params.additionalParams [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` |
65-
| params.additionalParams [0].destination | Required | Array | Array of numbers either `1` or `0`. Controls where this parameter is sent `[sendWithSync, sendWithVr, winreport]`. | `[1, 0, 0]` |
63+
| params.additionalParams [0].parameterName | Optional | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
64+
| params.additionalParams [0].parameterValue | Optional | String / Number | Value to assign to the parameter. | `123` |
65+
| params.additionalParams [0].destination | Optional | Array | Array of numbers either `1` or `0`. Controls where this parameter is sent `[sendWithSync, sendWithVr, winreport]`. | `[1, 0, 0]` |
6666

6767
### Configuration example
6868

0 commit comments

Comments
 (0)