diff --git a/dev-docs/bidders/showheroes-bs.md b/dev-docs/bidders/showheroes-bs.md index a4e3fba3a4..ac0e667d07 100644 --- a/dev-docs/bidders/showheroes-bs.md +++ b/dev-docs/bidders/showheroes-bs.md @@ -9,6 +9,10 @@ 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,124 @@ 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` | + +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 'fake' the page URL by setting the: `qa.pageURL` parameter. +This will automatically set the `test: 1` parameter inside the openRTB request, marking this bid request as a test request. + +#### 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", + qa: { + "endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", + "pageURL": "https://testing.domain.com/" + } + } + }], + renderer: { + url: 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js', + render: function (bid) { + // push to render queue because ANOutstreamVideo may not be loaded yet. + bid.renderer.push(() => { + ANOutstreamVideo.renderAd({ + targetId: bid.adUnitCode, // target div id to render video. + adResponse: bid.adResponse + }); + }); + } + }, + } +]; +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", + qa: { + "endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", + "pageURL": "https://dev-pagetests.viralize.com/" + } + } + } + ] +}; +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.