From 67519c9cb6b864d4f342c5bb5805e590f0b1ed2e Mon Sep 17 00:00:00 2001 From: Lyubomir Shishkov <61063794+lyubomirshishkov@users.noreply.github.com> Date: Tue, 18 Feb 2025 20:07:49 +0200 Subject: [PATCH 1/3] add documentation regarding multibid as per patmmccann request --- modules/improvedigitalBidAdapter.md | 160 ++++++++++++++++++++-------- 1 file changed, 116 insertions(+), 44 deletions(-) diff --git a/modules/improvedigitalBidAdapter.md b/modules/improvedigitalBidAdapter.md index 7206dd8ba7b..456652be549 100644 --- a/modules/improvedigitalBidAdapter.md +++ b/modules/improvedigitalBidAdapter.md @@ -1,53 +1,125 @@ # Overview -**Module Name**: Improve Digital Bidder Adapter -**Module Type**: Bidder Adapter -**Maintainer**: hb@azerion.com +```text +Module Name: Improve Digital Bidder Adapter +Module Type: Bidder Adapter +Maintainer: hb@azerion.com +``` # Description -Module that connects to Improve Digital's demand sources +This module connects publishers to Improve Digital's demand sources through Prebid.js. # Test Parameters + +```javascript +var adUnits = [{ + code: 'div-gpt-ad-1499748733608-0', + sizes: [[600, 290]], + bids: [ + { + bidder: 'improvedigital', + params: { + publisherId: 123, + placementId:1053688 + } + } + ] +}, { + code: 'div-gpt-ad-1499748833901-0', + sizes: [[250, 250]], + bids: [{ + bidder: 'improvedigital', + params: { + publisherId: 123, + placementId:1053689, + keyValues: { + testKey: ["testValue"] + } + } + }] +}, { + code: 'div-gpt-ad-1499748913322-0', + sizes: [[300, 300]], + bids: [{ + bidder: 'improvedigital', + params: { + publisherId: 123, + placementId:1053687, + size: { + w:300, + h:300 + } + } + }] +}]; +``` + +# Additional Information + +## Bid params + +| Name | Scope | Description | Example | Type | +| --- | --- | --- | --- | --- | +| `placementId` | required | The placement ID from Improve Digital. | `1234567` | `integer` | +| `publisherId` | required | The publisher ID from Improve Digital. | `4567` | `integer` | +| `keyValues` | optional | Contains one or more key-value pairings for key-value targeting | `{ testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] }` | `object` | +| `bidFloor` | optional | Bid floor price | `0.01` | `float` | +| `bidFloorCur` | optional | Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK | `'USD'` | `string` | +| `extend` | optional | See the [Extend mode section](#extend-mode) | `true` | `boolean` | +| `rendererConfig` | optional | Configuration object for JS renderer of the RAZR creatives. Provided by Improve Digital. | `{ key1: value1 }` | `object` | + +## Configuration + +### Sizes + +By default, the adapter sends Prebid ad unit sizes to Improve Digital’s ad server. If the ad server should only respond with creative sizes as defined for each placement in the Origin platform, turn off `usePrebidSizes` adapter parameter like this: + +```javascript +pbjs.setConfig({ + improvedigital: { usePrebidSizes: false } +}); +``` + +### Renderer Config + +Global configuration for the special creative format renderer. Please use rendererConfig bid param for ad slot specific configuration. + +```javascript +pbjs.setConfig({ + improvedigital: { + rendererConfig: { + // Global config object provided by Improve Digital + } + } +}); ``` - var adUnits = [{ - code: 'div-gpt-ad-1499748733608-0', - sizes: [[600, 290]], - bids: [ - { - bidder: 'improvedigital', - params: { - publisherId: 123, - placementId:1053688 - } - } - ] - }, { - code: 'div-gpt-ad-1499748833901-0', - sizes: [[250, 250]], - bids: [{ - bidder: 'improvedigital', - params: { - publisherId: 123, - placementId:1053689, - keyValues: { - testKey: ["testValue"] - } - } - }] - }, { - code: 'div-gpt-ad-1499748913322-0', - sizes: [[300, 300]], - bids: [{ - bidder: 'improvedigital', - params: { - publisherId: 123, - placementId:1053687, - size: { - w:300, - h:300 - } - } - }] - }]; + +### Extend Mode + +Improve Digital Extend mode provides publishers with access to additional demand from other SSPs. Before enabling please contact our team for more information. +The Extend mode can be enabled: + +* per ad unit via the `extend` [bid param](#bid-params) +* for all ad units via `setConfig()`: + +```javascript +pbjs.setConfig({ + improvedigital: { + extend: true + } +}); +``` + +### MultiBid + +Improve Digital supports Prebid's MultiBid feature. More on enabling MultiBid can be found here: [MultiBid](./multibid/index.md). An example of how to enable MultiBid for Improve Digital: + +```javascript +pbjs.setConfig({ + multibid: [{ + bidder: "improvedigital", + maxBids: 3, + }] +}); ``` From a8ad875a86136fa514c27397f24f8dbe1f577fb0 Mon Sep 17 00:00:00 2001 From: Lyubomir Shishkov <61063794+lyubomirshishkov@users.noreply.github.com> Date: Tue, 18 Feb 2025 20:56:40 +0200 Subject: [PATCH 2/3] removed render config --- modules/improvedigitalBidAdapter.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/modules/improvedigitalBidAdapter.md b/modules/improvedigitalBidAdapter.md index 456652be549..1d691542256 100644 --- a/modules/improvedigitalBidAdapter.md +++ b/modules/improvedigitalBidAdapter.md @@ -67,7 +67,6 @@ var adUnits = [{ | `bidFloor` | optional | Bid floor price | `0.01` | `float` | | `bidFloorCur` | optional | Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK | `'USD'` | `string` | | `extend` | optional | See the [Extend mode section](#extend-mode) | `true` | `boolean` | -| `rendererConfig` | optional | Configuration object for JS renderer of the RAZR creatives. Provided by Improve Digital. | `{ key1: value1 }` | `object` | ## Configuration @@ -81,20 +80,6 @@ pbjs.setConfig({ }); ``` -### Renderer Config - -Global configuration for the special creative format renderer. Please use rendererConfig bid param for ad slot specific configuration. - -```javascript -pbjs.setConfig({ - improvedigital: { - rendererConfig: { - // Global config object provided by Improve Digital - } - } -}); -``` - ### Extend Mode Improve Digital Extend mode provides publishers with access to additional demand from other SSPs. Before enabling please contact our team for more information. From b620f7e5e2ba9602ff1716a87bc1d91f51e58590 Mon Sep 17 00:00:00 2001 From: Lyubomir Shishkov <61063794+lyubomirshishkov@users.noreply.github.com> Date: Wed, 19 Feb 2025 10:33:17 +0200 Subject: [PATCH 3/3] improve adapter documentation styling and update test parameters --- modules/improvedigitalBidAdapter.md | 104 ++++++---------------------- 1 file changed, 23 insertions(+), 81 deletions(-) diff --git a/modules/improvedigitalBidAdapter.md b/modules/improvedigitalBidAdapter.md index 1d691542256..4614ea550b4 100644 --- a/modules/improvedigitalBidAdapter.md +++ b/modules/improvedigitalBidAdapter.md @@ -13,98 +13,40 @@ This module connects publishers to Improve Digital's demand sources through Preb # Test Parameters ```javascript -var adUnits = [{ - code: 'div-gpt-ad-1499748733608-0', - sizes: [[600, 290]], +const adUnits = [{ + code: 'banner-ad-unit', + mediaTypes: { + banner: { + sizes: [[300, 250]], + } + }, bids: [ { bidder: 'improvedigital', params: { - publisherId: 123, - placementId:1053688 + publisherId: 950, + placementId: 22135702, } } ] }, { - code: 'div-gpt-ad-1499748833901-0', - sizes: [[250, 250]], - bids: [{ - bidder: 'improvedigital', - params: { - publisherId: 123, - placementId:1053689, - keyValues: { - testKey: ["testValue"] - } + code: 'video-ad-unit', + mediaTypes: { + video: { + playerSize: [640, 480], + context: 'instream', + plcmt: 2, } - }] -}, { - code: 'div-gpt-ad-1499748913322-0', - sizes: [[300, 300]], + }, bids: [{ bidder: 'improvedigital', params: { - publisherId: 123, - placementId:1053687, - size: { - w:300, - h:300 - } - } - }] + publisherId: 950, + placementId: 22137694, + keyValues: { + testKey: ["testValue"], + }, + }, + }], }]; ``` - -# Additional Information - -## Bid params - -| Name | Scope | Description | Example | Type | -| --- | --- | --- | --- | --- | -| `placementId` | required | The placement ID from Improve Digital. | `1234567` | `integer` | -| `publisherId` | required | The publisher ID from Improve Digital. | `4567` | `integer` | -| `keyValues` | optional | Contains one or more key-value pairings for key-value targeting | `{ testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] }` | `object` | -| `bidFloor` | optional | Bid floor price | `0.01` | `float` | -| `bidFloorCur` | optional | Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK | `'USD'` | `string` | -| `extend` | optional | See the [Extend mode section](#extend-mode) | `true` | `boolean` | - -## Configuration - -### Sizes - -By default, the adapter sends Prebid ad unit sizes to Improve Digital’s ad server. If the ad server should only respond with creative sizes as defined for each placement in the Origin platform, turn off `usePrebidSizes` adapter parameter like this: - -```javascript -pbjs.setConfig({ - improvedigital: { usePrebidSizes: false } -}); -``` - -### Extend Mode - -Improve Digital Extend mode provides publishers with access to additional demand from other SSPs. Before enabling please contact our team for more information. -The Extend mode can be enabled: - -* per ad unit via the `extend` [bid param](#bid-params) -* for all ad units via `setConfig()`: - -```javascript -pbjs.setConfig({ - improvedigital: { - extend: true - } -}); -``` - -### MultiBid - -Improve Digital supports Prebid's MultiBid feature. More on enabling MultiBid can be found here: [MultiBid](./multibid/index.md). An example of how to enable MultiBid for Improve Digital: - -```javascript -pbjs.setConfig({ - multibid: [{ - bidder: "improvedigital", - maxBids: 3, - }] -}); -```