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.

Sign up for GitHub

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

Update PubWise Bidder Docs #4382

Merged
merged 1 commit into from
Mar 12, 2023
Merged

Update PubWise Bidder Docs #4382

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 60 additions & 5 deletions dev-docs/bidders/pwbid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,16 @@ schain_supported: true
prebid_member: true
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, pubProvidedId, sharedId, unifiedId
tcf1_supported: true
floors_supported: false
floors_supported: true
gvl_id: 842
sidebarType: 1
---

### Note:
The PubWise bid adapter requires approval. Visit http://www.PubWise.io/ to get started.
The PubWise bid adapter is now availalbe self service. Visit http://www.PubWise.io/ to get started.

### Bid params
### Global Bid params
siteID is sufficient for bidding.

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
Expand All @@ -29,10 +30,30 @@ The PubWise bid adapter requires approval. Visit http://www.PubWise.io/ to get s
| `bidFloor` | optional | Value to pass as the bidfloor for this bid | `2.50` | `currency` |
| `isTest` | optional | A boolean to indicate 100% fill test placement request | `false` | `boolean` |

### video parameters
The PubWise adapter supports video as of Prebid v7.39.0. Outstream is NOT supported currently.

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example |
| :----------------------| :------- | :---------------------------------------------------------- | :------ |
| `video.mimes` | required | Video MIME types | `['video/mp4','video/x-flv']` |
| `video.skippable` | optional | If 'true', user can skip ad | `true` |
| `video.minduration` | optional | Minimum ad duration in seconds | `5` |
| `video.maxduration` | optional | Maximum ad duration in seconds | `30` |
| `video.startdelay` | optional | Start delay in seconds for pre-roll, mid-roll, or post-roll ad placements | `5` |
| `video.playbackmethod` | optional | Defines whether inventory is user-initiated or autoplay sound on/off<br/>Values:<br/>`1`: Auto-play, sound on<br/>`2`: Auto-play, sound off<br/>`3`: Click-to-play<br/>`4`: mouse-over | `1` |
| `video.api` | optional | API frameworks supported<br/>Values:<br/>`1`: VPAID 1.0<br/>`2`: VPAID 2.0<br/>`3`: MRAID-1<br/>`4`: ORMMA<br/>`5`: MRAID-2 | `[1, 2]` |
| `video.protocols` | optional | Supported video bid response protocols<br/>Values<br/>`1`: VAST 1.0<br/>`2`: VAST 2.0<br/>`3`: VAST 3.0<br/> `4`: VAST 1.0 Wrapper<br/>`5`: VAST 2.0 Wrapper<br/>`6`: VAST 3.0 Wrapper | `[5, 6]` |
| `video.battr` | optional | Blocked creative attributes, See [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf), List 5.3 for values | `[3, 9]` |
| `video.linearity` | optional | Indicates if the impression is linear or nonlinear<br/>Values:<br/>`1`: Linear/In-Stream<br/>`2`: Non-Linear/Overlay. | `1` |
| `video.placement` | optional | Video placement type. See [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf), List 5.9 for Values | `1` |
| `video.minbitrate` | optional | Minumim bit rate in Kbps. | 50 |
| `video.maxbitrate` | optional | Maximum bit rate in Kbps. | 70 |

### Example

#### Banner
```
```javascript
var adUnits = [
{
code: "div-gpt-ad-1460505748561-0",
Expand All @@ -53,7 +74,7 @@ var adUnits = [
```
#### Native

```
```javascript
var adUnits = [
{
code: 'div-gpt-ad-1460505748561-1',
Expand Down Expand Up @@ -89,3 +110,37 @@ var adUnits = [
}
]
```

### Video
```javascript
var videoAdUnits = [
{
code: 'div-gpt-ad-1460505748561-1',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'instream',
mimes: ['video/mp4','video/x-flv'], // required
skip: 1, // optional
minduration: 5, // optional
maxduration: 30, // optional
startdelay: 5, // optional
playbackmethod: [1,3], // optional
api: [ 1, 2 ], // optional
protocols: [ 2, 3 ], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
placement: 2, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: 'pwbid',
params: {
siteId: 'xxxxxx', // required
isTest: 'true' // required
}
}]
}]
```