Update dfp.buildVideoUrl to accept adserver url #1663

matthewlane · 2017-10-06T18:18:56Z

Updates pbjs.adServer.dfp.buildVideoUrl to accept a video adserver url (similar to deprecated pbjs.buildMasterVideoTagFromAdserverTag function) with a url parameter on the input object:

var videoUrl = pbjs.adServers.dfp.buildVideoUrl({
  adUnit: videoAdUnit,
  url: 'https://pubads.g.doubleclick.net/gampad/ads?iu=/19968336/prebid_video_adunit...'
});

Also updates the function to work without prebid cache enabled when the input contains an object of querystring parameters by appending description_url to the output url:

// with usePrebidCache configured to false
var videoUrl = pbjs.adServers.dfp.buildVideoUrl({
  adUnit: videoAdUnit,
  params: { iu: '/19968336/prebid_video_adunit' }
});

dbemiller

Looks sensible to me, barring one open question.

dbemiller · 2017-10-16T17:47:51Z

modules/dfpAdServerVideo.js

+  }
+
+  if (options.params && options.url) {
+    logError(`Passing both a params object and a url to pbjs.adServers.dfp.buildVideoUrl is invalid.`);


Is there any reason we aren't supporting this? It seems legitimate to parse the URL, overwrite any params, stringify the URL, and then return it.

…ns description_url

dbemiller

Looks good overall... few recommendations. Mostly about docs.

dbemiller · 2017-10-27T17:50:41Z

src/video.js

@@ -32,6 +33,15 @@ export function isValidVideoBid(bid) {
  // if context not defined assume default 'instream' for video bids
  // instream bids require a vast url or vast xml content
  if (!bidRequest || (videoMediaType && context !== OUTSTREAM)) {
+    // xml-only video bids require prebid-cache to be enabled
+    if (!config.getConfig('usePrebidCache') && bid.vastXml && !bid.vastUrl) {


very good idea. This makes the cache & no-cache workflows much more smooth... I'm a little embarrassed I never thought of it.

dbemiller · 2017-10-30T19:17:45Z

modules/dfpAdServerVideo.js

@@ -55,9 +56,26 @@ const defaultParamConstants = {
 *   demand in DFP.
 */
 export default function buildDfpVideoUrl(options) {
+  if (!options.params && !options.url) {


Looks like the JSDoc types need some updating for this. The DfpVideoOptions still says that params is required, and doesn't mention url at all.

dbemiller · 2017-10-30T19:22:26Z

modules/dfpAdServerVideo.js

+ * Builds a video url from a base dfp video url and a winning bid, appending
+ * Prebid-specific key-values.
+ * @param {Object} components base video adserver url parsed into components object
+ * @param {Object} bid winning bid object to append parameters from


Thanks to @rmloveland's documentation in src/prebid.js, you can call this an AdapterBidResponse now.

dbemiller · 2017-10-30T19:26:21Z

modules/dfpAdServerVideo.js

+    } else {
+      logError(`input url cannnot contain description_url`);
+    }
+  }


This description_url validation block is basically copy/paste between buildDfpVideoUrl and buildUrlFromAdserverUrlComponents... would be more maintainable in a helper method.

dbemiller

Looks good.

There's one more thing I should point out about the Types... but I don't think it should hold up the PR or anything. Almost all the programmers I've worked with in loosely-typed languages do the same thing you did.

If the DfpVideoParams has optional params and url properties, then that type implies that "both" or "neither" are also acceptable. But... what you really mean here is "must have one or the other, but not both."

In this case... it's probably better spec'd out as two types. One requires params, and the other requires url. The buildDfVideoUrl would accept either one (in JSDoc, {type1|type2}).

In any language, the golden standard for good types is "rejects all args which cause this function to error, and accept all args that allow this function to do its job."

* 'master' of https://github.com/prebid/Prebid.js: Increment pre version Prebid 0.32.0 Release Commenting out tests that are failing in IE10 (prebid#1710) Update dfp.buildVideoUrl to accept adserver url (prebid#1663) Update rubicon adapter with new properties and 1.0 changes (prebid#1776) Added adUnitCode for compatibility (prebid#1781) Remove 'supported' from analytics adapter info (prebid#1780) Add TTL parameter to bid (prebid#1784)

* tag '0.32.0' of https://github.com/prebid/Prebid.js: (44 commits) Prebid 0.32.0 Release Commenting out tests that are failing in IE10 (prebid#1710) Update dfp.buildVideoUrl to accept adserver url (prebid#1663) Update rubicon adapter with new properties and 1.0 changes (prebid#1776) Added adUnitCode for compatibility (prebid#1781) Remove 'supported' from analytics adapter info (prebid#1780) Add TTL parameter to bid (prebid#1784) Update GetIntent adapter to 1.0 version (prebid#1721) Add `usePaymentRule` param to AN bidders (prebid#1778) New hooks API (replaces monkey-patching for currency) (prebid#1683) Change prebidServer to call client user syncs if they exist (prebid#1734) Fix Centro adapter to allow requests of the same units (prebid#1746) add vastUrl + media type for video bids Prebid Server (prebid#1739) Update adxcg adapter for prebid 1.0 (prebid#1741) Update yieldmoBid adapter request url (prebid#1771) Upgrade Quantcast adapter for Prebid 1.0 (prebid#1753) Fidelity Media Adapter update. Prebid v1.0 (prebid#1719) Kargo Adapter for Prebid 1.0 (prebid#1729) updated for prebid 1.0 api (prebid#1722) Add AdOcean adapter (prebid#1735) ...

….32.0 to aolgithub-master * commit '7a956351d69ed3a54ec31aaef17a36441be16fbd': (58 commits) Fixed wrong contentType and customHeader options. Fixed aol adapter bad merge (accepted official changes) Fixed issue with invalid webpack module. Added partners ids. Added changelog entry. Refactored interpretResponse tests for Prebid 1.0. Prebid 0.32.0 Release Commenting out tests that are failing in IE10 (prebid#1710) Update dfp.buildVideoUrl to accept adserver url (prebid#1663) Update rubicon adapter with new properties and 1.0 changes (prebid#1776) Added adUnitCode for compatibility (prebid#1781) Remove 'supported' from analytics adapter info (prebid#1780) Add TTL parameter to bid (prebid#1784) Refactored get userSyncs tests for Prebid 1.0. Fixed faining tests for One Mobile endpoint. Refactored One Mobile tests for Prebid 1.0 Refactored Marketplace tests for Prebid 1.0 Implemented AOL user syncs config via setConfig API. Move one mobile post properties to options object. Update GetIntent adapter to 1.0 version (prebid#1721) ...

* Update dfp.buildVideoUrl to accept adserver url * Reject invalid param usage * Don't overwrite description_url if cache is disabled and input contains description_url * Reject xml-only bids when cache is disabled * Accept both url and params object in function call * Fix conflict and nobid condition * Update docs and refactor based on code review

matthewlane added the needs review label Oct 7, 2017

protonate self-assigned this Oct 10, 2017

protonate requested review from protonate and dbemiller October 10, 2017 17:00

matthewlane added in progress and removed needs review labels Oct 10, 2017

dbemiller self-assigned this Oct 13, 2017

matthewlane force-pushed the build-video-url branch from 302fcfd to d4905de Compare October 13, 2017 23:38

dbemiller reviewed Oct 16, 2017

View reviewed changes

matthewlane force-pushed the build-video-url branch from 0d97096 to 349792f Compare October 25, 2017 01:10

dbemiller added needs review and removed in progress labels Oct 26, 2017

matthewlane added 6 commits October 26, 2017 14:32

Update dfp.buildVideoUrl to accept adserver url

82e1623

Reject invalid param usage

8e331ae

Don't overwrite description_url if cache is disabled and input contai…

8935da5

…ns description_url

Reject xml-only bids when cache is disabled

26a1449

Accept both url and params object in function call

5ed48ac

Fix conflict and nobid condition

9e6d46f

matthewlane force-pushed the build-video-url branch from 8a36160 to 9e6d46f Compare October 26, 2017 21:52

dbemiller suggested changes Oct 30, 2017

View reviewed changes

dbemiller added needs update and removed needs review labels Oct 30, 2017

Update docs and refactor based on code review

b6d8b5c

dbemiller approved these changes Oct 31, 2017

View reviewed changes

dbemiller added LGTM and removed needs update labels Oct 31, 2017

dbemiller removed their assignment Oct 31, 2017

jaiminpanchal27 approved these changes Oct 31, 2017

View reviewed changes

jaiminpanchal27 merged commit 5802bb9 into master Oct 31, 2017

matthewlane deleted the build-video-url branch October 31, 2017 20:39

rmloveland mentioned this pull request Nov 3, 2017

Document pbjs.adServers.dfp.buildVideoUrl update to accept ad server URL prebid/prebid.github.io#422

Merged

matthewlane mentioned this pull request Feb 8, 2018

hb_uuid is set to undefined when running video ads #1857

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dfp.buildVideoUrl to accept adserver url #1663

Update dfp.buildVideoUrl to accept adserver url #1663

matthewlane commented Oct 6, 2017

dbemiller left a comment

dbemiller Oct 16, 2017

dbemiller left a comment

dbemiller Oct 27, 2017

dbemiller Oct 30, 2017

dbemiller Oct 30, 2017

dbemiller Oct 30, 2017

dbemiller left a comment •

edited

Loading

Update dfp.buildVideoUrl to accept adserver url #1663

Update dfp.buildVideoUrl to accept adserver url #1663

Conversation

matthewlane commented Oct 6, 2017

dbemiller left a comment

Choose a reason for hiding this comment

dbemiller Oct 16, 2017

Choose a reason for hiding this comment

dbemiller left a comment

Choose a reason for hiding this comment

dbemiller Oct 27, 2017

Choose a reason for hiding this comment

dbemiller Oct 30, 2017

Choose a reason for hiding this comment

dbemiller Oct 30, 2017

Choose a reason for hiding this comment

dbemiller Oct 30, 2017

Choose a reason for hiding this comment

dbemiller left a comment • edited Loading

Choose a reason for hiding this comment

dbemiller left a comment •

edited

Loading