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
|`keywords`| optional | A key-value applied only to the configured bid. This value is optional. Strings separated by semicolon. |`car=mercedes;car=audi;`|`string`|
31
-
|`player`| optional | Object containing video targeting parameters. See [Video Object](#ra-video-object) for details. |`player: {init: 'open', end: 'close', skin: 'dark'}`|`object`|
Copy file name to clipboardExpand all lines: dev-docs/modules/floors.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,26 @@ Notes:
58
58
*[Prebid Floor Service Providers](/dev-docs/modules/floors.html#floors-providers)
59
59
*[Transcript of this video](/dev-docs/floors-video-overview.html)
60
60
61
+
### Simple Static Floors
62
+
63
+
Some publishers just want to set a simple static floor. Please don't use this module for that. This module should only be used when you need to vary the floor by mediatype, size, etc. Here's how you can set static floors on each Prebid adunit:
64
+
65
+
```javascript
66
+
pbjs.addAdUnits({
67
+
code:"test-div",
68
+
mediaTypes: {
69
+
banner: {
70
+
sizes: [[300,250]]
71
+
}
72
+
},
73
+
ortb2Imp: {
74
+
bidfloor:1.00,
75
+
bidfloorcur:"EUR"
76
+
},
77
+
// ...
78
+
});
79
+
```
80
+
61
81
## How it Works
62
82
63
83
There are several places where the Floor module changes the behavior of the Prebid.js auction process. Below is a diagram describing the general flow of the client-side Price Floors Module:
@@ -298,10 +318,13 @@ Schema 1 restricts floors providers or publishers to applying only one data grou
298
318
Note: if you're a dynamic floor provider service, your response must be
299
319
a subset that will be merged under the 'data' object.
300
320
321
+
{: .alert.alert-warning :}
322
+
You **cannot** set the `floorMin` parameter without specifying a `data` object. See the [simple static floor](/dev-docs/modules/floors.html#simple-static-floors) section above for more info.
323
+
301
324
{: .table .table-bordered .table-striped }
302
325
| Param | Type | Description | Default |
303
326
|---+---+---+---+---|
304
-
| floorMin | float | The mimimum CPM floor used by the Price Floors Module (as of 4.13). The Price Floors Module will take the greater of floorMin and the matched rule CPM when evaluating getFloor() and enforcing floors. | - |
327
+
| floorMin | float | The mimimum CPM floor used by the Price Floors Module (as of 4.13). The Price Floors Module will take the greater of floorMin and the matched rule CPM when evaluating getFloor() and enforcing floors. **Note**: this is not a method of setting a [static floor](/dev-docs/modules/floors.html#simple-static-floors). | - |
305
328
| floorProvider | string | Optional atribute (as of prebid version 4.1) used to signal to the Floor Provider's Analytics adapter their floors are being applied. They can opt to log only floors that are applied when they are the provider. If floorProvider is supplied in both the top level of the floors object and within the data object, the data object's configuration shall prevail.| - |
306
329
| enforcement | object | Controls the enforcement behavior within the Price Floors Module.| - |
307
330
| skipRate | integer | skipRate is a random function whose input value is any integer 0 through 100 to determine when to skip all floor logic, where 0 is always use floor data and 100 is always skip floor data. The use case is for publishers or floor providers to learn bid behavior when floors are applied or skipped. Analytics adapters will have access to model version (if defined) when skipped is true to signal the Price Floors Module is in floors mode. If skipRate is supplied in both the root level of the floors object and within the data object, the skipRate configuration within the data object shall prevail. | 0 |
@@ -354,10 +377,13 @@ While some attributes are common in both schema versions, for completeness, all
354
377
Note: if you're a dynamic floor provider service, your response must be
355
378
a subset that will be merged under the 'data' object.
356
379
380
+
{: .alert.alert-warning :}
381
+
You **cannot** set the `floorMin` parameter without specifying a `data` object. See the [simple static floor](/dev-docs/modules/floors.html#simple-static-floors) section above for more info.
382
+
357
383
{: .table .table-bordered .table-striped }
358
384
| Param | Type | Description | Default |
359
385
|---+---+---+---+---|
360
-
| floorMin | float | The mimimum CPM floor used by the module (as of 4.13). The module will take the greater of floorMin and the matched rule CPM when evaluating getFloor() and enforcing floors. | - |
386
+
| floorMin | float | The mimimum CPM floor used by the module (as of 4.13). The module will take the greater of floorMin and the matched rule CPM when evaluating getFloor() and enforcing floors. **Note**: this is not a method of setting a [static floor](/dev-docs/modules/floors.html#simple-static-floors). | - |
361
387
| floorMinCur | float | Prebid Server only: the currency used for the floorMin value. | - |
362
388
| floorProvider | string | Optional atribute (as of prebid version 4.1) used to signal to the Floor Provider's Analytics adapter their floors are being applied. They can opt to log only floors that are applied when they are the provider. If floorProvider is supplied in both the top level of the floors object and within the data object, the data object's configuration shall prevail.| - |
363
389
| skipRate | integer | skipRate is a random function whose input value is any integer 0 through 100 to determine when to skip all floor logic, where 0 is always use floor data and 100 is always skip floor data. The use case is for publishers or floor providers to learn bid behavior when floors are applied or skipped. Analytics adapters will have access to model version (if defined) when skipped is true to signal the module is in floors mode. If skipRate is supplied in both the root level of the floors object and within the data object, the skipRate configuration within the data object shall prevail. | 0 |
1. If the bid adapter YAML declares support of multiformat, then `prefmtype` is ignored in the request. The default value of multiformat supported is `true`.
1894
+
1. If the bid adapter YAML declares support of multiformat as `true`, then `prefmtype` is ignored in the request. The default value of multiformat supported is `false`.
1895
1895
1. If the bidder declares that they don't support multiformat and the incoming request contains multiple formats, then one of the formats is chosen by either `$.ext.prebid.biddercontrols.BIDDER.prefmtype` or config `auction.preferredmediatype.BIDDER`
1896
+
1. If multiformat-supported is false, and if the specified prefmtype is not part of the request, then the imp doesn't go out to the bidder.
Copy file name to clipboardExpand all lines: prebid-server/features/pbs-activitycontrols.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -186,7 +186,7 @@ Here's the list of the 'potentially restricted activities' that Prebid Server co
186
186
|`fetchBids`| A bid adapter wants to participate in an auction | Bidder is removed from the auction |
187
187
|`enrichUfpd`| A module wants to add user first party data to outgoing requests (`user.data` and `user.ext.data` in ORTB) | Module is not allowed to run. |
188
188
|`reportAnalytics`| The [/auction](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html), [/amp](/prebid-server/endpoints/openrtb2/pbs-endpoint-amp.html), or [/event](/prebid-server/endpoints/pbs-endpoint-event.html) endpoint is about to call an analytics adapter. | Adapter is not called. |
189
-
|`transmitUfpd`| A bid adapter, analytics adapter, or module wants to access and/or transmit user FPD to their endpoint. (Note: this is combined with transmitEids in PBS-Go and PBJ-Java 2.11 and under) | User FPD and EIDs are hidden from the adapter or module: `user.{id, buyeruid, yob, gender, geo, eids, data}`, `user.ext.data`, `device.{device.ifa, macsha1, macmd5, dpidsha1, dpidmd5, didsha1, didmd5}`|
189
+
|`transmitUfpd`| A bid adapter, analytics adapter, or module wants to access and/or transmit user FPD to their endpoint. (Note: this is combined with transmitEids in PBS-Go and PBJ-Java 2.11 and under) | User FPD and EIDs are hidden from the adapter or module: `user.{id, buyeruid, yob, gender, geo, eids, data}`, `user.ext.data`, `device.{ifa, macsha1, macmd5, dpidsha1, dpidmd5, didsha1, didmd5}`|
190
190
|`transmitEids`| (PBS-Java 2.12 and later) A bid adapter, analytics adapter, or module wants to access and/or transmit extended IDs to their endpoint. | User EIDs are hidden from the adapter or module: `user.eids`, `user.ext.eids`|
191
191
|`transmitPreciseGeo`| A bid adapter, analytics adapter, or module wants to access and/or transmit precise geolocation data to their endpoint | device.geo latitude, longitude, and IP address are rounded off. Specifically, lat and long are truncated to two decimal places, IPv4 masks rightmost 8 bits, IPv6 masks the rightmost bits based on a configured value. In PBS-Java 3.0 and later, device.geo.{country,region,utcoffset} are preserved, but device.geo.{metro,city,zip,accuracy,ipservice,ext} are removed.|
192
192
|`transmitTid`| (PBS-Java only) The source.tid and imp.ext.tid fields can be generated or suppressed by PBS before going to bidders. The ext.prebid.createtid request parameter overrides the allow state of this activity. If `ext.prebid.createtid:false`, transmitTid is "denied". | If "allowed", then source.tid and imp.ext.tid will be generated by PBS. Otherwise, they won't be generated. |
Copy file name to clipboardExpand all lines: prebid-server/features/pbs-floors.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -153,6 +153,9 @@ completely backwards-compatible -- PBS will accept and process any Prebid.js flo
153
153
154
154
### Defining Floor data
155
155
156
+
{: .alert.alert-warning :}
157
+
You **cannot** set the `floorMin` parameter without specifying a `data` object. See the [simple static floor](/dev-docs/modules/floors.html#simple-static-floors) section for more info.
158
+
156
159
As described in the [Signaling](#floor-signaling) section above, floor data may be defined in several ways. Here's the order of priority:
157
160
158
161
1. Dynamic data - if PBS finds recent (non-expired) floors data from a dynamic floors vendor, that takes precedence.
0 commit comments