Skip to content

Unicorn bid adapter: document ad slot position signals #6674

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

Merged
muuki88 merged 5 commits into from
Aug 14, 2026
Merged

Unicorn bid adapter: document ad slot position signals #6674

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fdd00e3
Unicorn RTD Provider: add module documentation
harufujimoto Jul 23, 2026
2a9b672
Unicorn RTD Provider docs: wrap maintainer email to satisfy markdownl…
harufujimoto Jul 23, 2026
b12e45c
Document UNICORN adapter position signals; drop obsolete RTD module doc
harufujimoto Aug 12, 2026
f7cd957
Fix markdownlint in unicorn bidder doc (heading level, compact table)
harufujimoto Aug 12, 2026
950a310
Restore aligned bid-params table; sync key name to imp.ext.adslot
harufujimoto Aug 14, 2026
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
38 changes: 30 additions & 8 deletions dev-docs/bidders/unicorn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,37 @@ biddercode: unicorn
sidebarType: 1
---

### bid params
## bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|-------------------------------------------|------------|-----------|
| `placementId` | optional | Your placement ID | `'rectangle-ad-1'` | `string` |
| `accountId` | required | Account ID for charge request (provided by UNICORN) | `12345` | `integer` |
| `publisherId` | optional | Account specific publisher id. | `'67890'` | `string` |
| `mediaId` | optional | Publisher specific media id. | `'example'` | `string` |
| `bcat` | optional for Prebid.js | Blocked IAB categories | `['IAB-1', 'IAB-2']` | `[string]` |
| Name | Scope | Description | Example | Type |
| ------------- | ---------------------- | --------------------------------------------------- | -------------------- | ---------- |
| `placementId` | optional | Your placement ID | `'rectangle-ad-1'` | `string` |
| `accountId` | required | Account ID for charge request (provided by UNICORN) | `12345` | `integer` |
| `publisherId` | optional | Account specific publisher id. | `'67890'` | `string` |
| `mediaId` | optional | Publisher specific media id. | `'example'` | `string` |
| `bcat` | optional for Prebid.js | Blocked IAB categories | `['IAB-1', 'IAB-2']` | `[string]` |

`publisherId` as `integer` is also supported on Prebid.js

## Ad slot position signals

For each bid request the adapter measures the ad slot's on-screen position,
geometry and viewability, and sends it in the OpenRTB request it builds. This is
scoped to the UNICORN request only — nothing is written to shared First Party
Data, so no other bidder is affected. No configuration is required.

- `imp.banner.pos` — OpenRTB AdPosition (`1` = above the fold, `3` = below the
fold). A publisher-declared `ortb2Imp.banner.pos`, if present, is used instead
of the measured value.
- `imp.ext.adslot` — `{ ver, ratio, fixed, sticky, w, h, x, y }`: `ratio` is the
visible-area ratio (0–1), `fixed`/`sticky` flag a fixed/sticky ancestor, and
`x`/`y`/`w`/`h` are the slot's document-relative position and rendered size in
CSS pixels.
- `imp.ext.gpid` — the Global Placement ID, forwarded from `ortb2Imp.ext.gpid`
(set by the `gpid` / `gptPreAuction` module) when present.

The slot element is resolved in this order: `ortb2Imp.ext.data.divId` → the GPT
slot mapping (`getSlotElementId()`) → the ad unit code. Set
`ortb2Imp.ext.data.divId` when the ad unit code is not the div id and GPT is not
defined at auction time.
Loading