Skip to content

Commit

Permalink
KRKPD-1061: adds ORTB blocking to docs (#2)
Browse files Browse the repository at this point in the history
* adds ORTB blocking to docs

* adds EOF newline

---------

Co-authored-by: “Nick <“nick.llerandi”@kargo.com>
  • Loading branch information
nickllerandi and “Nick authored Apr 3, 2024
1 parent c8ed5f6 commit 9aef3f2
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions dev-docs/bidders/kargo.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,37 @@ pbjs.bidderSettings = {
| Name | Scope | Description | Example | Type |
|---------------|----------|-------------|---------|----------|
| `placementId` | required | The placementId of the ad slot. |`'_jWuc8Hks'`| `string` |

### ORTB Blocking

Kargo supports blocking advertisers in `badv` and categories in `bcat` parameters.
The blocked advertisers/categories list has no length limitation, but response timeout is more likely to occur as the number of entries grow.
Blocked advertisers list (`badv`) is an array of domains as strings.
Blocked categories list (`bcat`) is an array of IAB categories as strings.

For example:

#### Globally defined ORTB Blocking

```javascript
pbjs.setConfig({
ortb2: {
badv: ["domain1.com", "domain2.com"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
)};
```
#### ORTB Blocking specific only to rtbhouse bidder
```javascript
pbjs.setBidderConfig({
bidders: ['kargo'],
config:{
ortb2: {
badv: ["domain1.com", "domain2.com"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
}
});
```

0 comments on commit 9aef3f2

Please sign in to comment.