Support multiple media formats within a single ad unit #1991

matthewlane · 2017-12-21T22:56:08Z

Type of change

Feature

Description of change

This change supports declaring multiple media formats on a single ad unit, and allowing any bidder that supports at least one of those media formats to participate in that ad unit.

Previously, only one media format per ad type was supported, and only bidders that were compatible with that media format were eligible to participate.

Now, an ad unit can declare multiple media types, and any bidder that supports at least one of those types may take part in that auction. Any bidder that isn't compatible with the specified mediaTypes will be dropped from the ad unit. If mediaTypes is not specified on an ad unit, banner is the assumed format and any banner bidder is eligible for inclusion.

This PR also adds hb_format to standard targeting and sets its value based on the bid response object's mediaType property.

Examples:

// each bidder supports at least one of the formats, so all will participate
pbjs.addAdUnits({
  code: 'adunit-code',
  sizes: [[300, 250], [300, 300]],
  mediaTypes: {
    banner: {},
    native: {},
    video: {context: 'outstream'},
  },
  bids: [

    {
      bidder: 'bannerBidder',
      params: {placementId: '481'}
    },

    {
      bidder: 'nativeBidder',
      params: {titleAsset: '516'}
    },

    {
      bidder: 'videoBidder',
      params: {vidId: '234'}
    },

  ]
});

// only nativeBidder and videoBidder will participate
pbjs.addAdUnits({
  code: 'adunit-code',
  sizes: [[300, 250], [300, 300]],
  mediaTypes: {
    native: {},
    video: {context: 'outstream'},
  },
  bids: [

    {
      bidder: 'bannerBidder',
      params: {placementId: '481'}
    },

    {
      bidder: 'nativeBidder',
      params: {titleAsset: '516'}
    },

    {
      bidder: 'videoBidder',
      params: {vidId: '234'}
    },

  ]
});

mkendall07

Awesome work! LGTM

mkendall07 · 2018-01-05T20:16:20Z

needs a linked docs PR before merge

mkendall07 · 2018-01-08T16:05:10Z

@matthewlane
Do we need a standard key for media type now?

matthewlane · 2018-01-09T23:52:03Z

Added hb_mediatype commit, and initial docs draft here prebid/prebid.github.io#541

mkendall07 · 2018-01-22T17:43:46Z

src/constants.json

@@ -52,7 +52,8 @@
    "hb_pb",
    "hb_size",
    "hb_deal",
-    "hb_source"
+    "hb_source",
+    "hb_mediatype"


@matthewlane can you change this to hb_format instead?
it's a little bit shorter

jaiminpanchal27 · 2018-01-22T21:24:13Z

modules/appnexusBidAdapter.js

@@ -31,7 +30,7 @@ const SOURCE = 'pbjs';
 export const spec = {
  code: BIDDER_CODE,
  aliases: ['appnexusAst', 'brealtime', 'pagescience', 'defymedia', 'gourmetads', 'matomy', 'featureforward', 'oftmedia', 'districtm'],
-  supportedMediaTypes: [VIDEO, NATIVE],
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],


@matthewlane If i am not wrong all other adapters supporting video or native also needs to be updated. As of now https://github.com/prebid/Prebid.js/blob/master/modules/rubiconBidAdapter.js#L76 Rubicon will not work for banner

Thanks, looking in to this

Good callout @jaiminpanchal27. I went through all adapters that have supportedMediaTypes and added 'banner' to those that do support it in addition to 'native' or 'video'. Some adapters only support 'native' or 'video', determined by looking at code and corresponding .md files, and in those cases supportedMediaTypes are left unchanged

…e of the mediaTypes

…plicitly supporting banner

jaiminpanchal27

LGTM

* 'master' of https://github.com/prebid/Prebid.js: Prebid 1.2.0 Release Use polyfilled includes method (prebid#2061) RockYou Adapter: Added RockYou Adapter supporting Prebid 1.0 (prebid#1977) Optimera Adapter for 1.0. (prebid#1961) Use cross-browser integer check (prebid#2058) Fix skipped test (prebid#2059) Support multiple media formats within a single ad unit (prebid#1991) pre1api module that allows use of deprecated pre1.0 API in Prebid 1.0 (prebid#1976) Colossus SSP header bidding adapter 1.0.0 (prebid#2029) InSkin Bidder Adapter (prebid#2016) Update adapter to prebid v1.0 (prebid#1908) PubMatic 1.0 adapter (prebid#2011)

ghost assigned matthewlane Dec 21, 2017

ghost added the in progress label Dec 21, 2017

mjacobsonny added the needs docs label Jan 2, 2018

matthewlane removed the in progress label Jan 2, 2018

matthewlane removed their assignment Jan 2, 2018

matthewlane added the needs review label Jan 2, 2018

matthewlane requested a review from mkendall07 January 3, 2018 00:05

matthewlane assigned mkendall07 Jan 3, 2018

mkendall07 approved these changes Jan 5, 2018

View reviewed changes

mkendall07 added LGTM and removed needs review labels Jan 5, 2018

matthewlane force-pushed the multiformat-requests branch from 2d64a45 to e6520b3 Compare January 9, 2018 19:58

ghost assigned matthewlane Jan 9, 2018

ghost added the in progress label Jan 9, 2018

matthewlane removed their assignment Jan 9, 2018

matthewlane removed the in progress label Jan 9, 2018

matthewlane mentioned this pull request Jan 9, 2018

Add multiformat ad unit information prebid/prebid.github.io#541

Merged

matthewlane force-pushed the multiformat-requests branch 2 times, most recently from 6247fe7 to 2808763 Compare January 18, 2018 21:05

ghost assigned matthewlane Jan 18, 2018

ghost added the in progress label Jan 18, 2018

matthewlane removed their assignment Jan 19, 2018

matthewlane removed in progress needs docs labels Jan 19, 2018

mkendall07 requested changes Jan 22, 2018

View reviewed changes

ghost assigned matthewlane Jan 22, 2018

ghost added the in progress label Jan 22, 2018

matthewlane removed their assignment Jan 22, 2018

matthewlane removed the in progress label Jan 22, 2018

jaiminpanchal27 self-requested a review January 22, 2018 20:26

jaiminpanchal27 reviewed Jan 22, 2018

View reviewed changes

matthewlane added 8 commits January 22, 2018 15:10

Populate ad_types array on all requests

87ddcfd

Remove descriptionUrl

97f5cb1

Allow a bidder to participate on an adunit if it supports at least on…

98a70c9

…e of the mediaTypes

Add hb_mediatype to standard targeting

8aed0bf

Determine when to trigger callback based on bid response

659dc3a

Change key to hb_format

fcc09f2

Print banner as default when mediaTypes not defined

11c0f7f

Update spportedMediaTypes to include banner for adapters that were im…

fb045f8

…plicitly supporting banner

matthewlane force-pushed the multiformat-requests branch from 5409303 to fb045f8 Compare January 22, 2018 23:13

ghost assigned matthewlane Jan 22, 2018

ghost added the in progress label Jan 22, 2018

matthewlane removed their assignment Jan 22, 2018

jaiminpanchal27 approved these changes Jan 23, 2018

View reviewed changes

jaiminpanchal27 mentioned this pull request Jan 23, 2018

Add Yieldlab adapter #1967

Merged

1 task

mkendall07 approved these changes Jan 23, 2018

View reviewed changes

mkendall07 merged commit 24033ff into master Jan 23, 2018

ghost removed the in progress label Jan 23, 2018

mkendall07 deleted the multiformat-requests branch January 23, 2018 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support multiple media formats within a single ad unit #1991

Support multiple media formats within a single ad unit #1991

matthewlane commented Dec 21, 2017 •

edited

Loading

mkendall07 left a comment

mkendall07 commented Jan 5, 2018

mkendall07 commented Jan 8, 2018

matthewlane commented Jan 9, 2018

mkendall07 Jan 22, 2018

jaiminpanchal27 Jan 22, 2018

matthewlane Jan 22, 2018

matthewlane Jan 22, 2018

jaiminpanchal27 left a comment

Support multiple media formats within a single ad unit #1991

Support multiple media formats within a single ad unit #1991

Conversation

matthewlane commented Dec 21, 2017 • edited Loading

Type of change

Description of change

mkendall07 left a comment

Choose a reason for hiding this comment

mkendall07 commented Jan 5, 2018

mkendall07 commented Jan 8, 2018

matthewlane commented Jan 9, 2018

mkendall07 Jan 22, 2018

Choose a reason for hiding this comment

jaiminpanchal27 Jan 22, 2018

Choose a reason for hiding this comment

matthewlane Jan 22, 2018

Choose a reason for hiding this comment

matthewlane Jan 22, 2018

Choose a reason for hiding this comment

jaiminpanchal27 left a comment

Choose a reason for hiding this comment

matthewlane commented Dec 21, 2017 •

edited

Loading