Skip to content
Open
Changes from all commits
Commits
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
53 changes: 47 additions & 6 deletions dev-docs/bidders/optout.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: bidder
title: Opt Out Advertising
description: Prebid Opt Out Advertising Bidder Adaptor
description: Prebid Opt Out Advertising Bidder Adapter
pbjs: true
pbs: true
biddercode: optout
Expand All @@ -10,10 +10,51 @@ gvl_id: 227
sidebarType: 1
---

### Bid Params
## Bid Params
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Bid Params
### Bid Params


{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|----------------------|----------------|-----------|
| `publisher` | required | Opt Out publisher ID | `8` | `string` |
| `adslot` | required | Opt Out Adslot | `prebid_demo` | `string` |
| Name | Scope | Description | Example | Type |
|-------------|----------|-----------------------------------------------------------------------------|----------------------------------|----------|
| `publisher` | required | Opt Out publisher ID | `"4"` | `string` |
| `adSlot` | required | Opt Out ad slot name (inventory key) | `"1Limburg_Web_Sticky - Desktop"`| `string` |
| `id` | optional | Slot identifier returned by the Opt Out bidder endpoint and used for mapping to the correct Prebid `bidId`. If omitted, the adapter falls back to `adSlot`. | `"div-1"` | `string` |
| `customs` | optional | Custom targeting / extra parameters forwarded to the Opt Out endpoint | `{ "foo": "bar" }` | `object` |

### Notes

- The Opt Out endpoint responds with bids keyed by a slot identifier (e.g. `div-1`, `div-2`).
The adapter maps that identifier back to Prebid’s internal `bidId` automatically.
- If you provide `params.id`, ensure it is **unique per ad unit** (e.g. `div-1`, `div-2`) so multi-slot requests map correctly.
- GDPR/TCF: the adapter reads `gdprConsent` from the Prebid bidder request and may route traffic to a different endpoint depending on whether GDPR applies and Purpose 1 consent is present.

## Example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Example
### Example


```javascript
pbjs.addAdUnits([{
code: 'div-1',
mediaTypes: {
banner: { sizes: [[300, 600]] }
},
bids: [{
bidder: 'optout',
params: {
publisher: '4',
adSlot: '1Limburg_Web_Sticky - Desktop',
id: 'div-1',
customs: { test: true }
}
}]
}, {
code: 'div-2',
mediaTypes: {
banner: { sizes: [[300, 600]] }
},
bids: [{
bidder: 'optout',
params: {
publisher: '4',
adSlot: '1Limburg_Web_Sticky - Desktop',
id: 'div-2'
}
}]
}]);