Skip to content

Commit c735f37

Browse files
m-figurski-allegrom-figurski-allegro
authored
Merge branch 'master' into master
2 parents 5a91ae1 + 41fdfe3 commit c735f37

File tree

14 files changed

+481
-109
lines changed

14 files changed

+481
-109
lines changed

‎dev-docs/adunit-reference.md‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ See the table below for the list of properties in the `mediaTypes` object of the
8484
{: .table .table-bordered .table-striped }
8585
| Name | Scope | Type | Description |
8686
|---------+----------+---------------------------------------+-----------------------------------------------------------------------------------------|
87-
| `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 . |
8889
| `pos` | Optional | Integer | OpenRTB page position value: 0=unknown, 1=above-the-fold, 3=below-the-fold, 4=header, 5=footer, 6=sidebar, 7=full-screen |
8990
| `name` | Optional | String | Name for this banner ad unit. Can be used for testing and debugging. |
9091

@@ -222,6 +223,41 @@ pbjs.addAdUnits({
222223
});
223224
```
224225

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.
229+
230+
```javascript
231+
pbjs.addAdUnits({
232+
code: slot.code,
233+
mediaTypes: {
234+
banner: {
235+
expdir: [1, 2, 3, 4],
236+
format: [{w: 250, h: 250}],
237+
wmin: 250,
238+
wmax: 375,
239+
hmin: 250,
240+
hmax: 250,
241+
},
242+
},
243+
ortb2Imp: {
244+
banner: {
245+
ext: {
246+
flexslot: {
247+
wmin: 250,
248+
wmax: 375,
249+
hmin: 250,
250+
hmax: 250
251+
}
252+
}
253+
}
254+
},
255+
bids: [
256+
// ...
257+
]
258+
})
259+
```
260+
225261
<a name="adUnit-video-example"></a>
226262

227263
### Video

‎dev-docs/analytics/intentiq.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,28 @@ No registration for this module is required.
1717

1818
**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)
1919

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` |
2130

2231
#### Example Configuration
2332

2433
```js
2534
pbjs.enableAnalytics({
26-
provider: 'iiqAnalytics'
35+
provider: 'iiqAnalytics',
36+
options: {
37+
manualWinReportEnabled: false,
38+
reportMethod: "GET",
39+
adUnitConfig: 1,
40+
gamPredictReporting: false
41+
}
2742
});
2843
```
2944

@@ -33,23 +48,6 @@ The reportExternalWin function allows for manual reporting, meaning that reports
3348

3449
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.
3550

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-
5351
### Calling the reportExternalWin Function
5452

5553
To call the reportExternalWin function, you need to pass the partner_id parameter as shown in the example below:

‎dev-docs/bidder-adaptor.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,7 @@ Here is a sample array entry for `validBidRequests[]`:
301301
bidId: "22c4871113f461",
302302
bidder: "rubicon",
303303
bidderRequestId: "15246a574e859f",
304+
pageViewId: 'de48e8d1-25e1-487c-96c6-41fcef84b41b',
304305
bidRequestsCount: 1,
305306
bidderRequestsCount: 1,
306307
auctionsCount: 1,
@@ -322,6 +323,7 @@ Other notes:
322323
* **Bid ID** is unique across ad units and bidders.
323324
* **auctionId** (see [note](#tid-warning)) is unique per call to `requestBids()`, but is the same across ad units and bidders.
324325
* **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.
325327
* **Bid Request Count** is the number of times `requestBids()` has been called for this ad unit.
326328
* **Bidder Request Count** is the number of times `requestBids()` has been called for this ad unit and bidder.
327329
* **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:
340342
auctionStart: 1579746300522,
341343
bidderCode: "myBidderCode",
342344
bidderRequestId: "15246a574e859f",
345+
pageViewId: 'de48e8d1-25e1-487c-96c6-41fcef84b41b',
343346
bids: [{...}],
344347
gdprConsent: {consentString: "BOtmiBKOtmiBKABABAENAFAAAAACeAAA", vendorData: {...}, gdprApplies: true},
345348
ortb2: {...},
@@ -511,11 +514,13 @@ The parameters of the `bidResponse` object are:
511514

512515
| Key | Scope | Description | Example |
513516
|--------------+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------|
514-
| `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 |
519524
| `ad` | Required | The creative payload of the returned bid. | `"<html><h3>I am an ad</h3></html>"` |
520525
| `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 |
521526
| `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:
720725
auctionStart: 1579746300522,
721726
bidderCode: "myBidderCode",
722727
bidderRequestId: "15246a574e859f",
728+
pageViewId: 'de48e8d1-25e1-487c-96c6-41fcef84b41b',
723729
bids: [{...}],
724730
gdprConsent: {consentString: "BOtmiBKOtmiBKABABAENAFAAAAACeAAA", vendorData: {...}, gdprApplies: true},
725731
refererInfo: {

‎dev-docs/bidders/performist.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: bidder
3+
title: Performist
4+
description: Prebid Performist Bidder Adaptor
5+
biddercode: performist
6+
pbjs: false
7+
pbs: true
8+
media_types: video, banner
9+
userIds: all
10+
fpd_supported: false
11+
tcfeu_supported: false
12+
usp_supported: true
13+
coppa_supported: true
14+
schain_supported: true
15+
prebid_member: false
16+
ortb_blocking_supported: true
17+
multiformat_supported: will-bid-on-one
18+
floors_supported: false
19+
aliasCode: limelightDigital
20+
sidebarType: 1
21+
---
22+
23+
### Bid Params
24+
25+
{: .table .table-bordered .table-striped }
26+
27+
| Name | Scope | Description | Example | Type |
28+
|:--------------|:---------|:--------------------------------------------------------------|:-----------------------|:----------|
29+
| `publisherId` | required | Publisher ID | `'12345'` | `string` |
30+
| `custom1` | optional | Custom targeting field 1 | `'custom1'` | `string` |
31+
| `custom2` | optional | Custom targeting field 2 | `'custom2'` | `string` |
32+
| `custom3` | optional | Custom targeting field 3 | `'custom3'` | `string` |
33+
| `custom4` | optional | Custom targeting field 4 | `'custom4'` | `string` |
34+
| `custom5` | optional | Custom targeting field 5 | `'custom5'` | `string` |
35+
36+
Performist server-side Prebid Server adapter requires only `publisherId` and `host` parameters.
37+
Performist server-side Prebid Server adapter supports only `banner`, `video`, `audio`, `native` media types.

‎dev-docs/bidders/publicgood.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: bidder
3+
title: Public Good
4+
description: Public Gppd Bid Adapter
5+
biddercode: publicgood
6+
tcfeu_supported: false
7+
dsa_supported: false
8+
gvl_id: none
9+
usp_supported: false
10+
coppa_supported: false
11+
gpp_sids: none
12+
schain_supported: false
13+
dchain_supported: false
14+
userId: none
15+
media_types: banner
16+
safeframes_ok: true
17+
deals_supported: false
18+
floors_supported: false
19+
fpd_supported: false
20+
pbjs: true
21+
pbs: false
22+
prebid_member: false
23+
multiformat_supported: will-bid-on-one
24+
ortb_blocking_supported: false
25+
privacy_sandbox: no
26+
sidebarType: 1
27+
---
28+
29+
### Bid params
30+
31+
{: .table .table-bordered .table-striped }
32+
33+
| Name | Scope | Description | Example | Type |
34+
|-------------|----------|--------------------------------------------------------------------------------------------------------------|-------------------------------|---------------|
35+
| `partnerId` | required | Publisher ID | `'prebid-test'` | `string` |
36+
| `slotId` | required | Slot ID = 'all' unless negotiated otherwise | `'all'` | `string` |

‎dev-docs/bidders/topon.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
layout: bidder
3+
title: TopOn
4+
description: Prebid TopOn Bidder Adaptor
5+
biddercode: topon
6+
media_types: banner
7+
tcfeu_supported: false
8+
usp_supported: check with bidder
9+
coppa_supported: true
10+
gpp_supported: check with bidder
11+
schain_supported: true
12+
dchain_supported: false
13+
floors_supported: check with bidder
14+
userIds: false
15+
prebid_member: false
16+
safeframes_ok: false
17+
deals_supported: false
18+
pbjs: true
19+
pbs: false
20+
pbs_app_supported: false
21+
fpd_supported: false
22+
ortb_blocking_supported: false
23+
gvl_id: 1305
24+
multiformat_supported: false
25+
sidebarType: 1
26+
endpoint_compression: check with bidder
27+
---
28+
29+
### Table of contents
30+
31+
- [Introduction](#introduction)
32+
- [Bid Params](#bid-params)
33+
- [Banner](#banner)
34+
35+
### Introduction
36+
37+
Publishers can use Prebid.js to call TopOn in any of the following ways:
38+
39+
- **Call through our client-side adapter**: Prebid.js calls TopOn directly from the browser using our client-side adapter.
40+
41+
### Bid Params
42+
43+
{: .table .table-bordered .table-striped }
44+
| Name | Scope | Description | Example | Type |
45+
|-----------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|--------------------|
46+
| `pubid` | required | TopOn-specific identifier associated with your account | `'e005f4d49dd3'` | `string` |
47+
48+
### Banner
49+
50+
```javascript
51+
var adUnits = [
52+
{
53+
code: "test-div",
54+
mediaTypes: {
55+
banner: {
56+
sizes: [
57+
[300, 250],
58+
[300, 600],
59+
],
60+
},
61+
},
62+
bids: [
63+
{
64+
bidder: "topon",
65+
params: {
66+
pubid: "e005f4d49dd3", // required
67+
},
68+
},
69+
],
70+
},
71+
];
72+
```

‎dev-docs/bidders/yieldmo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The Yieldmo adapter supports in-stream video as of Prebid v4.18. Out-stream will
4040
| `maxduration` | required | Maximum ad duration in seconds | `20` | `integer` |
4141
| `minduration` | optional | Minimum ad duration in seconds | `5` | `integer` |
4242
| `pos` | optional | Ad position on screen; see [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf), List 5.4 for more details | `1` | `integer` |
43-
| `startdelay` | required for in-stream | Duration offset (in second) from the start of the content for showing the video ad before the start of the Video. Pre-roll: `0` (default); Mid-roll: `>0`; Default mid-roll: `-1`; Post-roll: `-2`; <br/><br/> For out-stream is' always `0`| `5` | `integer` |
43+
| `startdelay` | optional | Start delay of the video ad in seconds. Values follow OpenRTB 2.5 §5.12: `0` = Pre-Roll; `>0` = Mid-Roll (value is the start delay); `-1` = Generic Mid-Roll; `-2` = Generic Post-Roll. | `5` | `integer` |
4444
| `protocols` | required | Supported video bid response protocols. VAST 1.0: `1`; VAST 2.0: `2`; VAST 3.0: `3`; VAST 1.0 Wrapper: `4`; VAST 2.0 Wrapper: `5`; VAST 3.0 Wrapper: `6`; | `[2, 3]` | `Array<integer>` |
4545
| `api` | required | API frameworks supported. VPAID 1.0: `1`; VPAID 2.0: `2`; MRAID-1: `3`; ORMMA: `4`; MRAID-2: `5`; MRAID-3: `6`; | `[1, 2]` | `Array<integer>` |
4646
| `playbackmethod` | required | Playback methods that may be in use; see [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf), List 5.10 for more details. Out-stream is only always `2` | `[2,6]` | `Array<integer>` |

0 commit comments

Comments
 (0)