You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`sizes`| Required | Array[Number] or Array[Array[Number]]| All sizes this ad unit can accept. Examples: `[400, 600]`, `[[300, 250], [300, 600]]`. Prebid recommends that the sizes auctioned by Prebid should be the same auctioned by AdX and GAM OpenBidding, which means AdUnit sizes should match the GPT sizes. |
87
+
|`sizes`| Required if `format` is not provided | Array[Number] or Array[Array[Number]]| All sizes this ad unit can accept. Examples: `[400, 600]`, `[[300, 250], [300, 600]]`. Prebid recommends that the sizes auctioned by Prebid should be the same auctioned by AdX and GAM OpenBidding, which means AdUnit sizes should match the GPT sizes. |
88
+
|`format`| Required if `sizes` is not provided | Array of ORTB [Format](https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#objectformat) objects | Alternative to `sizes`, and takes precedence over it. Allows for more options, such as . |
|`name`| Optional | String | Name for this banner ad unit. Can be used for testing and debugging. |
90
91
@@ -222,6 +223,41 @@ pbjs.addAdUnits({
222
223
});
223
224
```
224
225
226
+
#### Flex banner example
227
+
228
+
See the [Google request object documentation](https://developers.google.com/authorized-buyers/rtb/openrtb-guide#flexslot-object) for additional details. These fields were removed from OpenRTB 2.6 but remain popular.
Copy file name to clipboardExpand all lines: dev-docs/analytics/intentiq.md
+17-19Lines changed: 17 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,13 +17,28 @@ No registration for this module is required.
17
17
18
18
**IMPORTANT**: only effective when Intent IQ Universal ID module be installed and configured. [(How-To)](https://docs.prebid.org/dev-docs/modules/userid-submodules/intentiq.html)
19
19
20
-
No additional configuration for this module is required. We will use the configuration provided for Intent IQ Universal IQ module.
20
+
### Analytics Options
21
+
22
+
{: .table .table-bordered .table-striped }
23
+
| Parameter | Scope | Type | Description | Example |
24
+
| --- | --- | --- | --- | --- |
25
+
| options.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. |`false`|
26
+
| options.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"`|
27
+
| options.reportingServerAddress | Optional | String | The base URL for the IntentIQ reporting server. If parameter is provided in `configParams`, it will be used. |`"https://domain.com"`|
28
+
| options.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`|
29
+
| options.gamPredictReporting | Optional | Boolean | This variable controls whether the GAM prediction logic is enabled or disabled. The main purpose of this logic is to extract information from a rendered GAM slot when no Prebid bidWon event is available. In that case, we take the highest CPM from the current auction and add 0.01 to that value. |`false`|
21
30
22
31
#### Example Configuration
23
32
24
33
```js
25
34
pbjs.enableAnalytics({
26
-
provider:'iiqAnalytics'
35
+
provider:'iiqAnalytics',
36
+
options: {
37
+
manualWinReportEnabled:false,
38
+
reportMethod:"GET",
39
+
adUnitConfig:1,
40
+
gamPredictReporting:false
41
+
}
27
42
});
28
43
```
29
44
@@ -33,23 +48,6 @@ The reportExternalWin function allows for manual reporting, meaning that reports
33
48
34
49
To enable this manual reporting functionality, you must set the manualWinReportEnabled parameter in Intent IQ Unified ID module configuration is true. Once enabled, reports can be manually triggered using the reportExternalWin function.
35
50
36
-
```js
37
-
pbjs.setConfig({
38
-
userSync: {
39
-
userIds: [{
40
-
name:"intentIqId",
41
-
params: {
42
-
partner:123456, // valid partner id
43
-
browserBlackList:"chrome",
44
-
manualWinReportEnabled:true
45
-
}
46
-
}]
47
-
}
48
-
});
49
-
```
50
-
51
-
You can find more information and configuration examples in the [Intent IQ Universal ID module](https://docs.prebid.org/dev-docs/modules/userid-submodules/intentiq.html#configuration)
52
-
53
51
### Calling the reportExternalWin Function
54
52
55
53
To call the reportExternalWin function, you need to pass the partner_id parameter as shown in the example below:
***Bid ID** is unique across ad units and bidders.
323
324
***auctionId** (see [note](#tid-warning)) is unique per call to `requestBids()`, but is the same across ad units and bidders.
324
325
***Transaction ID** (see [note](#tid-warning)) is unique for each ad unit within a call to `requestBids()`, but same across bidders. This is the ID that enables DSPs to recognize the same impression coming in from different supply sources.
326
+
***Page view ID** is unique for a page view (one load of Prebid); can also be refreshed programmatically. Shared across all requests and responses within the page view, for the same bidder. Different bidders see a different page view ID.
325
327
***Bid Request Count** is the number of times `requestBids()` has been called for this ad unit.
326
328
***Bidder Request Count** is the number of times `requestBids()` has been called for this ad unit and bidder.
327
329
***Auctions Count** is the number of times `requestBids()` has been called for this ad unit excluding the duplicates generated by twin adUnits.
@@ -340,6 +342,7 @@ Here is a sample bidderRequest object:
|`requestId`| Required | The bid ID that was sent to `spec.buildRequests` as `bidRequests[].bidId`. Used to tie this bid back to the request. | 12345 |
515
-
|`cpm`| Required | The bid price. We recommend the most granular price a bidder can provide | 3.5764 |
516
-
|`currency`| Required | 3-letter ISO 4217 code defining the currency of the bid. |`"EUR"`|
517
-
|`width`| Required | The width of the returned creative. For video, this is the player width. | 300 |
518
-
|`height`| Required | The height of the returned creative. For video, this is the player height. | 250 |
517
+
|`requestId`| Required | The bid ID that was sent to `spec.buildRequests` as `bidRequests[].bidId`. Used to tie this bid back to the request. | 12345 |
518
+
|`cpm`| Required | The bid price. We recommend the most granular price a bidder can provide | 3.5764 |
519
+
|`currency`| Required | 3-letter ISO 4217 code defining the currency of the bid. |`"EUR"`|
520
+
|`width`| Required except when using `wratio` / `hratio`| The width of the returned creative. For video, this is the player width. | 300 |
521
+
|`height`| Required except when using `wratio` / `hratio`| The height of the returned creative. For video, this is the player height. | 250 |
522
+
|`wratio`| Required for flex ads | For flexible banner only, the relative width of the creative | 6 |
523
+
|`hratio`| Required for flex ads | For flexible banner only, the relative height of the creative | 5 |
519
524
|`ad`| Required | The creative payload of the returned bid. |`"<html><h3>I am an ad</h3></html>"`|
520
525
|`ttl`| Required | Time-to-Live - how long (in seconds) Prebid can use this bid. See the [FAQ entry](/dev-docs/faq.html#does-prebidjs-cache-bids) for more info. | 360 |
521
526
|`creativeId`| Required | A bidder-specific unique code that supports tracing the ad creative back to the source. |`"123abc"`|
@@ -720,6 +725,7 @@ Sample data received by this function:
If you have any issues with setting up the AdOcean bidder, please contact with your local Technical Support team or by visiting [AdOcean website](https://adocean-global.com/en/contact/).
0 commit comments