From de0bdac3d31958577b9955aadb90da41c70ec355 Mon Sep 17 00:00:00 2001 From: Filip Stamenkovic Date: Tue, 20 Aug 2024 16:20:11 +0200 Subject: [PATCH 1/7] update showheroes docs --- dev-docs/bidders/showheroes-bs.md | 126 +++++++++++++++++++++++++++++- 1 file changed, 124 insertions(+), 2 deletions(-) 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. From 99dd5fd6659266d39ed0632a0ad03258dec2bdda Mon Sep 17 00:00:00 2001 From: Filip Stamenkovic Date: Tue, 20 Aug 2024 16:23:13 +0200 Subject: [PATCH 2/7] remove extra empty line --- dev-docs/bidders/showheroes-bs.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev-docs/bidders/showheroes-bs.md b/dev-docs/bidders/showheroes-bs.md index ac0e667d07..ca280cc91f 100644 --- a/dev-docs/bidders/showheroes-bs.md +++ b/dev-docs/bidders/showheroes-bs.md @@ -99,7 +99,6 @@ You could use this example and place it in .html example pages inside the Prebid #### instream - Example of adunit configuration for the instream unit: ```javascript From 36cc92e4ad0104f440a3ded853643685642e632c Mon Sep 17 00:00:00 2001 From: Filip Stamenkovic Date: Tue, 17 Sep 2024 17:02:04 +0200 Subject: [PATCH 3/7] remove banner --- dev-docs/bidders/showheroes-bs.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/dev-docs/bidders/showheroes-bs.md b/dev-docs/bidders/showheroes-bs.md index ca280cc91f..0e377a64ea 100644 --- a/dev-docs/bidders/showheroes-bs.md +++ b/dev-docs/bidders/showheroes-bs.md @@ -4,7 +4,7 @@ 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 @@ -30,12 +30,30 @@ 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. +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. +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 From 76ac85541b1cd4086f7fa58026e7374b8196aa7a Mon Sep 17 00:00:00 2001 From: Filip Stamenkovic Date: Mon, 23 Sep 2024 09:26:33 +0200 Subject: [PATCH 4/7] remove pageURL from docs --- dev-docs/bidders/showheroes-bs.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/dev-docs/bidders/showheroes-bs.md b/dev-docs/bidders/showheroes-bs.md index 0e377a64ea..a0d71898db 100644 --- a/dev-docs/bidders/showheroes-bs.md +++ b/dev-docs/bidders/showheroes-bs.md @@ -88,7 +88,6 @@ var adUnits = [ unitId: "AACBTwsZVANd9NlB", qa: { "endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", - "pageURL": "https://testing.domain.com/" } } }], @@ -136,7 +135,6 @@ var videoAdUnit = { unitId: "AAFo8FVWXycNdR8K", qa: { "endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", - "pageURL": "https://dev-pagetests.viralize.com/" } } } From 42ccda7879090f4dfde7f1f3a68498f00e274199 Mon Sep 17 00:00:00 2001 From: Filip Stamenkovic Date: Mon, 23 Sep 2024 10:09:00 +0200 Subject: [PATCH 5/7] remove renderer from examples --- dev-docs/bidders/showheroes-bs.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/dev-docs/bidders/showheroes-bs.md b/dev-docs/bidders/showheroes-bs.md index a0d71898db..66890e723e 100644 --- a/dev-docs/bidders/showheroes-bs.md +++ b/dev-docs/bidders/showheroes-bs.md @@ -91,18 +91,6 @@ var adUnits = [ } } }], - 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 () { From cb735ef70b7c9ddefd4bd73b88616e6c1382cd36 Mon Sep 17 00:00:00 2001 From: Filip Stamenkovic Date: Mon, 23 Sep 2024 10:31:12 +0200 Subject: [PATCH 6/7] unitId is always required --- dev-docs/bidders/showheroes-bs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/bidders/showheroes-bs.md b/dev-docs/bidders/showheroes-bs.md index 66890e723e..737f9ecf92 100644 --- a/dev-docs/bidders/showheroes-bs.md +++ b/dev-docs/bidders/showheroes-bs.md @@ -23,7 +23,7 @@ sidebarType: 1 {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |-------------|----------------------------------|-------------------------------------|------------------------------------------|-----------| -| `unitId` | required (if not send playerId) | Monetize unit ID | `'AACBTwsZVANd9NlB'` | `string` | +| `unitId` | required | Monetize unit ID | `'AACBTwsZVANd9NlB'` | `string` | All other parameters should be sent inside openRTB request. From 288d8b6183011bec296b531bd34e235fc4d77726 Mon Sep 17 00:00:00 2001 From: Filip Stamenkovic Date: Tue, 24 Sep 2024 10:09:33 +0200 Subject: [PATCH 7/7] remove QA and replace unitId example --- dev-docs/bidders/showheroes-bs.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/dev-docs/bidders/showheroes-bs.md b/dev-docs/bidders/showheroes-bs.md index 737f9ecf92..1e375d7953 100644 --- a/dev-docs/bidders/showheroes-bs.md +++ b/dev-docs/bidders/showheroes-bs.md @@ -23,7 +23,7 @@ sidebarType: 1 {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |-------------|----------------------------------|-------------------------------------|------------------------------------------|-----------| -| `unitId` | required | Monetize unit ID | `'AACBTwsZVANd9NlB'` | `string` | +| `unitId` | required | ShowHeroes MAX unit ID | `'1234abcd-5678efgh'` | `string` | All other parameters should be sent inside openRTB request. @@ -85,10 +85,7 @@ var adUnits = [ bids: [{ bidder: "showheroes-bs", params: { - unitId: "AACBTwsZVANd9NlB", - qa: { - "endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", - } + unitId: "1234abcd-5678efgh", } }], } @@ -120,10 +117,7 @@ var videoAdUnit = { { bidder: 'showheroesBs', params: { - unitId: "AAFo8FVWXycNdR8K", - qa: { - "endpoint": "https://vr-api.dev.showheroes.com/openrtb2/auction/", - } + unitId: "1234abcd-5678efgh", } } ]