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
Floxis Bid Adapter: redesign to seat-based architecture with ortbConverter
Major rewrite replacing teqblazeUtils with ortbConverter for ORTB 2.x compliance.
Changes:
- New params: seat (required), region (required), partner (required)
- Endpoint URL: https://{subdomain}.floxis.tech/pbjs?seat={seat}
- subdomain = region for 'floxis' partner
- subdomain = {partner}-{region} for white-label partners
- ORTB-native implementation with Floors Module support
- 40 comprehensive tests with full code coverage
- Updated documentation with examples
Addresses all PR #13934 review comments from @osazos
Copy file name to clipboardExpand all lines: modules/FloxisBidAdapter.md
+19-70Lines changed: 19 additions & 70 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,84 +2,31 @@
2
2
3
3
```
4
4
Module Name: Floxis Bidder Adapter
5
-
Module Type: Floxis Bidder Adapter
5
+
Module Type: Bidder Adapter
6
6
Maintainer: admin@floxis.tech
7
7
```
8
+
8
9
# Description
9
10
10
-
The Floxis Bid Adapter enables integration with the Floxis programmatic advertising platform via Prebid.js. It supports banner, video (instream and outstream), and native formats, and is designed for multi-partner, multi-region use.
11
+
The Floxis Bid Adapter enables integration with the Floxis programmatic advertising platform via Prebid.js. It supports banner, video (instream and outstream), and native formats.
11
12
12
13
**Key Features:**
13
14
- Banner, Video and Native ad support
14
15
- OpenRTB 2.x compliant
15
-
- Privacy regulation compliance
16
-
17
-
## Required Params
18
-
-`partner` (string): Partner name
19
-
-`placementId` (integer): Placement identifier
20
-
21
-
## OpenRTB Blocking Params Support
22
-
FloxisBidAdapter supports OpenRTB blocking parameters. You can pass the following optional params in your ad unit config:
These will be included in the OpenRTB request and imp objects as appropriate.
29
-
30
-
**Example:**
31
-
```javascript
32
-
pbjs.addAdUnits([
33
-
{
34
-
code:'adunit-20',
35
-
mediaTypes: { banner: { sizes: [[300, 250]] } },
36
-
bids: [{
37
-
bidder:'floxis',
38
-
params: {
39
-
partner:'floxis',
40
-
placementId:555,
41
-
bcat: ['IAB1-1', 'IAB1-2'],
42
-
badv: ['example.com', 'test.com'],
43
-
bapp: ['com.example.app'],
44
-
battr: [1, 2, 3]
45
-
}
46
-
}]
47
-
}
48
-
]);
49
-
```
19
+
## Supported Media Types
20
+
- Banner
21
+
- Video
22
+
- Native
50
23
51
24
## Floors Module Support
52
-
FloxisBidAdapter supports Prebid.js Floors Module. If a bid request provides a floor value via the Floors Module (`getFloor` function), it will be sent in the OpenRTB request as `imp.bidfloor` and `imp.bidfloorcur`. If not, you can also set a static floor using `params.bidFloor`.
53
-
54
-
**Example with Floors Module:**
55
-
```javascript
56
-
pbjs.addAdUnits([
57
-
{
58
-
code:'adunit-1',
59
-
mediaTypes: { banner: { sizes: [[300, 250]] } },
60
-
bids: [{
61
-
bidder:'floxis',
62
-
params: {
63
-
partner:'floxis',
64
-
placementId:1,
65
-
bidFloor:2.5// optional static floor
66
-
},
67
-
getFloor:function({currency, mediaType, size}) {
68
-
return { floor:2.5, currency:'USD' };
69
-
}
70
-
}]
71
-
}
72
-
]);
73
-
```
25
+
The Floxis Bid Adapter supports the Prebid.js [Floors Module](https://docs.prebid.org/dev-docs/modules/floors.html). Floor values are automatically included in the OpenRTB request as `imp.bidfloor` and `imp.bidfloorcur`.
74
26
75
27
## Privacy
76
28
Privacy fields (GDPR, USP, GPP, COPPA) are handled by Prebid.js core and automatically included in the OpenRTB request.
77
29
78
-
## Supported Media Types
79
-
- Banner
80
-
- Video
81
-
- Native
82
-
83
30
## Example Usage
84
31
```javascript
85
32
pbjs.addAdUnits([
@@ -89,22 +36,24 @@ pbjs.addAdUnits([
89
36
bids: [{
90
37
bidder:'floxis',
91
38
params: {
92
-
partner:'floxis',
93
-
placementId:1
39
+
seat:'testSeat',
40
+
region:'us-e',
41
+
partner:'floxis'
94
42
}
95
43
}]
96
44
}
97
45
]);
98
46
```
99
47
100
-
101
48
# Configuration
102
-
## Required Parameters
49
+
50
+
## Parameters
103
51
104
52
| Name | Scope | Description | Example | Type |
105
53
| --- | --- | --- | --- | --- |
106
-
|`partner`| required | Partner identifier provided by Floxis |`floxis`|`string`|
107
-
|`placementId`| required | Placement identifier provided by Floxis |`1`|`int`|
Unit tests are provided in `test/spec/modules/floxisBidAdapter_spec.js` and cover validation, request building, and response interpretation.
59
+
Unit tests are provided in `test/spec/modules/floxisBidAdapter_spec.js` and cover validation, request building, response interpretation, and bid-won notifications.
0 commit comments