Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 96f1c39

Browse files
authored
Updated docs for Kobler adapter (prebid#3794)
* Updated docs for Kobler adapter. * Added more details about page URL.
1 parent c292550 commit 96f1c39

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

dev-docs/bidders/kobler.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ Please reach out to <[email protected]> for more information.
1919
{: .table .table-bordered .table-striped }
2020
| Name | Scope | Description | Example | Type |
2121
|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|--------------------|
22-
| `placementId` | required | The identifier of the placement, it has to be issued by Kobler. | `'xjer0ch8'` | `string` |
23-
| `zip` | optional | Zip code of the user or the medium. When multiple ad units are submitted together, it is enough to set this parameter on the first one. | `'102 22'` | `string` |
24-
| `test` | optional | Whether the request is for testing only. When multiple ad units are submitted together, it is enough to set this parameter on the first one. Defaults to false. | `true` | `boolean` |
22+
| `test` | optional | Whether the request is for testing only. When multiple ad units are submitted together, it is enough to set this parameter on the first one. Enables providing a custom URL through config.pageUrl. Defaults to false. | `true` | `boolean` |
2523
| `floorPrice` | optional | Floor price in CPM and in USD. Can be used as an alternative to the [Floors module](https://docs.prebid.org/dev-docs/modules/floors.html), which is also supported by this adapter. Defaults to 0. | `5.0` | `float` |
26-
| `position` | optional | The position of the ad unit. Can be used to differentiate between ad units if the same placement ID is used across multiple ad units. The first ad unit should have a position of 0, the second one should have a position of 1 and so on. Defaults to 0. | `1` | `string` |
2724
| `dealIds` | optional | Array of deal IDs. | `['abc328745', 'mxw243253']` | `array of strings` |
2825

26+
### Implicit parameters
27+
28+
Kobler identifies the placement using the combination of the page URL and the allowed sizes. As a result, it's important that the correct sizes are provided in `banner.sizes` in order for Kobler to correctly identify the placement. The main, desired format should be the first element of this array.
29+
2930
### Example
3031
```javascript
3132
const adUnits = [{
@@ -36,17 +37,14 @@ Please reach out to <[email protected]> for more information.
3637
}
3738
},
3839
bids: [{
39-
bidder: 'kobler',
40-
params: {
41-
placementId: 'k5H7et3R0'
42-
}
40+
bidder: 'kobler'
4341
}]
4442
}];
4543
```
4644

4745
In order to see a sample bid from Kobler (without a proper setup), you have to also do the following:
48-
- Change the [`refererInfo` function](https://github.com/prebid/Prebid.js/blob/master/src/refererDetection.js) to return `'https://www.tv2.no/a/11734615'` as a [`referer`](https://github.com/prebid/Prebid.js/blob/caead3ccccc448e4cd09d074fd9f8833f56fe9b3/src/refererDetection.js#L169). This is necessary because Kobler only bids on recognized articles.
49-
- Change the adapter's [`BIDDER_ENDPOINT`](https://github.com/prebid/Prebid.js/blob/master/modules/koblerBidAdapter.js#L8) to `'https://bid-service.dev.essrtb.com/bid/prebid_rtb_call'`. This endpoint belongs to the development server that is set up to always return a bid for the correct `placementId` and page URL combination.
46+
- Set the `test` parameter to `true`.
47+
- Set `config.pageUrl` to `'https://www.tv2.no/mening-og-analyse/14555348/'`. This is necessary because Kobler only bids on recognized articles. Kobler runs its own test campaign to make sure there is always a bid for this specific page URL.
5048

5149
### Example With Optional Parameters
5250
```javascript
@@ -60,11 +58,8 @@ In order to see a sample bid from Kobler (without a proper setup), you have to a
6058
bids: [{
6159
bidder: 'kobler',
6260
params: {
63-
placementId: 'k5H7et3R0',
64-
zip: '102 22',
6561
test: true,
6662
floorPrice: 5.0,
67-
position: 1,
6863
dealIds: ['abc328745', 'mxw243253']
6964
}
7065
}]

0 commit comments

Comments
 (0)