Skip to content

Commit

Permalink
Update OpenX docs with native support
Browse files Browse the repository at this point in the history
  • Loading branch information
gmiedlar-ox committed Jan 23, 2025
1 parent f985cef commit 4379257
Showing 1 changed file with 85 additions and 1 deletion.
86 changes: 85 additions & 1 deletion dev-docs/bidders/openx.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Prebid OpenX Bidder Adaptor
pbjs: true
pbs: true
biddercode: openx
media_types: banner, video
media_types: banner, video, native
schain_supported: true
tcfeu_supported: true
usp_supported: true
Expand Down Expand Up @@ -154,6 +154,63 @@ var videoAdUnits = [
}]
```

#### Native

{: .table .table-bordered .table-striped }

| Name | Scope | Description | Example | Type |
| ---- | ----- | ----------- | ------- | ---- |
| `delDomain` ~~or `platform`~~** | required | OpenX delivery domain provided by your OpenX representative. | "PUBLISHER-d.openx.net" | String |
| `unit` | required | OpenX ad unit ID provided by your OpenX representative. | "1611023122" | String |
| `customParams` | optional | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}` | Object |
| `customFloor` | optional | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50 <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue.<br/><br/>Note:<br/> OpenX suggests using the [Price Floor Module](/dev-docs/modules/floors.html) instead of customFloor. The Price Floor Module is prioritized over customFloor if both are present. | 1.50 | Number |
| `doNotTrack` | optional | Prevents advertiser from using data for this user. <br/><br/> **WARNING:**<br/> Impacts all bids in the request. May impact revenue. | true | Boolean |
| `coppa` | optional | Enables Child's Online Privacy Protection Act (COPPA) regulations. **WARNING:**<br/> Impacts all bids in the request. May impact revenue. | true | Boolean |

** platform is deprecated. Please use delDomain instead. If you have any questions please contact your representative.

### AdUnit Format for Native

```javascript
var adUnits = [
{
code: 'test-div-native',
mediaTypes: {
native: {
ortb: {
assets: [
{
id: 1,
required: 1,
img: {
type: 3,
w: 150,
h: 50,
}
}, {
id: 2,
required: 1,
title: {
len: 80
}
}
]
}
}
},
bids: [
{
bidder: 'openx',
params: {
unit: '539439964',
delDomain: 'se-demo-d.openx.net'
}
}
]
}
];
```

### Example

```javascript
Expand Down Expand Up @@ -202,6 +259,33 @@ var adUnits = [
delDomain: 'PUBLISHER-d.openx.net'
}
}]
},
{
code: 'native1',
mediaTypes: {
native: {
ortb: {
assets: [
{
id: 1,
required: 1,
img: {
type: 3,
w: 150,
h: 50,
}
}
]
}
}
},
bids: [{
bidder: 'openx',
params: {
unit: '539439964',
delDomain: 'se-demo-d.openx.net'
}
}]
}
];
```
Expand Down

0 comments on commit 4379257

Please sign in to comment.