add adot bidder adapter #4949

mlequain · 2020-03-09T09:38:57Z

Type of change

New bidder adapter

Description of change

Add adot bidder adapter

test parameters for validating bids

{
  bidder: 'adot',
  params: {
    placementId: 'adot_prebidjs_integration'
  }
}

Be sure to test the integration with your adserver using the Hello World sample page.

contact email of the adapter’s maintainer: [email protected]
official adapter submission

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

Documentation PR: add adot bidder adapter documentation prebid.github.io#1846

jsnellbaker

Hi @mlequain

Thank you for submitting this new adapter. There are a few things that I observed that need to be initially addressed since they're causing errors or aren't supported by the Prebid.js project.

Can you please take a look when you can?

Thanks!

jsnellbaker · 2020-03-11T12:56:01Z

modules/adotBidAdapter.js

+const NET_REVENUE = true;
+// eslint-disable-next-line no-template-curly-in-string
+const AUCTION_PRICE = '${AUCTION_PRICE}';
+const OUTSTREAM_VIDEO_PLAYER_URL = 'http://adserver.adotmob.com/video/player.min.js';


This host path should be secure.

jsnellbaker · 2020-03-11T12:57:54Z

modules/adotBidAdapter.js

+function isObject(value) {
+  return (value !== null) && (typeof (value) === 'object') && !isArray(value);
+}
+
+function isArray(value) {
+  return Array.isArray(value);
+}
+
+function isString(value) {
+  return (typeof (value) === 'string');
+}
+
+function isNumber(value) {
+  return (typeof (value) === 'number');
+}
+
+function isBoolean(value) {
+  return (typeof (value) === 'boolean');
+}


All these functions can be found in the src/utils.js file under similar names. It may ideal (and save some space in your adapter) to use those instead.

jsnellbaker · 2020-03-11T12:59:22Z

modules/adotBidAdapter.js

+function groupBy(values, key) {
+  const groups = values.reduce((acc, value) => {
+    const groupId = value[key];
+
+    if (!acc[groupId]) acc[groupId] = [];
+    acc[groupId].push(value);
+
+    return acc;
+  }, {});
+
+  return Object
+    .entries(groups)
+    .map(([id, values]) => ({id, key, values}));
+}


There is a similar function available in the src/utils.js, could you review that function to see if it would meet your needs here?

The function in the src/utils.js does not format the values the same way unfortunately. Do you want me to rename the method to avoid confusion ?

jsnellbaker · 2020-03-11T13:04:03Z

modules/adotBidAdapter.js

+  return isArray(mediaSize) &&
+    (mediaSize.length === 2) &&
+    mediaSize.every(size => (isNumber(size) && size >= 0));


There is a function in the src/utils.js named isArrayOfNums that I believe basically the same type of check here. Perhaps you could use it instead.

The issue with isArrayOfNums is that it does not check if the value is superior to 0.

jsnellbaker · 2020-03-11T13:05:33Z

modules/adotBidAdapter.js

+    const base = {bidId, adUnitCode, container: params.video && params.video.container};
+
+    const imps = Object
+      .entries(mediaTypes)


This property is not supported in IE11. Is there an alternative you can use instead?

jsnellbaker · 2020-03-11T17:38:03Z

modules/adotBidAdapter.js

+  if (!isObject(bid.ext)) return false;
+  if (!isObject(bid.ext.adot)) return false;
+  if (!isString(bid.ext.adot.media_type)) return false;
+  if (!BID_SUPPORTED_MEDIA_TYPES.includes(bid.ext.adot.media_type)) return false;


Please see earlier note.

jsnellbaker · 2020-03-11T17:38:10Z

modules/adotBidAdapter.js

+  if (!bid.adm && !bid.nurl) return false;
+  if (bid.adm) {
+    if (!isString(bid.adm)) return false;
+    if (!bid.adm.includes(AUCTION_PRICE)) return false;


Please see earlier note.

jsnellbaker · 2020-03-11T17:38:15Z

modules/adotBidAdapter.js

+  }
+  if (bid.nurl) {
+    if (!isString(bid.nurl)) return false;
+    if (!bid.nurl.includes(AUCTION_PRICE)) return false;


Please see earlier note.

jsnellbaker · 2020-03-11T17:38:25Z

modules/adotBidAdapter.js

+    const allowedBidderCodes = [this.code];
+
+    return isObject(adUnit) &&
+      allowedBidderCodes.includes(adUnit.bidder) &&


Please see earlier note.

jsnellbaker · 2020-03-11T17:43:45Z

test/spec/modules/adotBidAdapter_spec.js

+import { executeRenderer } from 'src/Renderer';
+import * as utils from 'src/utils';
+import { spec } from 'modules/adotBidAdapter';


Please include the .js extension on these imports as well (eg. src/Renderer.js).

mlequain · 2020-03-12T14:28:56Z

@jsnellbaker I've updated the code to address the issues you mentioned in your previous comment.

Let me know if there is anything that I missed or if you want me to change anything else.

stale · 2020-03-26T15:38:27Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

jsnellbaker

Hi @mlequain

Sorry for the delay here; thank you for making the updates. I looked through again, and it looks better. There is another function that needs to be updated because it's not available in IE11. I made a suggestion for an alternative, please see the comment below.

Additionally, when I tried to test the adapter with the params provided in the description - the endpoint didn't appear to be returning a response. The endpoint returned a 204 No Content response.

I copied the request payload in case that may be a factor:

{"id":"1693a3242bca91","imp":[{"id":"2540029fc5df2c_0_0","banner":{"format":[{"w":300,"h":250}],"w":300,"h":250,"pos":0},"pmp":{"deals":[{"id":"adot_prebidjs_integration"}]}},{"id":"2540029fc5df2c_0_1","banner":{"format":[{"w":300,"h":600}],"w":300,"h":600,"pos":0},"pmp":{"deals":[{"id":"adot_prebidjs_integration"}]}}],"site":{"page":"http://test.localhost:9999/integrationExamples/gpt/hello_world.html?pbjs_debug=true","domain":"test.localhost:9999","name":"test.localhost:9999"},"device":{"ua":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36","language":"en-US"},"user":null,"regs":null,"at":1,"ext":{"adot":{"adapter_version":"v1.0.0"},"should_use_gzip":true}}

Can you please take a look? We need to have a valid test bid to verify new adapters to ensure the end-to-end workflow is working properly.

In addition, you have some example test params for native and both video (outstream and instream) that I can use to test?

Please let me know if you have any questions about the above. Thanks!

jsnellbaker · 2020-03-26T17:52:38Z

modules/adotBidAdapter.js

+  const openRTBImpression = serverRequest.data.imp.find(imp => imp.id === impressionId);
+  const internalImpression = serverRequest._adot_internal.impressions.find(imp => imp.impressionId === impressionId);


The find function isn't directly supported in IE11. There is an alternative polyfill you can import to use instead.

The import path would look like:

import find from 'core-js/library/fn/array/find.js';

You can refer to the appnexusBidAdapter.js to see some examples of how it's used (like here).

mlequain · 2020-04-03T09:30:54Z

Hi @jsnellbaker

Sorry for the late reply.

I've updated the code to remove the calls to find and use the polyfill instead, let me know if everything is OK.

Below you'll find the adUnits you can use to test the video (outstream & instream) as well as the native.

Instream adUnit

const adUnit = {
    code: 'test-div',
    mediaTypes: {
        video: {
            context: 'instream',
            playerSize: [[300, 250]]
        }
    },
    bids: [{
        bidder: 'adot',
        params: {
            video: {
                mimes: ['video/mp4'],
                minDuration: 5,
                maxDuration: 35,
                protocols: [2, 3],
                instreamContext: 'pre-roll'
            },
            placementId: 'adot_prebidjs_integration'
        }
    }]
}

Outstream adUnit

const adUnit = {
    code: 'test-div',
    mediaTypes: {
        video: {
            context: 'outstream',
            playerSize: [[300, 250]]
        }
    },
    bids: [{
        bidder: 'adot',
        params: {
            video: {
                mimes: ['video/mp4'],
                minDuration: 5,
                maxDuration: 35,
                protocols: [2, 3]
            },
            placementId: 'adot_prebidjs_integration'
        }
    }]
}

Native adUnit

const adUnit = {
    code: 'test-div',
    mediaTypes: {
        native: {
                image: {
                    required: false,
                    sizes: [100, 50]
                },
                title: {
                    required: false,
                    len: 140
                },
                sponsoredBy: {
                    required: false
                },
                clickUrl: {
                    required: false
                },
                body: {
                    required: false
                },
                icon: {
                    required: false,
                    sizes: [50, 50]
                }
        }
    },
    bids: [{
        bidder: 'adot',
        params: {
    	    placementId: 'adot_prebidjs_integration'
        }
    }]
}

jsnellbaker · 2020-04-03T19:05:33Z

Hi @mlequain

Thanks for providing the updated information. I checked through each of the mediaTypes.

Please see below for my feedback:

Banner > working fine.
Instream > it appears that the created bid does not have its vastXml and/or vastUrl populated. I did observe there was a key named adUrl with what looked like a vastUrl value. If that is the ad payload, this should be assigned to the vastUrl field instead. In its current state, the bid is getting rejected by Prebid since it doesn't have the expected vast properties defined.
Outstream > it appears that the bid information was being passed to the bid's renderer. I didn't physically see the player appear on the page, but that may just be the page itself. If you're sure the outstream code works in your test pages, then this is fine.
Native > I'm not seeing a bid return from the endpoint (response is just a 204 No Content). I have copied the request payload for review:

{"id":"1116802233e543","imp":[{"id":"2dc85247667e9_0","native":{"request":"{\"assets\":[]}"},"pmp":{"deals":[{"id":"adot_prebidjs_integration"}]}}],"site":{"page":"http://test.localhost:9999/integrationExamples/gpt/demo_native.html?pbjs_debug=true","domain":"test.localhost:9999","name":"test.localhost:9999"},"device":{"ua":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36","language":"en-US"},"user":null,"regs":null,"at":1,"ext":{"adot":{"adapter_version":"v1.0.0"},"should_use_gzip":true}}

Can you take a look to see why the native bid isn't returning and about the feedback on the instream?

…move duplicate code

mlequain · 2020-04-06T11:48:26Z

Hi @jsnellbaker

I have updated the code to make sure we either return a vastUrl or a vastXml for all the video bids, the instream video should now be returning a valid prebid ad.

The outstream video is working fine on my end.

I managed to bid on the native ad using your bid request, let me know if it's working on your end as well.

jsnellbaker · 2020-04-06T17:35:27Z

@mlequain

Thanks for the follow-up. I retested the video instream and saw it was working.

However, I tried the native test again, but I'm still not seeing a bid return.

I noticed the sample params had an extra native object under the mediaTypes. When I removed that, I saw the native asset data was properly added to the imp[0].native.request.assets (where before it wasn't). But this didn't appear to help return a bid.

I have copied the updated request payload below, can you take a look and advise?

{"id":"1d746d3476ea1e","imp":[{"id":"2ba0032f0a9c5a_0","native":{"request":"{\"assets\":[{\"id\":3,\"required\":false,\"img\":{\"type\":3,\"wmin\":100,\"hmin\":50}},{\"id\":1,\"required\":false,\"title\":{\"len\":140}},{\"id\":4,\"required\":false,\"data\":{\"type\":1}},{\"id\":5,\"required\":false,\"data\":{\"type\":2}},{\"id\":2,\"required\":false,\"img\":{\"type\":1,\"wmin\":50,\"hmin\":50}}]}"},"pmp":{"deals":[{"id":"adot_prebidjs_integration"}]}}],"site":{"page":"http://test.localhost:9999/integrationExamples/gpt/demo_native.html?pbjs_debug=true","domain":"test.localhost:9999","name":"test.localhost:9999"},"device":{"ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 13_2_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Mobile/15E148 Safari/604.1","language":"en-US"},"user":null,"regs":null,"at":1,"ext":{"adot":{"adapter_version":"v1.0.0"},"should_use_gzip":true}}

mlequain · 2020-04-07T09:41:27Z

@jsnellbaker

I have updated the adapter documentation and my previous comment to fix the mistake in the native snippet.

I have also updated some targeting parameters on my end and I'm seeing bids for the native ad using your bid request.

Let me know if everything is working on your end.

Thanks a lot

jsnellbaker · 2020-04-07T18:18:56Z

@mlequain Thanks for the additional update, I am getting a native bid back now. LGTM

mlequain · 2020-04-07T18:47:50Z

@jsnellbaker Thanks a lot for your help !

* add adot bidder adapter * remove promises and other methods to ensure IE11 compatibility and remove duplicate code Co-authored-by: Maxime Lequain <[email protected]>

add adot bidder adapter

b46a969

MartianTribe mentioned this pull request Mar 9, 2020

add adot bidder adapter documentation prebid/prebid.github.io#1846

Merged

mkendall07 requested a review from jsnellbaker March 11, 2020 02:23

mkendall07 assigned jsnellbaker Mar 11, 2020

jsnellbaker requested changes Mar 11, 2020

View reviewed changes

jsnellbaker added the needs update label Mar 11, 2020

mlequain force-pushed the master branch from 1ac3331 to c64e1e7 Compare March 12, 2020 15:08

stale bot added the stale label Mar 26, 2020

jsnellbaker removed the stale label Mar 26, 2020

jsnellbaker requested changes Mar 26, 2020

View reviewed changes

mlequain force-pushed the master branch from c64e1e7 to 41846fc Compare April 3, 2020 09:23

remove promises and other methods to ensure IE11 compatibility and re…

675cb58

…move duplicate code

mlequain force-pushed the master branch from 41846fc to 675cb58 Compare April 6, 2020 11:43

jsnellbaker approved these changes Apr 7, 2020

View reviewed changes

jsnellbaker merged commit 73d5861 into prebid:master Apr 7, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add adot bidder adapter #4949

add adot bidder adapter #4949

mlequain commented Mar 9, 2020

jsnellbaker left a comment

jsnellbaker Mar 11, 2020

jsnellbaker Mar 11, 2020

jsnellbaker Mar 11, 2020

mlequain Mar 12, 2020

jsnellbaker Mar 11, 2020

mlequain Mar 12, 2020

jsnellbaker Mar 11, 2020

jsnellbaker Mar 11, 2020

jsnellbaker Mar 11, 2020

jsnellbaker Mar 11, 2020

jsnellbaker Mar 11, 2020

jsnellbaker Mar 11, 2020

mlequain commented Mar 12, 2020

stale bot commented Mar 26, 2020

jsnellbaker left a comment

jsnellbaker Mar 26, 2020

mlequain commented Apr 3, 2020 •

edited

Loading

jsnellbaker commented Apr 3, 2020

mlequain commented Apr 6, 2020

jsnellbaker commented Apr 6, 2020

mlequain commented Apr 7, 2020

jsnellbaker commented Apr 7, 2020

mlequain commented Apr 7, 2020

		const openRTBImpression = serverRequest.data.imp.find(imp => imp.id === impressionId);
		const internalImpression = serverRequest._adot_internal.impressions.find(imp => imp.impressionId === impressionId);

add adot bidder adapter #4949

add adot bidder adapter #4949

Conversation

mlequain commented Mar 9, 2020

Type of change

Description of change

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlequain commented Mar 12, 2020

stale bot commented Mar 26, 2020

jsnellbaker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlequain commented Apr 3, 2020 • edited Loading

Instream adUnit

Outstream adUnit

Native adUnit

jsnellbaker commented Apr 3, 2020

mlequain commented Apr 6, 2020

jsnellbaker commented Apr 6, 2020

mlequain commented Apr 7, 2020

jsnellbaker commented Apr 7, 2020

mlequain commented Apr 7, 2020

mlequain commented Apr 3, 2020 •

edited

Loading