From 7255d1a5a204d667d3b8abd144806366a02bc3ba Mon Sep 17 00:00:00 2001 From: Nick Llerandi Date: Thu, 4 Apr 2024 07:36:12 -0400 Subject: [PATCH] KRKPD-1061: adds ORTB blocking to docs (#2) (#5238) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * adds ORTB blocking to docs * adds EOF newline --------- Co-authored-by: “Nick <“nick.llerandi”@kargo.com> --- dev-docs/bidders/kargo.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/dev-docs/bidders/kargo.md b/dev-docs/bidders/kargo.md index 57c3356a26..2695b2a797 100644 --- a/dev-docs/bidders/kargo.md +++ b/dev-docs/bidders/kargo.md @@ -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"] + } + } +}); +```