-
Notifications
You must be signed in to change notification settings - Fork 0
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
update showheroes docs #1
Changes from 6 commits
de0bdac
99dd5fd
36cc92e
76ac855
42ccda7
cb735ef
288d8b6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,11 +4,15 @@ title: ShowHeroes | |
description: Prebid ShowHeroes Bidder Adapter | ||
pbjs: true | ||
biddercode: showheroes-bs | ||
media_types: video, banner | ||
media_types: video | ||
gvl_id: 111 | ||
tcfeu_supported: true | ||
usp_supported: true | ||
schain_supported: true | ||
userId: all | ||
floors_supported: true | ||
fpd_supported: true | ||
multiformat_supported: will-bid-on-one | ||
sidebarType: 1 | ||
--- | ||
|
||
|
@@ -19,6 +23,127 @@ sidebarType: 1 | |
{: .table .table-bordered .table-striped } | ||
| Name | Scope | Description | Example | Type | | ||
|-------------|----------------------------------|-------------------------------------|------------------------------------------|-----------| | ||
| `playerId` | required (if not send unitId) | VideoLibrary player ID | `'0151f985-fb1a-4f37-bb26-cfc62e43ec05'` | `string` | | ||
| `unitId` | required (if not send playerId) | Monetize unit ID | `'AACBTwsZVANd9NlB'` | `string` | | ||
| `vpaidMode` | optional | Vpaid wrapper; default: `false`. | `true` | `boolean` | | ||
| `unitId` | required | Monetize unit ID | `'AACBTwsZVANd9NlB'` | `string` | | ||
|
||
All other parameters should be sent inside openRTB request. | ||
|
||
### openRTB2 support | ||
|
||
{: .alert.alert-danger :} | ||
Starting with Prebid.js version 9.15 ShowHeores bidder adapter is requesting bids via openRTB protocol. | ||
Publishers can use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). Bidder supports all first-party data fields: site, user, segments, and imp-level first-party data. | ||
|
||
### testing | ||
|
||
While developing or testing locally, you can request a test request by marking the openRTB as a test. | ||
To do that specifically for `showheroes-Bs` you can do: | ||
|
||
```javascript | ||
pbjs.setBidderConfig({ | ||
bidders: ['showheroesBs'], | ||
config: { | ||
ortb2: { | ||
test:1 | ||
} | ||
} | ||
}) | ||
``` | ||
|
||
Or, more easily you can mark the whole request as a test request by doing: | ||
|
||
```javascript | ||
pbjs.setConfig({config: {ortb2: {test: 1}}}) | ||
``` | ||
|
||
#### Outstream | ||
|
||
Example of adunit configuration for the outstream unit: | ||
|
||
```javascript | ||
|
||
var pbjs = pbjs || {}; | ||
pbjs.que = pbjs.que || []; | ||
var adUnits = [ | ||
{ | ||
// Video adUnit | ||
code: 'video-div-1', | ||
mediaTypes: { | ||
video: { | ||
context: 'outstream', | ||
playerSize: [640, 480], | ||
mimes: ['video/mp4'], | ||
playbackmethod: [2, 4, 6], | ||
api: [1, 2, 4, 6], | ||
protocols: [3, 4, 7, 8, 10], | ||
placement: 1, | ||
minduration: 0, | ||
maxduration: 60, | ||
startdelay: 0, | ||
skip: 1 | ||
}, | ||
}, | ||
bids: [{ | ||
bidder: "showheroes-bs", | ||
params: { | ||
unitId: "AACBTwsZVANd9NlB", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Developers will use these parameters to test their config. What unit id are we using here ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As discussed privately, we now provide fake zid. When using the preview mode, a test ad will be returned, even if the zid is not valid. When the developer will remove the preview mode, the bidder will stop returning any bids. |
||
qa: { | ||
francesconistri marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", | ||
} | ||
} | ||
}], | ||
} | ||
]; | ||
pbjs.que.push(function () { | ||
pbjs.setConfig({...}); | ||
pbjs.addAdUnits(adUnits); | ||
pbjs.requestBids({ bidsBackHandler: sendAdServerRequest }); | ||
}); | ||
``` | ||
|
||
You could use this example and place it in .html example pages inside the Prebid.js repository. | ||
|
||
#### instream | ||
|
||
Example of adunit configuration for the instream unit: | ||
|
||
```javascript | ||
|
||
var pbjs = pbjs || {}; | ||
pbjs.que = pbjs.que || []; | ||
var videoAdUnit = { | ||
code: 'video1', | ||
sizes: [640,480], | ||
mediaTypes: { | ||
video: {context: 'instream', playerSize: [640, 480]} | ||
}, | ||
bids: [ | ||
{ | ||
bidder: 'showheroesBs', | ||
params: { | ||
unitId: "AAFo8FVWXycNdR8K", | ||
francesconistri marked this conversation as resolved.
Show resolved
Hide resolved
|
||
qa: { | ||
francesconistri marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", | ||
} | ||
} | ||
} | ||
] | ||
}; | ||
pbjs.que.push(function(){ | ||
pbjs.addAdUnits(videoAdUnit); | ||
pbjs.setConfig({ | ||
cache: { | ||
url: 'https://prebid.adnxs.com/pbc/v1/cache' | ||
}, | ||
..., | ||
}); | ||
pbjs.requestBids({ | ||
timeout: 10000, | ||
bidsBackHandler : function(bids) { | ||
var vastUrl = bids["video1"].bids[0].vastUrl | ||
invokeVideoPlayer(vastUrl); | ||
} | ||
}); | ||
}); | ||
``` | ||
|
||
You could use this example and place it in the `test/pages/instream.html` example page inside the Prebid.js repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually our product is now called ShowHeroes MAX