Skip to content

Commit b620f7e

Browse files
improve adapter documentation styling and update test parameters
1 parent a8ad875 commit b620f7e

File tree

1 file changed

+23
-81
lines changed

1 file changed

+23
-81
lines changed

modules/improvedigitalBidAdapter.md

Lines changed: 23 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -13,98 +13,40 @@ This module connects publishers to Improve Digital's demand sources through Preb
1313
# Test Parameters
1414

1515
```javascript
16-
var adUnits = [{
17-
code: 'div-gpt-ad-1499748733608-0',
18-
sizes: [[600, 290]],
16+
const adUnits = [{
17+
code: 'banner-ad-unit',
18+
mediaTypes: {
19+
banner: {
20+
sizes: [[300, 250]],
21+
}
22+
},
1923
bids: [
2024
{
2125
bidder: 'improvedigital',
2226
params: {
23-
publisherId: 123,
24-
placementId:1053688
27+
publisherId: 950,
28+
placementId: 22135702,
2529
}
2630
}
2731
]
2832
}, {
29-
code: 'div-gpt-ad-1499748833901-0',
30-
sizes: [[250, 250]],
31-
bids: [{
32-
bidder: 'improvedigital',
33-
params: {
34-
publisherId: 123,
35-
placementId:1053689,
36-
keyValues: {
37-
testKey: ["testValue"]
38-
}
33+
code: 'video-ad-unit',
34+
mediaTypes: {
35+
video: {
36+
playerSize: [640, 480],
37+
context: 'instream',
38+
plcmt: 2,
3939
}
40-
}]
41-
}, {
42-
code: 'div-gpt-ad-1499748913322-0',
43-
sizes: [[300, 300]],
40+
},
4441
bids: [{
4542
bidder: 'improvedigital',
4643
params: {
47-
publisherId: 123,
48-
placementId:1053687,
49-
size: {
50-
w:300,
51-
h:300
52-
}
53-
}
54-
}]
44+
publisherId: 950,
45+
placementId: 22137694,
46+
keyValues: {
47+
testKey: ["testValue"],
48+
},
49+
},
50+
}],
5551
}];
5652
```
57-
58-
# Additional Information
59-
60-
## Bid params
61-
62-
| Name | Scope | Description | Example | Type |
63-
| --- | --- | --- | --- | --- |
64-
| `placementId` | required | The placement ID from Improve Digital. | `1234567` | `integer` |
65-
| `publisherId` | required | The publisher ID from Improve Digital. | `4567` | `integer` |
66-
| `keyValues` | optional | Contains one or more key-value pairings for key-value targeting | `{ testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] }` | `object` |
67-
| `bidFloor` | optional | Bid floor price | `0.01` | `float` |
68-
| `bidFloorCur` | optional | Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK | `'USD'` | `string` |
69-
| `extend` | optional | See the [Extend mode section](#extend-mode) | `true` | `boolean` |
70-
71-
## Configuration
72-
73-
### Sizes
74-
75-
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:
76-
77-
```javascript
78-
pbjs.setConfig({
79-
improvedigital: { usePrebidSizes: false }
80-
});
81-
```
82-
83-
### Extend Mode
84-
85-
Improve Digital Extend mode provides publishers with access to additional demand from other SSPs. Before enabling please contact our team for more information.
86-
The Extend mode can be enabled:
87-
88-
* per ad unit via the `extend` [bid param](#bid-params)
89-
* for all ad units via `setConfig()`:
90-
91-
```javascript
92-
pbjs.setConfig({
93-
improvedigital: {
94-
extend: true
95-
}
96-
});
97-
```
98-
99-
### MultiBid
100-
101-
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:
102-
103-
```javascript
104-
pbjs.setConfig({
105-
multibid: [{
106-
bidder: "improvedigital",
107-
maxBids: 3,
108-
}]
109-
});
110-
```

0 commit comments

Comments
 (0)