CPMStar Bid Adapter #3820

JoshuaMGoldstein · 2019-05-11T04:08:43Z

Type of change

New bidder adapter

Description of change

Added CPMStar Bid Adapter

test parameters for validating banner bids

{
  bidder: 'cpmstar',
  params: {
    placementId: 81006
  }
}

test parameters for validating video bids

{
  bidder: 'cpmstar',
  params: {
    placementId: 81007
  }
}

contact email of the adapter’s maintainer: josh@cpmstar.com
official adapter submission
A link to a PR on the docs repo: Added cpmstarBidAdapter docs prebid.github.io#1309

Other information

Contact Person:
Joshua Goldstein
General Manager, CPMStar
josh@cpmstar.com

jsnellbaker

Hi @JoshuaMGoldstein

Thanks for putting this adapter together. There are a few items that should be reviewed/updated. Please see the comments below for details.

Additionally, do you happen to have any test params for a video bid? If so - can you please update the PR description and update the md file? I verified your adapter is working fine for banner bids based on the test params you've already provided, but I'd like to ensure the video type works as well since your adapter is supporting this mediaType.

Please let me know if you have any questions and thanks!

jsnellbaker · 2019-05-14T16:09:39Z

modules/cpmstarBidAdapter.js

@@ -0,0 +1,121 @@
+import * as utils from 'src/utils';
+import { registerBidder } from 'src/adapters/bidderFactory';


In lieu of this PR #3435, any imported files within a modules file needs to use the relative style path.

Can you please update these imports accordingly?

We updated the imports.

jsnellbaker · 2019-05-14T16:15:20Z

modules/cpmstarBidAdapter.js

+
+  onTimeout(timeout) {
+  },
+  onBidWon(winningBid) {


You can remove these functions from the adapter if you're not planning on using them.

Thanks, these have been removed.

jsnellbaker · 2019-05-14T16:17:25Z

modules/cpmstarBidAdapter.js

+      var raw = serverResponse.body[i];
+      var rawBid = raw.creatives[0];
+      if (!rawBid) {
+        return;


As a suggestion, it may nice to add some log messages here (such as utils.logWarn()) to indicate something was missing from the bid response. It would make it easier to debug by seeing the message in the browser console.

We added a few log messages, thanks!

jsnellbaker · 2019-05-14T16:28:08Z

modules/cpmstarBidAdapter.js

+        netRevenue: rawBid.netRevenue ? rawBid.netRevenue : true,
+        ttl: rawBid.ttl ? rawBid.ttl : DEFAULT_TTL,
+        creativeId: rawBid.creativeid || 0,
+        ad: ''


Given you're supporting both video and banner bids, I'd recommend to remove this default value for the ad property. The ad is only used in the banner type, so it would be left equal to an empty string when you just serve back a video bid.

Having both fields present in the bid may cause some confusion, so it'd be better to only assign the property when its needed.

This has been removed -- thanks for the tip.

jsnellbaker · 2019-05-14T16:31:23Z

test/spec/modules/cpmstarBidAdapter_spec.js

+      expect(requests[0]).to.have.property('method');
+      expect(requests[0]).to.have.property('url');
+      expect(requests[0]).to.have.property('bidRequest');
+      expect(requests[0].url.startsWith('//server.cpmstar.com/view.aspx')).to.equal(true);


The startsWith property is not compatible with IE browsers - which is why the browserstack tests are failing for this PR. Can you use an alternate assertion for this part of the tests?

I think you could use chai's includes instead to get the same effect (see example below).
expect(requests[0].url).to.include('//dev.server.cpmstar.com/view.aspx');

This test has been updated for IE compatibility.

…ded warnings to erroneous server responses, and removed the default value for ad in bid response.

JoshuaMGoldstein · 2019-05-15T01:25:43Z

We tested the banner placement with the helloworld example, which works fine.

But the only working video example we could find (in the prebid.org docs repo, under: examples/video/jwPlayerPrebid.html) uses pbjs.adServers.dfp.buildVideoUrl.

DFP does not seem to like the vastUrl/vastXml/videoCacheKey returned by bidsBackHandler from our bidder, and DFP will not provide our vastXml at the url provided by dfp.buildVideoUrl()

However, in the above referenced example, calling invokeVideoPlayer() with our bid's vastUrl directly as follows:

invokeVideoPlayer(bids.video1.bids[0].vastUrl)

..works just fine. The vastUrl/vastXml contains a proper VAST 2.0 response from our ad server.

Please advise. Thank you!

jsnellbaker · 2019-05-17T16:06:57Z

@JoshuaMGoldstein

That jwPlayerPrebid.html test page should provide a good idea on how it could be setup (I'll see if we can upload a dedicated test page in the repo for easier access).

The key would be to use the pbjs.adServers.dfp.buildVideoUrl() function to generate the proper ad URL that DFP would be able to process. It grabs the necessary bid keys/data and formats that info into the query portion of the ad URL. DFP uses these keys to help call Prebid Cache to grab the actual VAST creative which then (hopefully) gets processed by the player.

This whole process is similar with other types of ads (such as banner), where we call the equivalent setTargetingForGPTAsync() function in the bidsBackHandler to initialize some keys on a DFP ad URL, which then would call a specific Prebid creative that's sitting in DFP, which is then used to help render the actual ad. We don't just try to directly pass the ad-markup code to DFP, instead use the necessary handlers/functions to to pass along the right bits of info.

I hope the above makes sense. If so, do you have any test bid params for a video bid that I could to run a check?

JoshuaMGoldstein · 2019-05-17T16:36:14Z

We added the test parameters for video, above in the PR description:

{
bidder: 'cpmstar',
params: {
placementId: 81007
}
}

The prebid cache is indeed loading the vast XML properly, and the bid response contains a xmlCacheKey and the xmlVastUrl on the prebid cache. However, DFP's resulting URL does not appear to mirror the VAST creative effectively in the example cited.

Actually, our banner code works fine with both hello world and the example here
http://prebid.org/dev-docs/examples/basic-example.html
..which uses pbjs.setTargetingForGPTAsync();

But not with the DFP video examples. The url generated by pbjs.adServers.dfp.buildVideoUrl() returns an empty response. We examined the docs provided by DFP, but it appears this is some kind of issue relating to the cust_params= section of the URL, which DFP does not document except to say they are custom key-value pairs.

JoshuaMGoldstein · 2019-05-18T02:52:24Z

Ok, we tested 3 other video adapters using their test placements and none of them worked in the jwPlayerPrebid.html example. Adapters tested:

lkqd, vuble, oneVideo.

The only adapter which seems to currently work with this is example is appnexus

jsnellbaker · 2019-05-21T15:35:06Z

@JoshuaMGoldstein I found the likely issue; the DFP campaign that was setup for those test pages has a keyword targeting on the hb_pb key; it expects it to be 5.00.

I added the following code to dynamically adjust the CPM of your test bid to the ideal value and I saw the preroll ad play through the player (the video.js one).

pbjs.bidderSettings = {
        cpmstar: {
          bidCpmAdjustment: function(bid) {
            return 5.00;
          }
        }
      }

This should work on your end as well if you want to give it a try. From my end, everything looks good now and we can merge this PR.

* Added CPMStar Bid Adapter * Updated getPlayerSize for cpmstarBidAdapter * Improved cpmstarBidAdapter code coverage * updated test spec, removed empty functions, made imports relative, added warnings to erroneous server responses, and removed the default value for ad in bid response. * added test video ad unit

JoshuaMGoldstein added 3 commits May 10, 2019 19:54

Added CPMStar Bid Adapter

cd66b75

Updated getPlayerSize for cpmstarBidAdapter

1f60e6c

Improved cpmstarBidAdapter code coverage

8020923

jsnellbaker requested a review from sumit116 May 13, 2019 12:58

jsnellbaker assigned sumit116 May 13, 2019

jsnellbaker added the needs review label May 13, 2019

jsnellbaker requested review from jsnellbaker and removed request for sumit116 May 14, 2019 14:11

jsnellbaker assigned jsnellbaker and unassigned sumit116 May 14, 2019

jsnellbaker requested changes May 14, 2019

View reviewed changes

jsnellbaker added needs update and removed needs review labels May 14, 2019

Nicholas Elek added 2 commits May 14, 2019 15:42

updated test spec, removed empty functions, made imports relative, ad…

06911ae

…ded warnings to erroneous server responses, and removed the default value for ad in bid response.

added test video ad unit

c43d765

jsnellbaker approved these changes May 21, 2019

View reviewed changes

jsnellbaker added LGTM and removed needs update labels May 21, 2019

jsnellbaker merged commit 7846560 into prebid:master May 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CPMStar Bid Adapter #3820

CPMStar Bid Adapter #3820

JoshuaMGoldstein commented May 11, 2019 •

edited

Loading

jsnellbaker left a comment

jsnellbaker May 14, 2019

JoshuaMGoldstein May 15, 2019

jsnellbaker May 14, 2019

JoshuaMGoldstein May 15, 2019

jsnellbaker May 14, 2019

JoshuaMGoldstein May 15, 2019

jsnellbaker May 14, 2019

JoshuaMGoldstein May 15, 2019

jsnellbaker May 14, 2019

JoshuaMGoldstein May 15, 2019

JoshuaMGoldstein commented May 15, 2019

jsnellbaker commented May 17, 2019

JoshuaMGoldstein commented May 17, 2019 •

edited

Loading

JoshuaMGoldstein commented May 18, 2019

jsnellbaker commented May 21, 2019

		@@ -0,0 +1,121 @@
		import * as utils from 'src/utils';
		import { registerBidder } from 'src/adapters/bidderFactory';

CPMStar Bid Adapter #3820

CPMStar Bid Adapter #3820

Conversation

JoshuaMGoldstein commented May 11, 2019 • edited Loading

Type of change

Description of change

Other information

jsnellbaker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoshuaMGoldstein commented May 15, 2019

jsnellbaker commented May 17, 2019

JoshuaMGoldstein commented May 17, 2019 • edited Loading

JoshuaMGoldstein commented May 18, 2019

jsnellbaker commented May 21, 2019

JoshuaMGoldstein commented May 11, 2019 •

edited

Loading

JoshuaMGoldstein commented May 17, 2019 •

edited

Loading