New STAQ analytics adapter #3772

mquirion · 2019-04-22T17:06:32Z

Type of change

Bugfix
Feature
New bidder adapter
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Does this change affect user-facing APIs or examples documented on http://prebid.org?
[x ] Other - Analytics Adapter

Description of change

New STAQ Analytics Adapter to gather Prebid.js event data and forward to STAQ's reporting platform.

dev@staq.com
official adapter submission

For any changes that affect user-facing APIs or example code documented on http://prebid.org, please provide:

A link to a PR on the docs repo at https://github.com/prebid/prebid.github.io/

Other information

…js-1 into new_staq_adapter

…serstack

sumit116 · 2019-04-29T16:35:48Z

@mquirion Please remove package-lock.json changes. You can rebase the file with master branch.

sumit116

Hi,
Thanks for submitting your adaptor. I tested your adaptor on hello-world page and found some changes required in your adaptor files, mentioned in my comments. Can you please make the necessary changes and let me know if you have any questions.

sumit116 · 2019-04-29T15:30:00Z

modules/staqAnalyticsAdapter.md

+  provider: 'staq',
+  options: {
+    host: , // HOST URL of site. Optional. Only required for whitelisting.
+    url: 'localhost:3000', // REQUIRED host URL for delivery of information to STAQ


Please provide staging/dev or any other url which would allow me to test the request and response.

@sumit116 thanks for your review.

We don't currently have an outside facing url that we leave standing. Would it be possible to select a period of time when we could stand this up? Or should I just go ahead and work with our ops folks to stand up a long-living staging endpoint?

@mquirion, how long can you keep the quick-server standing? If its a whole day, you can set it up on Monday and update me with the details. If its for a shorter duration, then we have to coordinate something definite since our timezones are different (I work in IST).

@sumit116 actually, you can use the following...

options: { url: 'headerbidding.staging.staqdata.com', connId: '1234' }

And that will get you hitting our staging server which we can leave open for a while. Thank you.

Thanks for providing these credentials; I gave them a try and found they were working. I saw the events get sent to the staging endpoint.

modules/staqAnalyticsAdapter.js

sumit116 · 2019-04-29T15:37:03Z

modules/staqAnalyticsAdapter.js

+
+function buildRequestTemplate(connId) {
+  const url = utils.getTopWindowUrl();
+  const ref = utils.getTopWindowReferrer();


getTopWindowReferrer() is also depreciated and needs to be replaced.

updated to use new ref code

modules/staqAnalyticsAdapter.js

sumit116 · 2019-04-29T15:55:11Z

modules/staqAnalyticsAdapter.js

+        if (analyticsAdapter.context.queue) {
+          analyticsAdapter.context.queue.push(events);
+          if (eventType === CONSTANTS.EVENTS.BID_WON) {
+


Can we add some code here. I can suggest to return an object { auctionId: args.auctionId, size: args.width + 'x' + args.height };

updated to handle win and update response event to indicate it won

sumit116 · 2019-04-30T09:35:59Z

@mquirion Can you provide docs PR link. If not created, please create one.

sumit116 · 2019-05-08T13:21:11Z

@mquirion, please give an update on #3772 (comment)

jsnellbaker

Hi @mquirion

@sumit116 is ooo for a bit, so I wanted to jump in here. I took a look through the adapter and it largely seems good. There are a few areas where some commented code/tests could be removed (I noted the areas in the feedback below). Once that is addressed, we should be good to merge.

modules/staqAnalyticsAdapter.js

jsnellbaker · 2019-05-16T13:47:58Z

modules/staqAnalyticsAdapter.md

+  provider: 'staq',
+  options: {
+    host: , // HOST URL of site. Optional. Only required for whitelisting.
+    url: 'localhost:3000', // REQUIRED host URL for delivery of information to STAQ


Thanks for providing these credentials; I gave them a try and found they were working. I saw the events get sent to the staging endpoint.

test/spec/modules/staqAnalyticsAdapter_spec.js

jsnellbaker · 2019-05-16T13:49:54Z

test/spec/modules/staqAnalyticsAdapter_spec.js

+      // let ev = JSON.parse(secondCallArgs);
+      // console.log('AUCTION WON EVENT SHAPE ' + JSON.stringify(ev));
+      // let firstEv = JSON.parse(ajaxStub.firstCall.args)
+      // console.log('FIRST CALL ARGS ' + JSON.stringify(firstEv));


Can you remove this commented code if it's no longer needed?

@jsnellbaker thanks for your review and your help. I think I've got everything you asked for cleared up.

test/spec/modules/staqAnalyticsAdapter_spec.js

mquirion · 2019-05-23T17:54:43Z

@mquirion Can you provide docs PR link. If not created, please create one.

@sumit116 @jsnellbaker I'm not entirely clear on what this is a request for.

jaiminpanchal27 · 2019-05-23T18:38:42Z

@mquirion
Please submit a PR to the docs repo to add your analytics adapter so your analytics adapter's will appear on the this page. Thank you for contributing

jsnellbaker

@mquirion Thanks for making the code updates to the main file and the unit tests. From that perspective, we look good now.

If you can submit a docs PR (see comments above), then we can merge this PR.

mquirion · 2019-06-05T19:19:43Z

@mquirion Can you provide docs PR link. If not created, please create one.

Hi @sumit116 here's the PR for the doc update. Thanks for your help on this!

prebid/prebid.github.io#1341

* initial dev * fix staq adapter name * fix hello world staq call * get hello world working again * add user agent collection * fix some unite tests * Add STAQ Analytics Adapter doc * clean up hello world * fix tests to play nice with browserstack * fix around issues with browserstack and deep equals of objects * dump variable env testing since we can't mod user agent stuff in browserstack * Update STAQ adapter to stop using deprecated utils for referrer * remove package-lock.json changes via master rebase * improve call frequency for ref util * change ajax content type * adjust ajax request to not expect whitelisting * remove superflous commented-out code

mquirion added 13 commits April 9, 2019 10:29

initial dev

2bad754

fix staq adapter name

ee55125

fix hello world staq call

05ea85f

get hello world working again

d07cc87

add user agent collection

d394ee4

fix some unite tests

a68a198

Add STAQ Analytics Adapter doc

f35c925

clean up hello world

1abff32

Merge branch 'master' into new_staq_adapter

7bf3c70

fix tests to play nice with browserstack

a4e1f62

Merge branch 'new_staq_adapter' of https://github.com/staqapp/Prebid.…

4da31a1

…js-1 into new_staq_adapter

fix around issues with browserstack and deep equals of objects

b5b032f

dump variable env testing since we can't mod user agent stuff in brow…

5ec6ff2

…serstack

jaiminpanchal27 assigned sumit116 Apr 23, 2019

jaiminpanchal27 added the needs review label Apr 23, 2019

sumit116 suggested changes Apr 29, 2019

View reviewed changes

sumit116 added the needs update label Apr 29, 2019

mquirion added 3 commits May 2, 2019 13:26

Update STAQ adapter to stop using deprecated utils for referrer

f479411

remove package-lock.json changes via master rebase

8eaa16f

improve call frequency for ref util

53b52b0

mquirion added 2 commits May 14, 2019 13:41

change ajax content type

ec4a1a1

adjust ajax request to not expect whitelisting

0eb0166

jsnellbaker requested changes May 16, 2019

View reviewed changes

remove superflous commented-out code

ef83a4f

jsnellbaker approved these changes Jun 3, 2019

View reviewed changes

jsnellbaker added needs docs and removed needs review needs update labels Jun 3, 2019

jsnellbaker merged commit 81932cd into prebid:master Jun 5, 2019

sumit116 removed the needs docs label Jun 24, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New STAQ analytics adapter #3772

New STAQ analytics adapter #3772

mquirion commented Apr 22, 2019

sumit116 commented Apr 29, 2019

sumit116 left a comment

sumit116 Apr 29, 2019

mquirion May 2, 2019

sumit116 May 3, 2019 •

edited

Loading

mquirion May 15, 2019

jsnellbaker May 16, 2019

sumit116 Apr 29, 2019

mquirion May 2, 2019

sumit116 Apr 29, 2019

mquirion May 2, 2019

sumit116 commented Apr 30, 2019

sumit116 commented May 8, 2019

jsnellbaker left a comment

jsnellbaker May 16, 2019

jsnellbaker May 16, 2019

mquirion May 23, 2019

mquirion commented May 23, 2019

jaiminpanchal27 commented May 23, 2019

jsnellbaker left a comment

mquirion commented Jun 5, 2019

New STAQ analytics adapter #3772

New STAQ analytics adapter #3772

Conversation

mquirion commented Apr 22, 2019

Type of change

Description of change

Other information

sumit116 commented Apr 29, 2019

sumit116 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sumit116 May 3, 2019 • edited Loading

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

sumit116 commented Apr 30, 2019

sumit116 commented May 8, 2019

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

mquirion commented May 23, 2019

jaiminpanchal27 commented May 23, 2019

jsnellbaker left a comment

Choose a reason for hiding this comment

mquirion commented Jun 5, 2019

sumit116 May 3, 2019 •

edited

Loading