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

Aniview: Add examples and update params list #5916

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
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
145 changes: 132 additions & 13 deletions dev-docs/bidders/aniview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@ description: Prebid Aniview Bidder Adapter
pbjs: true
biddercode: aniview
media_types: banner, video
gpp_supported: true
ortb_blocking_supported: true
multiformat_supported: true
tcfeu_supported: true
floors_supported: true
usp_supported: true
schain_supported: true
safeframes_ok: true
gvl_id: 780
sidebarType: 1
userIds: true
---

### Note
Expand All @@ -21,29 +25,144 @@ For more information about [Aniview Ad Server](https://www.aniview.com/), please
### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------------|----------|------------------|------------------------------|----------|
| `AV_PUBLISHERID` | required | Publisher/Netid | `'55b88d4a181f465b3e8b4567'` | `string` |
| `AV_CHANNELID` | required | Channel id | `'5a5f17a728a06102d14c2718'` | `string` |
| Name | Scope | Description | Example | Type |
|------------------|----------|-----------------------|----------------------|----------|
| `AV_PUBLISHERID` | required | Publisher/Network ID | `'Get from Aniview'` | `string` |
| `AV_CHANNELID` | required | Channel ID | `'Get from Aniview'` | `string` |

### Test Parameters
### Setup for Video

```javascript
const videoAdUnit = [
{
code: 'video1',
const adUnit = [{
code: 'videoAdUnit',
mediaTypes: {
video: {
// Required
playerSize: [[640, 480]],
context: 'outstream'
context: 'outstream',
mimes: ['video/mp4', 'video/mpeg', 'application/javascript'],

// Optional
playbackmethod: [1, 2],
protocols: [1, 2, 3, 5, 6, 7, 8],
api: [1, 2],
maxduration: 60,
plcmt: 4,
},
},
bids: [{
bidder: 'aniview',
params: {
AV_PUBLISHERID: '55b78633181f4603178b4568',
AV_CHANNELID: '5d19dfca4b6236688c0a2fc4'
}
}]
// Required
AV_PUBLISHERID: 'Get from Aniview',
AV_CHANNELID: 'Get from Aniview',
},
}],
}];
```

### Setup for Banner

```javascript
const adUnit = [{
code: 'bannerAdUnit',
mediaTypes: {
banner: {
// Required
sizes: [[300, 250], [300, 600]],
},
},
bids: [{
bidder: 'aniview',
params: {
// Required
AV_PUBLISHERID: 'Get from Aniview',
AV_CHANNELID: 'Get from Aniview',
},
}],
}];
```

### Setup for Multi-format (Banner & Video)

```javascript
const adUnit = [{
code: 'multiformatAdUnit',
mediaTypes: {
banner: {
// Required
sizes: [[300, 250], [300, 600]],
},
video: {
// Required
playerSize: [[640, 480]],
context: 'outstream',
mimes: ['video/mp4', 'video/mpeg', 'application/javascript'],
},
},
bids: [{
bidder: 'aniview',
params: {
// Required
AV_PUBLISHERID: 'Get from Aniview',
AV_CHANNELID: 'Get from Aniview',
},
}],
}];
```

### Floors

```javascript
const adUnit = [{
code: 'floorsAdUnit',
mediaTypes: {/*...*/},
bids: [/*...*/],
floors: {
currency: 'USD',
schema: {
delimiter: '|',
fields: ['mediaType', 'size'],
},
values: {
'banner|300x250': 0.1,
'banner|*': 0.05,
'video|640x360': 0.5,
'video|*': 0.25,
},
},
}];
```

### Cookie sync

```javascript
pbjs.setConfig({
// Cookie sync (Image & Iframe)
userSync: {
filterSettings: {
all: {
bidders: '*',
filter: 'include',
},
},
},
});
```

### Bidder specific configs

```javascript
pbjs.setBidderConfig({
bidders: ['aniview'],
config: {
ortb2: {
ext: {
aniview: {
// Additional data to send to the Ad Server
},
},
},
},
}, true);
```