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

Get Ortb Params #12

Merged
merged 18 commits into from
Feb 17, 2022
Merged

Get Ortb Params #12

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
883bb64
Videojs ortb params, added ortb constants
AnirudhRahul Jan 24, 2022
ac85e74
Fixed integration examples, ortb adjustments
AnirudhRahul Jan 24, 2022
6f4fb24
Cleaned up code added comments
AnirudhRahul Jan 24, 2022
612f037
Renamed test file
AnirudhRahul Jan 24, 2022
b4e4d55
Removed videojs mock in favor of videojs
AnirudhRahul Jan 24, 2022
4a4c6fe
Changed video source, finished tests for ortb
AnirudhRahul Jan 24, 2022
c835dfe
Cleaned up spacing added some comments
AnirudhRahul Jan 26, 2022
6e312d5
Added ad position to ortb
AnirudhRahul Jan 27, 2022
575f9d6
Cleaned up playback methods code
AnirudhRahul Jan 27, 2022
06b96ad
Omitted skip variable per ortb spec
AnirudhRahul Jan 27, 2022
dc2b6d1
Added unit tests for ima integration
AnirudhRahul Jan 28, 2022
d5127da
Added util function, and corresponding tests
AnirudhRahul Jan 28, 2022
5e7e904
Added code for placement
AnirudhRahul Jan 28, 2022
d39fb80
Linter pass through
AnirudhRahul Jan 28, 2022
bb7777a
Added videojs-ima to integration example
AnirudhRahul Jan 28, 2022
961ccce
Removed duplicate tests
AnirudhRahul Feb 16, 2022
c4cec43
Removed non bidding module tests
AnirudhRahul Feb 16, 2022
876536e
Added clarifying comments
AnirudhRahul Feb 16, 2022
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
182 changes: 98 additions & 84 deletions integrationExamples/videoModule/videojsAdapter/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,105 +1,119 @@
<html>

<head>
<script async src="../../../build/dev/prebid.js"></script>
<link href="https://vjs.zencdn.net/7.17.0/video-js.css" rel="stylesheet" />
<!-- Setup ad units -->
<script>
var adUnits = [{
code: 'div-gpt-ad-51545-0',
sizes: [[600, 500]],
mediaTypes: {
video: {
sizes: [[600, 500]]
}
},
video: {
divId: 'vid-div-1',
adServer: {
vendorCode: "gam",
params: {
iu: '/19968336/prebid_cache_video_adunit',
cust_params: {
section: 'blog',
anotherKey: 'anotherValue'
},
output: 'vast'
}
},
},
<script async src="../../../build/dev/prebid.js"></script>
<link href="https://vjs.zencdn.net/7.17.0/video-js.css" rel="stylesheet" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/videojs-contrib-ads/6.9.0/videojs-contrib-ads.css"
integrity="sha512-0gIqgiX1dWTChdWUl8XGIBDFvLo7aTvmd6FAhJjzWx5bzYsCJTiPJLKqLF3q31IN4Kfrc0NbTO+EthoT6O0olQ=="
crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/videojs-ima/1.11.0/videojs.ima.css"
integrity="sha512-vvsEsf+dZDp6wbommO1Jbb2bpFhVQjw6pIzfE5fUY5Fgkmsgn/16sQWegqrd236T69kK5F1SbGZ+yK46a9il5A=="
crossorigin="anonymous" referrerpolicy="no-referrer" />

bids: [{
bidder: 'ix',
<!-- Setup ad units -->
<script>
var adUnits = [{
code: 'div-gpt-ad-51545-0',
sizes: [[600, 500]],
mediaTypes: {
video: {
sizes: [[600, 500]]
}
},
video: {
divId: 'vid-div-1',
adServer: {
vendorCode: "gam",
params: {
siteId: '300',
size: [600, 500]
iu: '/19968336/prebid_cache_video_adunit',
cust_params: {
section: 'blog',
anotherKey: 'anotherValue'
},
output: 'vast'
}
}]
}];
},
},

bids: [{
bidder: 'ix',
params: {
siteId: '300',
size: [600, 500]
}
}]
}];

var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];

pbjs.que.push(function () {
pbjs.onEvent('adImpression', event => {
console.log('adImpression: ', event);
});
pbjs.setConfig({
video: {
providers: [{
divId: 'vid-div-1',
// vendorCode for videojs
vendorCode: 2,
playerConfig: {
params: {
vendorConfig: {
mediaid: 'd9J2zcaA',
advertising: {
adscheduleid: "00000000",
client: 'vast',
offset: "10",
tag: [
"http://playertest.longtailvideo.com/pre-bad.xml",
"http://playertest.longtailvideo.com/mid.xml"
],
}
pbjs.que.push(function () {
pbjs.onEvent('adImpression', event => {
console.log('adImpression: ', event);
});
pbjs.setConfig({
video: {
providers: [{
divId: 'vid-div-1',
// vendorCode for videojs
vendorCode: 2,
playerConfig: {
params: {
vendorConfig: {
mediaid: 'd9J2zcaA',
advertising: {
adscheduleid: "00000000",
client: 'vast',
offset: "10",
tag: [
'https://pubads.g.doubleclick.net/gampad/ads?sz=640x480&' +
'iu=/124319096/external/ad_rule_samples&ciu_szs=300x250&ad_rule=1&' +
'impl=s&gdfp_req=1&env=vp&output=xml_vmap1&unviewed_position_start=1&' +
'cust_params=sample_ar%3Dpremidpostpod%26deployment%3Dgmf-js&cmsid=496&' +
'vid=short_onecue&correlator=',
"http://playertest.longtailvideo.com/mid.xml"
],
}
}
}
},]
}
});
pbjs.addAdUnits(adUnits);
pbjs.requestBids();
}
},]
}
});
</script>
pbjs.addAdUnits(adUnits);
pbjs.requestBids();
});
</script>
</head>

<body>
<h2>VideoJS Adapter Test</h2>

<h5>Div-1 existing Player</h5>
<div id='vid-div-1'>
<video class="video-js vjs-big-play-centered" data-setup='{"controls": true, "autoplay": false, "preload": "auto"}'>
<source src="http://content.bitsontherun.com/videos/3XnJSIm4-52qL9xLP.mp4" type="video/mp4">
</video>
</div>
<h2>VideoJS Adapter Test</h2>

<h5>Div-2 existing player without automatic setup</h5>
<div id='vid-div-2'>
<video-js data-setup='{"controls": true}'>
<source src="http://content.bitsontherun.com/videos/3XnJSIm4-52qL9xLP.mp4" type="video/mp4">
</video-js>
</div>
<h5>Div-1 existing Player</h5>

<h5>Div-3 controlled Player</h5>
<div id='vid-div-3'></div>
<video id='vid-div-1' class="video-js vjs-big-play-centered"
data-setup='{"controls": true, "autoplay": false, "preload": "auto"}'>
<source src="http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4" type="video/mp4">
</video>

<h5>Div-2 existing player without automatic setup</h5>
<video-js id='vid-div-2' data-setup='{"controls": true}'>
<source src="http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4" type="video/mp4">
</video-js>

<h5>Div-3 controlled Player</h5>
<div id='vid-div-3'></div>

<script src="https://vjs.zencdn.net/7.17.0/video.min.js"></script>
<script>
</script>
</body>

</html>
<script src="https://vjs.zencdn.net/7.17.0/video.min.js"></script>
<script src="https://imasdk.googleapis.com/js/sdkloader/ima3.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/videojs-contrib-ads/6.9.0/videojs-contrib-ads.js"
integrity="sha512-XjyyAijQGlXZET35toG8igvVs8HvfVgKXGnbfAs2EpZ0o8vjJoIrxL9RBBQbQjzAODIe0jvWelFfZOA3Z/vdWg=="
crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/videojs-ima/1.11.0/videojs.ima.js"
integrity="sha512-9ocW9fl8CKJhZp4cmDpLDGPuTQ93gvw1iIS6daMYc5Y0Xh1all8iwdoI+iNmZpiydpdDGyKMTriXDX0wfs2OEg=="
crossorigin="anonymous" referrerpolicy="no-referrer"></script>

</body>

</html>
4 changes: 2 additions & 2 deletions modules/jwplayerVideoProvider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {
PROTOCOLS, API_FRAMEWORKS, VIDEO_MIME_TYPE, PLAYBACK_METHODS, PLACEMENT, VPAID_MIME_TYPE
PROTOCOLS, API_FRAMEWORKS, VIDEO_MIME_TYPE, PLAYBACK_METHODS, PLACEMENT, VPAID_MIME_TYPE, AD_POSITION
} from './videoModule/constants/ortb.js';
import {
SETUP_COMPLETE, SETUP_FAILED, DESTROYED, AD_REQUEST, AD_BREAK_START, AD_LOADED, AD_STARTED, AD_IMPRESSION, AD_PLAY,
Expand Down Expand Up @@ -103,7 +103,7 @@ export function JWPlayerProvider(config, jwplayer_, adState_, timeState_, callba
// only specify ad position when in Fullscreen since computational cost is low
// ad position options are listed in oRTB 2.5 section 5.4
// https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf
video.pos = 7; // TODO make constant in oRTB
video.pos = AD_POSITION.FULL_SCREEN; // TODO make constant in oRTB
}

const item = player.getPlaylistItem() || {}; // TODO does player call need optimization ?
Expand Down
22 changes: 22 additions & 0 deletions modules/videoModule/constants/ortb.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,28 @@ export const PLACEMENT = {
INTERSTITIAL_SLIDER_FLOATING: 5
};

/*
ORTB 2.5 section 5.4 - Ad Position
*/
export const AD_POSITION = {
UNKNOWN: 0,
ABOVE_THE_FOLD: 1,
BELOW_THE_FOLD: 3,
HEADER: 4,
FOOTER: 5,
SIDEBAR: 6,
FULL_SCREEN: 7
}

/*
ORTB 2.5 section 5.11 - Playback Cessation Modes
*/
export const PLAYBACK_END = {
VIDEO_COMPLETION: 1,
VIEWPORT_LEAVE: 2,
FLOATING: 3
}

/*
ORTB 2.5 section 5.10 - Playback Methods
*/
Expand Down
Loading