Skip to content

Commit f333016

Browse files
authored
AGT-721: Doc for size, pos, region (#18)
* AGT-721: Doc for size, pos, region * Afix analytics example
1 parent 44dde6e commit f333016

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

dev-docs/analytics/intentiq.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,8 @@ pbjs.enableAnalytics({
4646
provider: 'iiqAnalytics',
4747
options: {
4848
partner: 1177538,
49-
manualWinReportEnabled: false,
50-
reportMethod: "GET",
51-
adUnitConfig: 1,
49+
ABTestingConfigurationSource: 'IIQServer',
5250
domainName: "currentDomain.com",
53-
gamPredictReporting: false
5451
}
5552
});
5653
```
@@ -91,7 +88,9 @@ originalCpm: 1.5, // Original CPM value.
9188
originalCurrency: 'USD', // Original currency.
9289
status: 'rendered', // Auction status, e.g., 'rendered'.
9390
placementId: 'div-1' // ID of the ad placement.
94-
adType: 'banner' // Specifies the type of ad served
91+
adType: 'banner', // Specifies the type of ad served
92+
size: '320x250', // Size of adUnit item,
93+
pos: 0 // The following values are defined in the ORTB 2.5 spec
9594
}
9695
```
9796

@@ -109,6 +108,8 @@ adType: 'banner' // Specifies the type of ad served
109108
| status | String | Status of the impression. Leave empty or undefined if Prebid is not the bidding platform | rendered | No |
110109
| placementId | String | Unique identifier of the ad unit on the webpage that showed this ad | div-1 | No |
111110
| adType | String | Specifies the type of ad served. Possible values: “banner“, “video“, “native“, “audio“. | banner | No |
111+
| size | String | Size of adUnit item | 320x250 | No |
112+
| pos | number | The pos field specifies the position of the adUnit on the page according to the OpenRTB 2.5 specification | 0 | No |
112113

113114
To report the auction win, call the function as follows:
114115

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ Please find below list of parameters that could be used in configuring Intent IQ
5858
| params. ABTestingConfigurationSource| Optional | String | Determines how AB group will be defined. Possible values: `"IIQServer"` – group defined by IIQ server, `"percentage"` – generated group based on abPercentage, `"group"` – define group based on value provided by partner. | `IIQServer` |
5959
| params.abPercentage | Optional | Number | Percentage for A/B testing group. Default value is `95` | `95` |
6060
| params.group | Optional | String | Define group provided by partner, possible values: `"A"`, `"B"` | `"A"` |
61+
| 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"` |
6162
| 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] } ]` |
6263
| params.additionalParams [0].parameterName | Required | String | Name of the custom parameter. This will be sent as a query parameter. | `"abc"` |
6364
| params.additionalParams [0].parameterValue | Required | String / Number | Value to assign to the parameter. | `123` |
@@ -83,6 +84,7 @@ pbjs.setConfig({
8384
sourceMetaDataExternal: 123456, // Optional parameter
8485
chTimeout: 10, // Optional parameter
8586
abPercentage: 95, // Optional parameter
87+
region: "gdpr", // Optional parameter
8688
additionalParams: [ // Optional parameter
8789
{
8890
parameterName: "abc",

0 commit comments

Comments
 (0)