-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated docs for Kobler adapter (#3794)
* Updated docs for Kobler adapter. * Added more details about page URL.
- Loading branch information
Showing
1 changed file
with
8 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,13 +19,14 @@ Please reach out to <[email protected]> for more information. | |
{: .table .table-bordered .table-striped } | ||
| Name | Scope | Description | Example | Type | | ||
|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|--------------------| | ||
| `placementId` | required | The identifier of the placement, it has to be issued by Kobler. | `'xjer0ch8'` | `string` | | ||
| `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` | | ||
| `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` | | ||
| `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` | | ||
| `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` | | ||
| `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` | | ||
| `dealIds` | optional | Array of deal IDs. | `['abc328745', 'mxw243253']` | `array of strings` | | ||
|
||
### Implicit parameters | ||
|
||
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. | ||
|
||
### Example | ||
```javascript | ||
const adUnits = [{ | ||
|
@@ -36,17 +37,14 @@ Please reach out to <[email protected]> for more information. | |
} | ||
}, | ||
bids: [{ | ||
bidder: 'kobler', | ||
params: { | ||
placementId: 'k5H7et3R0' | ||
} | ||
bidder: 'kobler' | ||
}] | ||
}]; | ||
``` | ||
|
||
In order to see a sample bid from Kobler (without a proper setup), you have to also do the following: | ||
- 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. | ||
- 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. | ||
- Set the `test` parameter to `true`. | ||
- 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. | ||
|
||
### Example With Optional Parameters | ||
```javascript | ||
|
@@ -60,11 +58,8 @@ In order to see a sample bid from Kobler (without a proper setup), you have to a | |
bids: [{ | ||
bidder: 'kobler', | ||
params: { | ||
placementId: 'k5H7et3R0', | ||
zip: '102 22', | ||
test: true, | ||
floorPrice: 5.0, | ||
position: 1, | ||
dealIds: ['abc328745', 'mxw243253'] | ||
} | ||
}] | ||
|