Skip to content

Sonobi docs update hfa #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bansawbanchee wants to merge 2 commits into from
Closed

Sonobi docs update hfa #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96b2615
Update Sonobi Bidder Adapter Documentation
bansawbanchee Feb 2, 2018
40fec92
Add Documentation for hfa key.
bansawbanchee Feb 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 16 additions & 26 deletions dev-docs/bidders/sonobi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,33 @@
layout: bidder
title: Sonobi
description: Prebid Sonobi Bidder Adaptor

top_nav_section: dev_docs
nav_section: reference

hide: true

biddercode: sonobi

biddercode_longer_than_12: false

prebid_1_0_supported : true
---

### Note:
The Sonobi Bidder adapter requires setup and approval from your Sonobi Account Manager. If you require assistance
implementing our adapter please don't hesitate to contact us at apex.prebid@sonobi.com.


### release version:
`0.8.0`

### bid params : DFP adUnit Code format
### bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example |
| :--- | :---- | :---------- | :------ |
| `ad_unit` | required | The ad unit ID | "/1234567/example/adUnit/code" |
| `dom_id` | optional | The DOM Id of the ad slot | "div-gpt-ad-12345-0" |
| `floor` | optional | The numerical floor value desired | 1 |
| Name | Scope | Description | Type | Example |
|:---------------|:---------|:---------------------------------------------|:--------------|:---------------------------------|
| `placement_id` | required | The placement ID | String | `'1a2b3c4d5e6f1a2b3c4d'` |
| `ad_unit` | required | The adunit ID | String | `'/1234567/example/adUnit/code'` |
| `floor` | optional | Bid floor for this placement in USD | Integer | `0.50` |
| `sizes` | optional | Adunit sizes that will override global sizes | Array[String] | `[[300, 250], [300, 600]]` |
| `hfa` | optional | Publisher Unique Identifier | String | `'123985'` |

### bid params : Sonobi Placement Id format
### Configuration

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example |
| :--- | :---- | :---------- | :------ |
| `placement_id` | required | The placement ID | "1a2b3c4d5e6f1a2b3c4d" |
| `dom_id` | optional | The DOM Id of the ad slot | "div-gpt-ad-12345-0" |
| `floor` | optional | The numerical floor value desired | 1 |
The `ad_unit` and `placement_id` are **mutually exclusive** but at least one is required. If you pass both, `ad_unit` takes precedence.

### Caveats
If you pass the optional `sizes` Array in your bid params it will override the global config sizes for the Sonobi Adapter only.

* The Placement Id format is now deprecated. Your account manager will be in contact to help with transitioning to the adUnit format.
* More detailed instructions can be found [here](https://sonobi.atlassian.net/wiki/display/PP/Prebid.js+Implementation+Guide).
* If you require assistance with any of our open source code, please email support at github@sonobi.com
The `hfa` parameter requires your Sonobi Account Manager to enable this feature for you. Please contact them for further information.