JW Player RTD Module : populate content url, title and description #11178
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,10 +23,19 @@ import {getGlobal} from '../src/prebidGlobal.js'; | |
|
|
||
| const SUBMODULE_NAME = 'jwplayer'; | ||
| const JWPLAYER_DOMAIN = SUBMODULE_NAME + '.com'; | ||
| const ENRICH_ALWAYS = 'always'; | ||
| const ENRICH_WHEN_EMPTY = 'whenEmpty'; | ||
| const ENRICH_NEVER = 'never'; | ||
| const overrideValidationRegex = /^(always|never|whenEmpty)$/; | ||
| const playlistItemCache = {}; | ||
| const pendingRequests = {}; | ||
| let activeRequestCount = 0; | ||
| let resumeBidRequest; | ||
| // defaults to 'always' for backwards compatibility | ||
| let overrideContentId = ENRICH_ALWAYS; | ||
| let overrideContentUrl = ENRICH_WHEN_EMPTY; | ||
| let overrideContentTitle = ENRICH_WHEN_EMPTY; | ||
| let overrideContentDescription = ENRICH_WHEN_EMPTY; | ||
|
|
||
| /** @type {RtdSubmodule} */ | ||
| export const jwplayerSubmodule = { | ||
|
|
@@ -38,7 +47,7 @@ export const jwplayerSubmodule = { | |
| /** | ||
| * add targeting data to bids and signal completion to realTimeData module | ||
| * @function | ||
| * @param {object} bidReqConfig | ||
| * @param {function} onDone | ||
| */ | ||
| getBidRequestData: enrichBidRequest, | ||
|
|
@@ -53,6 +62,7 @@ config.getConfig('realTimeData', ({realTimeData}) => { | |
| return; | ||
| } | ||
| fetchTargetingInformation(params); | ||
| setOverrides(params); | ||
| }); | ||
|
|
||
| submodule('realTimeData', jwplayerSubmodule); | ||
|
|
@@ -71,15 +81,31 @@ export function fetchTargetingInformation(jwTargeting) { | |
| }); | ||
| } | ||
|
|
||
| export function setOverrides(params) { | ||
| // For backwards compatibility, default to always unless overridden by Publisher. | ||
| overrideContentId = sanitizeOverrideParam(params.overrideContentId, ENRICH_ALWAYS); | ||
| overrideContentUrl = sanitizeOverrideParam(params.overrideContentUrl, ENRICH_WHEN_EMPTY); | ||
| overrideContentTitle = sanitizeOverrideParam(params.overrideContentTitle, ENRICH_WHEN_EMPTY); | ||
| overrideContentDescription = sanitizeOverrideParam(params.overrideContentDescription, ENRICH_WHEN_EMPTY); | ||
| } | ||
|
|
||
| function sanitizeOverrideParam(overrideParam, defaultValue) { | ||
| if (overrideValidationRegex.test(overrideParam)) { | ||
| return overrideParam; | ||
| } | ||
|
|
||
| return defaultValue; | ||
| } | ||
|
|
||
| export function fetchTargetingForMediaId(mediaId) { | ||
| const ajax = ajaxBuilder(); | ||
| // TODO: Avoid checking undefined vs null by setting a callback to pendingRequests. | ||
| pendingRequests[mediaId] = null; | ||
| ajax(`https://cdn.${JWPLAYER_DOMAIN}/v2/media/${mediaId}`, { | ||
| success: function (response) { | ||
| const item = parsePlaylistItem(response); | ||
| cachePlaylistItem(item, mediaId); | ||
| onRequestCompleted(mediaId, !!item); | ||
| }, | ||
| error: function () { | ||
| logError('failed to retrieve targeting information'); | ||
|
|
@@ -88,8 +114,8 @@ export function fetchTargetingForMediaId(mediaId) { | |
| }); | ||
| } | ||
|
|
||
| function parsePlaylistItem(response) { | ||
| let item; | ||
| try { | ||
| const data = JSON.parse(response); | ||
| if (!data) { | ||
|
|
@@ -101,16 +127,16 @@ function parseSegment(response) { | |
| throw ('Empty playlist'); | ||
| } | ||
|
|
||
| item = playlist[0]; | ||
| } catch (err) { | ||
| logError(err); | ||
| } | ||
| return item; | ||
| } | ||
|
|
||
| function cachePlaylistItem(playlistItem, mediaId) { | ||
| if (playlistItem && mediaId) { | ||
| playlistItemCache[mediaId] = playlistItem; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -167,7 +193,7 @@ export function enrichAdUnits(adUnits, ortb2Fragments = {}) { | |
| const contentData = getContentData(mediaId, contentSegments); | ||
| const targeting = formatTargetingResponse(vat); | ||
| enrichBids(adUnit.bids, targeting, contentId, contentData); | ||
| addOrtbSiteContent(ortb2Fragments.global, contentId, contentData, vat.title, vat.description, vat.mediaUrl); | ||
| }; | ||
| loadVat(jwTargeting, onVatResponse); | ||
| }); | ||
|
|
@@ -217,18 +243,27 @@ function loadVatForPendingRequest(playerDivId, mediaID, callback) { | |
| } | ||
|
|
||
| export function getVatFromCache(mediaID) { | ||
| const item = playlistItemCache[mediaID]; | ||
|
|
||
| if (!item) { | ||
| return null; | ||
| } | ||
|
|
||
| const mediaUrl = item.file ?? getFileFromSources(item); | ||
|
|
||
| return { | ||
| segments: item.jwpseg, | ||
| title: item.title, | ||
| description: item.description, | ||
| mediaUrl, | ||
| mediaID | ||
| }; | ||
| } | ||
|
|
||
| function getFileFromSources(playlistItem) { | ||
| return playlistItem.sources?.find?.(source => !!source.file)?.file; | ||
| } | ||
|
|
||
| export function getVatFromPlayer(playerDivId, mediaID) { | ||
| const player = getPlayer(playerDivId); | ||
| if (!player) { | ||
|
|
@@ -241,12 +276,18 @@ export function getVatFromPlayer(playerDivId, mediaID) { | |
| } | ||
|
|
||
| mediaID = mediaID || item.mediaid; | ||
| const title = item.title; | ||
| const description = item.description; | ||
| const mediaUrl = item.file; | ||
| const segments = item.jwpseg; | ||
| cachePlaylistItem(item, mediaID) | ||
|
|
||
| return { | ||
| segments, | ||
| mediaID, | ||
| title, | ||
| mediaUrl, | ||
| description | ||
| }; | ||
| } | ||
|
|
||
|
|
@@ -313,35 +354,59 @@ export function getContentData(mediaId, segments) { | |
| return contentData; | ||
| } | ||
|
|
||
| export function addOrtbSiteContent(ortb2, contentId, contentData, contentTitle, contentDescription, contentUrl) { | ||
| if (ortb2 == null) { | ||
| ortb2 = {}; | ||
| } | ||
|
|
||
| let site = ortb2.site = ortb2.site || {}; | ||
| let content = site.content = site.content || {}; | ||
|
|
||
| if (shouldOverride(content.id, contentId, overrideContentId)) { | ||
| content.id = contentId; | ||
| } | ||
|
|
||
| if (shouldOverride(content.url, contentUrl, overrideContentUrl)) { | ||
| content.url = contentUrl; | ||
|
There was a problem hiding this comment. Should this override what might be in There was a problem hiding this comment. Yes! If a publisher has requested that we enrich the bid request for a given media, then they have determined that the bid request is specific to that media, therefore we should override existing data in that field. Unfortunately the oRTB spec only has room for 1 content description, which is unrealistic given that multiple videos could be rendering simultaneously on the page. There was a problem hiding this comment. this feels concerning, let's discuss in committee There was a problem hiding this comment. @patmmccann and @dgirardi this has been address by adding configuration params |
||
| } | ||
|
|
||
| if (shouldOverride(content.title, contentTitle, overrideContentTitle)) { | ||
| content.title = contentTitle; | ||
| } | ||
|
|
||
| if (shouldOverride(content.ext && content.ext.description, contentDescription, overrideContentDescription)) { | ||
| content.ext = content.ext || {}; | ||
| content.ext.description = contentDescription; | ||
| } | ||
|
|
||
| const currentData = content.data || []; | ||
| // remove old jwplayer data | ||
| const data = currentData.filter(datum => datum.name !== JWPLAYER_DOMAIN); | ||
|
|
||
| if (contentData) { | ||
| data.push(contentData); | ||
| } | ||
|
|
||
| if (data.length) { | ||
| content.data = data; | ||
| } | ||
|
|
||
| return ortb2; | ||
| } | ||
|
|
||
| function shouldOverride(currentValue, newValue, configValue) { | ||
| switch (configValue) { | ||
| case ENRICH_ALWAYS: | ||
| return !!newValue; | ||
| case ENRICH_NEVER: | ||
| return false; | ||
| case ENRICH_WHEN_EMPTY: | ||
| return !!newValue && currentValue === undefined; | ||
| default: | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| function enrichBids(bids, targeting, contentId, contentData) { | ||
| if (!bids) { | ||
| return; | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Assuming this should be updated for 9, do you have a way to track it - would a TODO comment be helpful?
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.
added!