From 182dc2298cc5ca17760fe767951e673f54fe4080 Mon Sep 17 00:00:00 2001 From: Jimmy Tu Date: Wed, 11 Jul 2018 13:44:10 -0700 Subject: [PATCH 1/3] OpenX: Update Documentation to be similar with adapter readme --- dev-docs/bidders/openx.md | 71 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 69 insertions(+), 2 deletions(-) diff --git a/dev-docs/bidders/openx.md b/dev-docs/bidders/openx.md index 5255f75350..fb1bc327cb 100644 --- a/dev-docs/bidders/openx.md +++ b/dev-docs/bidders/openx.md @@ -14,7 +14,20 @@ gdpr_supported: true -### bid params +### Bid Parameters +#### Banner + +{: .table .table-bordered .table-striped } +| Name | Scope | Type | Description | Example +| ---- | ----- | ---- | ----------- | ------- +| `delDomain` | required | String | OpenX delivery domain provided by your OpenX representative. | "PUBLISHER-d.openx.net" +| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122" +| `customParams` | optional | Object | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}` +| `customFloor` | optional | Number | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50

**WARNING:**
Misuse of this parameter can impact revenue | 1.50 +| `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user.

**WARNING:**
Request-level setting. May impact revenue. | true +| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. | true + +#### Video {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | @@ -26,8 +39,57 @@ gdpr_supported: true | `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 | `1.50` | `float` | +# Example +```javascript +var adUnits = [ + { + code: 'test-div', + sizes: [[728, 90]], // a display size + mediaTypes: {'banner': {}}, + bids: [ + { + bidder: 'openx', + params: { + unit: '539439964', + delDomain: 'se-demo-d.openx.net', + customParams: { + key1: 'v1', + key2: ['v2', 'v3'] + }, + } + } + ] + }, + { + code: 'video1', + mediaTypes: { + video: { + playerSize: [640, 480], + context: 'instream' + } + }, + bids: [{ + bidder: 'openx', + params: { + unit: '1611023124', + delDomain: 'PUBLISHER-d.openx.net', + openrtb: { + imp: [{ + video: { + mimes: ['video/x-ms-wmv, video/mp4'] + } + }] + } + } + }] + } +]; +``` + ### Configuration -Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes. OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the OpenX bid rate and bid price. Be sure to call `pbjs.setConfig()` only once. +Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes. +OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the +OpenX bid rate and bid price. Be sure to call `pbjs.setConfig()` only once. ```javascript pbjs.setConfig({ @@ -36,3 +98,8 @@ pbjs.setConfig({ } }); ``` + +# Additional Details +[Banner Ads](https://docs.openx.com/Content/developers/containers/prebid-adapter.html) + +[Video Ads](https://docs.openx.com/Content/developers/containers/prebid-video-adapter.html) From b8bb7d4359a4816d88183cbca190f4ac1e59b76d Mon Sep 17 00:00:00 2001 From: Jimmy Tu Date: Wed, 11 Jul 2018 13:44:10 -0700 Subject: [PATCH 2/3] OpenX: Update Documentation to be similar with adapter readme --- dev-docs/bidders/openx.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/dev-docs/bidders/openx.md b/dev-docs/bidders/openx.md index fb1bc327cb..3175e0c354 100644 --- a/dev-docs/bidders/openx.md +++ b/dev-docs/bidders/openx.md @@ -24,19 +24,17 @@ gdpr_supported: true | `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122" | `customParams` | optional | Object | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}` | `customFloor` | optional | Number | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50

**WARNING:**
Misuse of this parameter can impact revenue | 1.50 -| `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user.

**WARNING:**
Request-level setting. May impact revenue. | true -| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. | true +| `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user.

**WARNING:**
Impacts all bids in the request. May impact revenue. | true +| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. **WARNING:**
Impacts all bids in the request. May impact revenue. | true #### Video {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|----------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------| -| `unit` | required | OpenX ad unit ID provided by your OpenX representative. | `'1611023122'` | `string` | -| `placementId` | optional | OpenX placement ID provided by your OpenX representative. Required if `unit` is not available. | `'/123/abcdefg` | `string` | -| `delDomain` | required | OpenX delivery domain provided by your OpenX representative. | `'PUBLISHER-d.openx.net'` | `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 | `1.50` | `float` | +| Name | Scope | Type | Description | Example +| ---- | ----- | ---- | ----------- | ------- +| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122" +| `delDomain` | required | String | OpenX delivery domain provided by your OpenX representative. | "PUBLISHER-d.openx.net" +| `openrtb` | optional | OpenRTB Impression | An OpenRtb Impression with Video subtype properties | `{ imp: [{ video: {mimes: ['video/x-ms-wmv, video/mp4']} }] }` # Example From 1d003182863ed1bbd2bf3f49053aaf18fea1a2d4 Mon Sep 17 00:00:00 2001 From: bretg Date: Wed, 1 Aug 2018 22:18:34 -0400 Subject: [PATCH 3/3] moving type to last column --- dev-docs/bidders/openx.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/dev-docs/bidders/openx.md b/dev-docs/bidders/openx.md index 3175e0c354..167fe24536 100644 --- a/dev-docs/bidders/openx.md +++ b/dev-docs/bidders/openx.md @@ -18,23 +18,23 @@ gdpr_supported: true #### Banner {: .table .table-bordered .table-striped } -| Name | Scope | Type | Description | Example -| ---- | ----- | ---- | ----------- | ------- -| `delDomain` | required | String | OpenX delivery domain provided by your OpenX representative. | "PUBLISHER-d.openx.net" -| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122" -| `customParams` | optional | Object | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}` -| `customFloor` | optional | Number | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50

**WARNING:**
Misuse of this parameter can impact revenue | 1.50 -| `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user.

**WARNING:**
Impacts all bids in the request. May impact revenue. | true -| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. **WARNING:**
Impacts all bids in the request. May impact revenue. | true +| Name | Scope | Description | Example | Type | +| ---- | ----- | ----------- | ------- | ---- | +| `delDomain` | 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

**WARNING:**
Misuse of this parameter can impact revenue | 1.50 | Number | +| `doNotTrack` | optional | Prevents advertiser from using data for this user.

**WARNING:**
Impacts all bids in the request. May impact revenue. | true | Boolean | +| `coppa` | optional | Enables Child's Online Privacy Protection Act (COPPA) regulations. **WARNING:**
Impacts all bids in the request. May impact revenue. | true | Boolean | #### Video {: .table .table-bordered .table-striped } -| Name | Scope | Type | Description | Example -| ---- | ----- | ---- | ----------- | ------- -| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122" -| `delDomain` | required | String | OpenX delivery domain provided by your OpenX representative. | "PUBLISHER-d.openx.net" -| `openrtb` | optional | OpenRTB Impression | An OpenRtb Impression with Video subtype properties | `{ imp: [{ video: {mimes: ['video/x-ms-wmv, video/mp4']} }] }` +| Name | Scope | Description | Example | Type | +| ---- | ----- | ----------- | ------- | ---- | +| `unit` | required | OpenX ad unit ID provided by your OpenX representative. | "1611023122" | String | +| `delDomain` | required | OpenX delivery domain provided by your OpenX representative. | "PUBLISHER-d.openx.net" | String | +| `openrtb` | optional | An OpenRtb Impression with Video subtype properties | `{ imp: [{ video: {mimes: ['video/x-ms-wmv, video/mp4']} }] }` | Object | # Example