Skip to content
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.

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

Updated docs for Vidoomy blocking supported #4493

Merged
merged 1 commit into from
Apr 28, 2023
Merged
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
64 changes: 57 additions & 7 deletions dev-docs/bidders/vidoomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,73 @@ coppa_supported: true
pbs: true
sidebarType: 1
schain_supported: true
ortb_blocking_supported: true
---

### Note:

[Vidoomy](https://vidoomy.com/), for more info please contact support@vidoomy.com

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------------|----------|------------------|------------------------------|----------|
| `id` | required | id | `123123` | `string` |
| `pid` | required | pid | `'123123'` | `string` |

| Name | Scope | Description | Example | Type |
|-------|----------|-------------|------------|----------|
| `id` | required | id | `123123` | `string` |
| `pid` | required | pid | `'123123'` | `string` |

### Bid Params (Prebid Server)

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------------|----------|------------------|------------------------------|----------|
| `zoneId` | required | Zone Id | "123123" | `string` |

| Name | Scope | Description | Example | Type |
|----------|----------|---------------------------------------------|-------------------|----------------|
| `zoneId` | required | Zone Id | "123123" | `string` |
| `bcat` | optional | List of blocked advertiser categories (IAB) | `['IAB1-1']` | `string array` |
| `badv` | optional | Blocked Advertiser Domains | `['example.com']` | `string array` |
| `bapp` | optional | blocked advertiser mobile app bundles | `['app.com']` | `string array` |
| `btype` | optional | blocked creative types (e.g. XHTML) | `[1, 2, 3]` | `int array` |
| `battr` | optional | blocked creative attributes (e.g. audio) | `[1, 2, 3]` | `int array` |

Notes:

- Preferred to provide the `bcat`, `badv`, `bapp`, `btype` and `battr` within the first party data (above). When both
methods are provided, first
party data values will be prioritized.

### First Party Data

Publishers can use the `ortb2` configuration parameter to provide First Party Data.

#### OpenRTB Parameters

The following table contains currently supported parameters we parse.

{: .table .table-bordered .table-striped }

| Name | Scope | Description | Example | Type |
|---------|----------|---------------------------------------------|-------------------|---------|
| `bcat` | optional | List of blocked advertiser categories (IAB) | `['IAB1-1']` | `Array` |
| `badv` | optional | Blocked Advertiser Domains | `['example.com']` | `Array` |
| `bapp` | optional | blocked advertiser mobile app bundles | `['app.com']` | `Array` |
| `btype` | optional | blocked creative types (e.g. XHTML) | `[1, 2, 3]` | `Array` |
| `battr` | optional | blocked creative attributes (e.g. audio) | `[1, 2, 3]` | `Array` |

Notes:

- will extract the bcat,badv,bapp,btype,battr if passed within `ortb2`

Example configuration:

```
pbjs.setConfig({
ortb2: {
bcat: ['IAB1-1'],
badv: ['example.com'],
bapp: ['app.com'],
btype: [1, 2, 3],
battr: [1, 2, 3]
}
});
```