Add multiformat docs: developers, ad ops, example code#561
Merged
rmloveland merged 51 commits intomasterfrom Jan 29, 2018
Merged
Add multiformat docs: developers, ad ops, example code#561rmloveland merged 51 commits intomasterfrom
rmloveland merged 51 commits intomasterfrom
Conversation
added 17 commits
January 18, 2018 15:50
Because these are basically the same as the banner/native instructions, I've filled them in as the "diffs" between our existing, published, vetted instructions.
Contributor
Author
|
Hey @mjacobsonny would appreciate your review when you get a chance! I think these will provide a decent MVP to coincide with the release that we can improve upon going forward. |
This was referenced Jan 23, 2018
mjacobsonny
suggested changes
Jan 24, 2018
| * TOC | ||
| {: toc } | ||
|
|
||
| ## Step 1. Add an Order |
Contributor
There was a problem hiding this comment.
I think we should have step 1 be "Add an ad unit", where we should note that the ad unit's sizes must be configured properly to support the combination of formats that will be permitted.
Contributor
Author
There was a problem hiding this comment.
Added in 96357cb using pretty much this language.
| * TOC | ||
| {: toc } | ||
|
|
||
| ## Step 1. Add an Order |
Contributor
There was a problem hiding this comment.
We also don't reference anything about the creation of a custom Prebid Native Format or Prebid Native Style for multi-format ad units that support Native.
Contributor
Author
There was a problem hiding this comment.
Also added in 96357cb using pretty much this language.
| @@ -0,0 +1,73 @@ | |||
| --- | |||
| layout: page | |||
| title: Setting up Prebid Multiformat in DFP | |||
| --- | ||
| layout: page | ||
| title: Setting up Prebid Multiformat in DFP | ||
| head_title: Setting up Prebid Multiformat in DFP |
Contributor
Author
There was a problem hiding this comment.
This and all the other multi-format changes are handled in one fell swoop in 8a67f2e
(Including in the text of the documentation, in the Jekyll metadata / configs, and in all the file names, e.g., multiformat-example.html -> multi-format-example.html)
| layout: page | ||
| title: Setting up Prebid Multiformat in DFP | ||
| head_title: Setting up Prebid Multiformat in DFP | ||
| description: Setting up Prebid Multiformat in DFP |
dev-docs/show-multiformat-ads.md
Outdated
| At a high level, Prebid.js supports multiformat ads as follows: | ||
|
|
||
| 1. For each multiformat ad unit, make a list of each of the media types defined for that ad unit | ||
| 2. Loop through each of the bidders specified on the ad unit, checking it against the list of media types to see if the bidder is eligible to bid |
Contributor
There was a problem hiding this comment.
"Each bidder specified on a given ad unit will be eligible to bid if the bidder supports at least one of the media types specified via adUnit.mediaTypes."
dev-docs/show-multiformat-ads.md
Outdated
|
|
||
| ### 1. Add multiformat ad units | ||
|
|
||
| In the ad unit below, we define the requirements for each media type that could serve: banner, native, or video. |
Contributor
There was a problem hiding this comment.
"The ad unit below supports the banner, native and video media types"
examples/multiformat_example.html
Outdated
| [300, 600], | ||
| [300, 50] | ||
| ] | ||
| } |
Contributor
There was a problem hiding this comment.
Missing comma seems to break the page.
examples/multiformat_example.html
Outdated
|
|
||
| pbjs.que.push(function() { | ||
| var adUnits = [{ | ||
| code: '/19968336/prebid_native_example_1', |
Contributor
There was a problem hiding this comment.
Is this the correct ad unit code?
examples/multiformat_example.html
Outdated
| @@ -0,0 +1,214 @@ | |||
| <!-- -*- Mode: Web; -*- --> | |||
Contributor
There was a problem hiding this comment.
Why aren't we using the code from http://mlane.devnxs.net/multiformat/?
Contributor
Author
There was a problem hiding this comment.
This was added in error as a placeholder. Updated in 639aae0 to use Lane's example code
Note: There are 2 modifications from Lane's example code to (1) use Prebid v1.2.0 from the CDN and (2) s/appnexusAst/appnexus/g
* Add native aspect ratios to AppNexus adapter docs Also did some general cleanup and formatting while I was in there. * Update field defs a bit; add OpenRTB native link * Remove OpenRTB note based on feedback * Add banner, video, and native sections * WIP native updates across several pages * Tweak language in AN bidder doc links * Edit down to a single native example; s/Ast//g * Update native example code; s/Ast//g * Show `mediaTypes.native.image.sizes` in examples In addition to updating the basic examples to use sizes for images and icons, we add a section to both the API reference and the 'Show Native Ads' page that lists both ways to define sizes for image-like assets. Since the content is the same, it's in a shared file sourced using the Liquid `include` keyword. * Fix code formatting issue with included file * `adUnit.sizes` is ignored on native ad units * Remove `adUnit.sizes` since banner sizes are used * Remove redundant `adUnit.sizes` from native ad * Use correct syntax for native "image-type" ad
* Add multiformat ad unit information * Update default targeting keys * Update based on review feedback * Change key to hb_format * Add note about including banner media type if supported
* update tag samples with multiformat syntax * reverting part of change on show-native-ads.md
added 4 commits
January 25, 2018 17:13
- Use slightly different language/notation - Add screenshots
mjacobsonny
reviewed
Jan 26, 2018
|
|
||
| Decide what combination of formats will be permitted on the ad unit. This will determine what sizes you allow to serve. The ad unit's sizes must be configured properly to support the combination of formats that will be permitted. | ||
|
|
||
| If your ad unit will support native ads, you must create a custom **Prebid Native Format** and **Prebid Native Style** as described in [Setting up Prebid Native in DFP][nativeAdSetup]. |
Contributor
There was a problem hiding this comment.
Let's say: "If your ad unit will support native ads, you may want to create a custom Prebid Native Format and at least one Prebid Native Style. Examples of each are given in..."
|
|
||
| Multi-format ad units which support native require at least two distinct sets of line items and creatives: | ||
|
|
||
| + One for [banners and outstream video][bannerAdSetup]. Banners and outstream videos will serve into a DFP banner creative. |
Contributor
There was a problem hiding this comment.
"One for [banners and / or outstream video][bannerAdSetup]..."
| Follow the instructions for creating line items and creatives in [Send all bids to the ad server][bannerAdSetup], with the following changes: | ||
|
|
||
| + Add key-value targeting for **'hb_format' is ('banner' OR 'video')** | ||
| + This will allow either banner or outstream video to serve |
Contributor
There was a problem hiding this comment.
"This will ensure that the appropriate ad server line item is activated for banner / outstream bids."
|  | ||
|
|
||
| + Make sure you're targeting the right sizes for the native ads you want to serve: | ||
| + Fixed-size native, where you specify the sizes |
Contributor
There was a problem hiding this comment.
"where you specify one or more absolute size"
dev-docs/bidder-adaptor.md
Outdated
| code: 'test-div', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [[300, 50]], // a mobile size |
Contributor
There was a problem hiding this comment.
[[320, 50]] is standard mobile banner
dev-docs/publisher-api-reference.md
Outdated
|
|
||
| {: .alert.alert-danger :} | ||
| Methods marked as deprecated will be removed in version 1.0 (scheduled for release Q4 2017). | ||
| Methods marked as deprecated will be removed in version 1.0 (scheduled for release Q4 2017). |
Contributor
There was a problem hiding this comment.
We can say "Methods marked as deprecated were removed in version 1.0" and can link to the release docs.
dev-docs/show-multi-format-ads.md
Outdated
|
|
||
| At a high level, Prebid.js supports multi-format ads as follows: | ||
|
|
||
| 1. Ad ad unit may define a [`mediaTypes`]({{site.baseurl}}/dev-docs/publisher-api-reference.html#addAdUnits-MediaTypes) object to specify one or more supported formats and their respective properties. |
|
|
||
| Follow the instructions for creating line items and creatives in [Send all bids to the ad server][bannerAdSetup], with the following changes: | ||
|
|
||
| + Add key-value targeting for **'hb_format' is ('banner' OR 'video')** |
Contributor
There was a problem hiding this comment.
Should we note that hb_format_[BIDDER_CODE] would need to be specified for bidder-specific line items?
Contributor
Author
There was a problem hiding this comment.
Yes! Added the following note in 7649b51:
For bidder-specific line items, specify
hb_format_{BIDDER_CODE}, e.g.,hb_format_appnexus
dev-docs/show-multi-format-ads.md
Outdated
|
|
||
| ## Working Examples | ||
|
|
||
| + [Multi-Format Example]({{site.baseurl}}/dev-docs/examples/multi-format-example.html) |
Contributor
There was a problem hiding this comment.
Do we want this to reference the Prebid.org-hosted example?
Also, can we add the Prebid.org-hosted example to the /examples index page?
Contributor
Author
There was a problem hiding this comment.
Yes and yes! Made both of these updates in 5001f63
| @@ -0,0 +1,177 @@ | |||
| <!DOCTYPE html> | |||
Contributor
There was a problem hiding this comment.
I'm trying to run this test page (with a real hostname instead of 127.0.0.1) and am not seeing any ads rendering. Is this working?
Contributor
Author
There was a problem hiding this comment.
This seems to be fixed now. I had added the hb_format key, but had not deleted the (now-defunct) hb_mediatype key, and apparently the keys get ANDed together (?). At any rate it should work now.
(Also, add it to the `/examples` index page.)
mjacobsonny
reviewed
Jan 26, 2018
examples/multi_format_example.html
Outdated
| pbjs.que.push(function() { | ||
| var adUnits = [ | ||
| { | ||
| code: 'div-banner-outstream', |
Contributor
There was a problem hiding this comment.
The code on this adUnit doesn't correspond to the mediaTypes allowed in the adUnit.
| <body> | ||
| <h2>Prebid Multi-Format Testing</h2> | ||
|
|
||
| <h3>div-banner-native</h3> |
Contributor
There was a problem hiding this comment.
The heading here doesn't match with the div-id
| </div> | ||
| <div></div> | ||
|
|
||
| <h3>div-banner-outstream-native</h3> |
Contributor
There was a problem hiding this comment.
Whenever this adUnit attempts to render an outstream video bid, it doesn't seem to work properly for me, and the slot blanks.
| </script> | ||
| </div> | ||
| <div></div> | ||
| </body> |
Contributor
There was a problem hiding this comment.
I think we could use three examples:
div-banner-native
div-banner-outstream
div-banner-outstream-native
Contributor
Author
There was a problem hiding this comment.
Added a 'banner-outstream' example in 1556a3e
added 7 commits
January 26, 2018 18:21
I'm told this is connected somehow to the following issue, but ¯\_(ツ)_/¯ prebid/Prebid.js#1976
In order for outstream to work, we need a placement configured to work with VAST 3.0 since that is what the test outstream creative requires.
Also, added a note to the JSFiddle multi-format example page that the Fiddle works sporadically for outstream, so check out the Prebid.org-hosted example (which works closer to 100% of the time)
rmloveland
added a commit
that referenced
this pull request
Jan 30, 2018
* WIP multiformat docs * Flesh out prerequisites/implementation of dev doc * Add multi-format docs to 'Docs by Format' * Add a quick example of *why* to do this * Outline steps on ad ops page * Clarify multi-format on 'Docs by format' page * Various dev doc fixups * Update JSFiddle, overview bullet points in example * Update multiformat fiddle * Key is now called `hb_format` * s/multi-format/multiformat/ * Use 'appnexus' bidder and Prebid.js v1 * s/multi-format/multiformat/ * Be clear that it's *outstream* video * Use title case * Update multiformat example link * Fill in multiformat ad ops instructions Because these are basically the same as the banner/native instructions, I've filled them in as the "diffs" between our existing, published, vetted instructions. * Add native aspect ratio info to AN adapter docs (#543) * Add native aspect ratios to AppNexus adapter docs Also did some general cleanup and formatting while I was in there. * Update field defs a bit; add OpenRTB native link * Remove OpenRTB note based on feedback * Add banner, video, and native sections * WIP native updates across several pages * Tweak language in AN bidder doc links * Edit down to a single native example; s/Ast//g * Update native example code; s/Ast//g * Show `mediaTypes.native.image.sizes` in examples In addition to updating the basic examples to use sizes for images and icons, we add a section to both the API reference and the 'Show Native Ads' page that lists both ways to define sizes for image-like assets. Since the content is the same, it's in a shared file sourced using the Liquid `include` keyword. * Fix code formatting issue with included file * `adUnit.sizes` is ignored on native ad units * Remove `adUnit.sizes` since banner sizes are used * Remove redundant `adUnit.sizes` from native ad * Use correct syntax for native "image-type" ad * Add multiformat ad unit information (#541) * Add multiformat ad unit information * Update default targeting keys * Update based on review feedback * Change key to hb_format * Add note about including banner media type if supported * update tag samples with multiformat syntax (#528) * update tag samples with multiformat syntax * reverting part of change on show-native-ads.md * s/multiformat/multi-format/g * We don't need an order per demand partner * Remove ambiguous comment on fluid vs. fixed native * Update multi-format language in dev setup intro * Update multi-format description based on feedback * Update 'How it works' based on feedback * Update ad unit language based on feedback * Fix Prebid.org-hosted multiformat example Somehow a native example was erroneously added -- probably as a placeholder. It has been replaced with a slightly modified version [*] of the multi-format example kindly provided by @matthewlane. [*] It was modified to (1) use Prebid.js v1.2 from the CDN and (2) to use the 'appnexus' rather than the old AST adapter * Update JSFiddle in multiformat example To address the following points: 1. Removing mention of the internal dev URL as mentioned by Jacobson 2. Making the code the same as that of prebid.org/examples/multi_format_example.html * Add ad unit creation step with sizing/native info * Clarify line item setup language * Update k-v targeting instructions per feedback - Use slightly different language/notation - Add screenshots * Check in screenshots of multi-format ad ops setup * Update native format language per feedback * Clarify that it's banner and/or outstream * Note bidder-specific line item targeting keys * Update targeting description per feedback * Update native size note, per feedback * Fix mobile size per feedback * Hide multi-format example from site's left nav * Belatedly add link to the 1.0 release announcement * Fix typo * Use Prebid.org-hosted multi-format example (Also, add it to the `/examples` index page.) * s/div-banner-outstream/div-banner-native/g * Add a third example: 'banner-outstream' * Update examples to set `cache.url` to `false` I'm told this is connected somehow to the following issue, but ¯\_(ツ)_/¯ prebid/Prebid.js#1976 * Update placement IDs in Prebid.org-hosted example In order for outstream to work, we need a placement configured to work with VAST 3.0 since that is what the test outstream creative requires. * Update JSFiddle to use updated placement IDs * Get banner/outstream examples working: use 300x250 Also, added a note to the JSFiddle multi-format example page that the Fiddle works sporadically for outstream, so check out the Prebid.org-hosted example (which works closer to 100% of the time) * Fix broken formatting on JSFiddle example page
rmloveland
added a commit
that referenced
this pull request
Feb 8, 2018
* Add first draft of ad unit reference * Add examples to ad unit reference * Add native aspect ratio info to AN adapter docs (#543) * Add native aspect ratios to AppNexus adapter docs Also did some general cleanup and formatting while I was in there. * Update field defs a bit; add OpenRTB native link * Remove OpenRTB note based on feedback * Add banner, video, and native sections * WIP native updates across several pages * Tweak language in AN bidder doc links * Edit down to a single native example; s/Ast//g * Update native example code; s/Ast//g * Show `mediaTypes.native.image.sizes` in examples In addition to updating the basic examples to use sizes for images and icons, we add a section to both the API reference and the 'Show Native Ads' page that lists both ways to define sizes for image-like assets. Since the content is the same, it's in a shared file sourced using the Liquid `include` keyword. * Fix code formatting issue with included file * `adUnit.sizes` is ignored on native ad units * Remove `adUnit.sizes` since banner sizes are used * Remove redundant `adUnit.sizes` from native ad * Use correct syntax for native "image-type" ad * Add multiformat ad unit information (#541) * Add multiformat ad unit information * Update default targeting keys * Update based on review feedback * Change key to hb_format * Add note about including banner media type if supported * update tag samples with multiformat syntax (#528) * update tag samples with multiformat syntax * reverting part of change on show-native-ads.md * Re-add trailing spaces to info boxes (#573) * Add note about non-1.0 adapters (#570) * Add note about non-1.0 adapters * Add trailing spaces back * suppord prebid.js 1.0 Colossusssp (#560) * Update vertamedia.md (#567) Update for Vertamedia Adapter description Add examples * Add multiformat docs: developers, ad ops, example code (#561) * WIP multiformat docs * Flesh out prerequisites/implementation of dev doc * Add multi-format docs to 'Docs by Format' * Add a quick example of *why* to do this * Outline steps on ad ops page * Clarify multi-format on 'Docs by format' page * Various dev doc fixups * Update JSFiddle, overview bullet points in example * Update multiformat fiddle * Key is now called `hb_format` * s/multi-format/multiformat/ * Use 'appnexus' bidder and Prebid.js v1 * s/multi-format/multiformat/ * Be clear that it's *outstream* video * Use title case * Update multiformat example link * Fill in multiformat ad ops instructions Because these are basically the same as the banner/native instructions, I've filled them in as the "diffs" between our existing, published, vetted instructions. * Add native aspect ratio info to AN adapter docs (#543) * Add native aspect ratios to AppNexus adapter docs Also did some general cleanup and formatting while I was in there. * Update field defs a bit; add OpenRTB native link * Remove OpenRTB note based on feedback * Add banner, video, and native sections * WIP native updates across several pages * Tweak language in AN bidder doc links * Edit down to a single native example; s/Ast//g * Update native example code; s/Ast//g * Show `mediaTypes.native.image.sizes` in examples In addition to updating the basic examples to use sizes for images and icons, we add a section to both the API reference and the 'Show Native Ads' page that lists both ways to define sizes for image-like assets. Since the content is the same, it's in a shared file sourced using the Liquid `include` keyword. * Fix code formatting issue with included file * `adUnit.sizes` is ignored on native ad units * Remove `adUnit.sizes` since banner sizes are used * Remove redundant `adUnit.sizes` from native ad * Use correct syntax for native "image-type" ad * Add multiformat ad unit information (#541) * Add multiformat ad unit information * Update default targeting keys * Update based on review feedback * Change key to hb_format * Add note about including banner media type if supported * update tag samples with multiformat syntax (#528) * update tag samples with multiformat syntax * reverting part of change on show-native-ads.md * s/multiformat/multi-format/g * We don't need an order per demand partner * Remove ambiguous comment on fluid vs. fixed native * Update multi-format language in dev setup intro * Update multi-format description based on feedback * Update 'How it works' based on feedback * Update ad unit language based on feedback * Fix Prebid.org-hosted multiformat example Somehow a native example was erroneously added -- probably as a placeholder. It has been replaced with a slightly modified version [*] of the multi-format example kindly provided by @matthewlane. [*] It was modified to (1) use Prebid.js v1.2 from the CDN and (2) to use the 'appnexus' rather than the old AST adapter * Update JSFiddle in multiformat example To address the following points: 1. Removing mention of the internal dev URL as mentioned by Jacobson 2. Making the code the same as that of prebid.org/examples/multi_format_example.html * Add ad unit creation step with sizing/native info * Clarify line item setup language * Update k-v targeting instructions per feedback - Use slightly different language/notation - Add screenshots * Check in screenshots of multi-format ad ops setup * Update native format language per feedback * Clarify that it's banner and/or outstream * Note bidder-specific line item targeting keys * Update targeting description per feedback * Update native size note, per feedback * Fix mobile size per feedback * Hide multi-format example from site's left nav * Belatedly add link to the 1.0 release announcement * Fix typo * Use Prebid.org-hosted multi-format example (Also, add it to the `/examples` index page.) * s/div-banner-outstream/div-banner-native/g * Add a third example: 'banner-outstream' * Update examples to set `cache.url` to `false` I'm told this is connected somehow to the following issue, but ¯\_(ツ)_/¯ prebid/Prebid.js#1976 * Update placement IDs in Prebid.org-hosted example In order for outstream to work, we need a placement configured to work with VAST 3.0 since that is what the test outstream creative requires. * Update JSFiddle to use updated placement IDs * Get banner/outstream examples working: use 300x250 Also, added a note to the JSFiddle multi-format example page that the Fiddle works sporadically for outstream, so check out the Prebid.org-hosted example (which works closer to 100% of the time) * Fix broken formatting on JSFiddle example page * update prebid version download page 1.2.0 & 0.34.2 (#580) * update prebid version * review update * Provide a high-level description of an ad unit * Remove monospacing from section headers Also, remove some unnecessary nesting from a few headers * Fix up anchor links to use object properties * Add multi-format example * Update description of `sizes` per feedback * Update `bids` description based on feedback * Update `mediaTypes` description * Edit scope description for `{banner,native,video}` * There is no `mediaTypes.native.sizes` * Add link to docs on pre-defined native types * Update `native.title` description per feedback * Mark all native assets as optional * Update `native.body` description * `sponsoredBy` is an object * Update `native.image` description * Remove Prebid Native validation warning This already exists elsewhere, on the 'Show Native Ads' page. * Native ad validation checks for landing page URL * `sizes` and `aspect_ratios` are both allowed For example, see: https://github.com/prebid/Prebid.js/blob/master/test/spec/unit/core/adapterManager_spec.js#L836 * Update `native.title.len` description * Mark `context` as optional * Mark `required` properties as optional This seems to be confirmed by line 105 of `src/native.js` (as of this writing): ``` const requiredAssets = Object.keys(requestedAssets).filter( key => requestedAssets[key].required ); ``` * Media.net bidder added (#549) * vi bid adapter docs (#537) * vi bid adapter docs * VI bid adapter docs - added header * VI adapter docs - renamed file and changed according to example * Add : docs for NasmediaAdmixer Adapter (#536) * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Added Inskin bid adapter docs (#548) * RockYou Adapter: Added docs for the RockYou Bidder Adapter (#551) * Prebid v1 smart (#565) * Fix domain sample * Add HTTPS sample for domain parameter * Add HTTPS sample for domain parameter * Add Smart AdServer in the index and download list * Add currency parameter documentation * Revert "Merge remote-tracking branch 'refs/remotes/prebid/master'" This reverts commit 099edc2, reversing changes made to 07ce9fd. * Update documentation Specify "target" parameter development status * Adding documentation for bidfloor parameter. * Update our adapter documentation * Adding Optimera doc. (#569) * PubMatic 1.0 Adapter Updates (#530) * PubMatic 1.0 Adapter Updates * Remove $$PREBID_GLOBAL$$ reference * Add prebid_1_0_supported flag * Gjirafa bidder params documentation (#483) * Gjirafa bidder params documentation * Add Prebid 1.0 supported line * Change prebid support line * Add `body.len` to table with description * Update `mimes`, `protocols`, `playbackmethods` * s/sizes/playerSize/g for video ads * Pass `placementId` as a string in examples
rmloveland
added a commit
that referenced
this pull request
Feb 14, 2018
* WIP multiformat docs * Flesh out prerequisites/implementation of dev doc * Add multi-format docs to 'Docs by Format' * Add a quick example of *why* to do this * Outline steps on ad ops page * Clarify multi-format on 'Docs by format' page * Various dev doc fixups * Update JSFiddle, overview bullet points in example * Update multiformat fiddle * Key is now called `hb_format` * s/multi-format/multiformat/ * Use 'appnexus' bidder and Prebid.js v1 * s/multi-format/multiformat/ * Be clear that it's *outstream* video * Use title case * Update multiformat example link * Fill in multiformat ad ops instructions Because these are basically the same as the banner/native instructions, I've filled them in as the "diffs" between our existing, published, vetted instructions. * Add native aspect ratio info to AN adapter docs (#543) * Add native aspect ratios to AppNexus adapter docs Also did some general cleanup and formatting while I was in there. * Update field defs a bit; add OpenRTB native link * Remove OpenRTB note based on feedback * Add banner, video, and native sections * WIP native updates across several pages * Tweak language in AN bidder doc links * Edit down to a single native example; s/Ast//g * Update native example code; s/Ast//g * Show `mediaTypes.native.image.sizes` in examples In addition to updating the basic examples to use sizes for images and icons, we add a section to both the API reference and the 'Show Native Ads' page that lists both ways to define sizes for image-like assets. Since the content is the same, it's in a shared file sourced using the Liquid `include` keyword. * Fix code formatting issue with included file * `adUnit.sizes` is ignored on native ad units * Remove `adUnit.sizes` since banner sizes are used * Remove redundant `adUnit.sizes` from native ad * Use correct syntax for native "image-type" ad * Add multiformat ad unit information (#541) * Add multiformat ad unit information * Update default targeting keys * Update based on review feedback * Change key to hb_format * Add note about including banner media type if supported * update tag samples with multiformat syntax (#528) * update tag samples with multiformat syntax * reverting part of change on show-native-ads.md * s/multiformat/multi-format/g * We don't need an order per demand partner * Remove ambiguous comment on fluid vs. fixed native * Update multi-format language in dev setup intro * Update multi-format description based on feedback * Update 'How it works' based on feedback * Update ad unit language based on feedback * Fix Prebid.org-hosted multiformat example Somehow a native example was erroneously added -- probably as a placeholder. It has been replaced with a slightly modified version [*] of the multi-format example kindly provided by @matthewlane. [*] It was modified to (1) use Prebid.js v1.2 from the CDN and (2) to use the 'appnexus' rather than the old AST adapter * Update JSFiddle in multiformat example To address the following points: 1. Removing mention of the internal dev URL as mentioned by Jacobson 2. Making the code the same as that of prebid.org/examples/multi_format_example.html * Add ad unit creation step with sizing/native info * Clarify line item setup language * Update k-v targeting instructions per feedback - Use slightly different language/notation - Add screenshots * Check in screenshots of multi-format ad ops setup * Update native format language per feedback * Clarify that it's banner and/or outstream * Note bidder-specific line item targeting keys * Update targeting description per feedback * Update native size note, per feedback * Fix mobile size per feedback * Hide multi-format example from site's left nav * Belatedly add link to the 1.0 release announcement * Fix typo * Use Prebid.org-hosted multi-format example (Also, add it to the `/examples` index page.) * s/div-banner-outstream/div-banner-native/g * Add a third example: 'banner-outstream' * Update examples to set `cache.url` to `false` I'm told this is connected somehow to the following issue, but ¯\_(ツ)_/¯ prebid/Prebid.js#1976 * Update placement IDs in Prebid.org-hosted example In order for outstream to work, we need a placement configured to work with VAST 3.0 since that is what the test outstream creative requires. * Update JSFiddle to use updated placement IDs * Get banner/outstream examples working: use 300x250 Also, added a note to the JSFiddle multi-format example page that the Fiddle works sporadically for outstream, so check out the Prebid.org-hosted example (which works closer to 100% of the time) * Fix broken formatting on JSFiddle example page
rmloveland
added a commit
that referenced
this pull request
Feb 14, 2018
* Add first draft of ad unit reference * Add examples to ad unit reference * Add native aspect ratio info to AN adapter docs (#543) * Add native aspect ratios to AppNexus adapter docs Also did some general cleanup and formatting while I was in there. * Update field defs a bit; add OpenRTB native link * Remove OpenRTB note based on feedback * Add banner, video, and native sections * WIP native updates across several pages * Tweak language in AN bidder doc links * Edit down to a single native example; s/Ast//g * Update native example code; s/Ast//g * Show `mediaTypes.native.image.sizes` in examples In addition to updating the basic examples to use sizes for images and icons, we add a section to both the API reference and the 'Show Native Ads' page that lists both ways to define sizes for image-like assets. Since the content is the same, it's in a shared file sourced using the Liquid `include` keyword. * Fix code formatting issue with included file * `adUnit.sizes` is ignored on native ad units * Remove `adUnit.sizes` since banner sizes are used * Remove redundant `adUnit.sizes` from native ad * Use correct syntax for native "image-type" ad * Add multiformat ad unit information (#541) * Add multiformat ad unit information * Update default targeting keys * Update based on review feedback * Change key to hb_format * Add note about including banner media type if supported * update tag samples with multiformat syntax (#528) * update tag samples with multiformat syntax * reverting part of change on show-native-ads.md * Re-add trailing spaces to info boxes (#573) * Add note about non-1.0 adapters (#570) * Add note about non-1.0 adapters * Add trailing spaces back * suppord prebid.js 1.0 Colossusssp (#560) * Update vertamedia.md (#567) Update for Vertamedia Adapter description Add examples * Add multiformat docs: developers, ad ops, example code (#561) * WIP multiformat docs * Flesh out prerequisites/implementation of dev doc * Add multi-format docs to 'Docs by Format' * Add a quick example of *why* to do this * Outline steps on ad ops page * Clarify multi-format on 'Docs by format' page * Various dev doc fixups * Update JSFiddle, overview bullet points in example * Update multiformat fiddle * Key is now called `hb_format` * s/multi-format/multiformat/ * Use 'appnexus' bidder and Prebid.js v1 * s/multi-format/multiformat/ * Be clear that it's *outstream* video * Use title case * Update multiformat example link * Fill in multiformat ad ops instructions Because these are basically the same as the banner/native instructions, I've filled them in as the "diffs" between our existing, published, vetted instructions. * Add native aspect ratio info to AN adapter docs (#543) * Add native aspect ratios to AppNexus adapter docs Also did some general cleanup and formatting while I was in there. * Update field defs a bit; add OpenRTB native link * Remove OpenRTB note based on feedback * Add banner, video, and native sections * WIP native updates across several pages * Tweak language in AN bidder doc links * Edit down to a single native example; s/Ast//g * Update native example code; s/Ast//g * Show `mediaTypes.native.image.sizes` in examples In addition to updating the basic examples to use sizes for images and icons, we add a section to both the API reference and the 'Show Native Ads' page that lists both ways to define sizes for image-like assets. Since the content is the same, it's in a shared file sourced using the Liquid `include` keyword. * Fix code formatting issue with included file * `adUnit.sizes` is ignored on native ad units * Remove `adUnit.sizes` since banner sizes are used * Remove redundant `adUnit.sizes` from native ad * Use correct syntax for native "image-type" ad * Add multiformat ad unit information (#541) * Add multiformat ad unit information * Update default targeting keys * Update based on review feedback * Change key to hb_format * Add note about including banner media type if supported * update tag samples with multiformat syntax (#528) * update tag samples with multiformat syntax * reverting part of change on show-native-ads.md * s/multiformat/multi-format/g * We don't need an order per demand partner * Remove ambiguous comment on fluid vs. fixed native * Update multi-format language in dev setup intro * Update multi-format description based on feedback * Update 'How it works' based on feedback * Update ad unit language based on feedback * Fix Prebid.org-hosted multiformat example Somehow a native example was erroneously added -- probably as a placeholder. It has been replaced with a slightly modified version [*] of the multi-format example kindly provided by @matthewlane. [*] It was modified to (1) use Prebid.js v1.2 from the CDN and (2) to use the 'appnexus' rather than the old AST adapter * Update JSFiddle in multiformat example To address the following points: 1. Removing mention of the internal dev URL as mentioned by Jacobson 2. Making the code the same as that of prebid.org/examples/multi_format_example.html * Add ad unit creation step with sizing/native info * Clarify line item setup language * Update k-v targeting instructions per feedback - Use slightly different language/notation - Add screenshots * Check in screenshots of multi-format ad ops setup * Update native format language per feedback * Clarify that it's banner and/or outstream * Note bidder-specific line item targeting keys * Update targeting description per feedback * Update native size note, per feedback * Fix mobile size per feedback * Hide multi-format example from site's left nav * Belatedly add link to the 1.0 release announcement * Fix typo * Use Prebid.org-hosted multi-format example (Also, add it to the `/examples` index page.) * s/div-banner-outstream/div-banner-native/g * Add a third example: 'banner-outstream' * Update examples to set `cache.url` to `false` I'm told this is connected somehow to the following issue, but ¯\_(ツ)_/¯ prebid/Prebid.js#1976 * Update placement IDs in Prebid.org-hosted example In order for outstream to work, we need a placement configured to work with VAST 3.0 since that is what the test outstream creative requires. * Update JSFiddle to use updated placement IDs * Get banner/outstream examples working: use 300x250 Also, added a note to the JSFiddle multi-format example page that the Fiddle works sporadically for outstream, so check out the Prebid.org-hosted example (which works closer to 100% of the time) * Fix broken formatting on JSFiddle example page * update prebid version download page 1.2.0 & 0.34.2 (#580) * update prebid version * review update * Provide a high-level description of an ad unit * Remove monospacing from section headers Also, remove some unnecessary nesting from a few headers * Fix up anchor links to use object properties * Add multi-format example * Update description of `sizes` per feedback * Update `bids` description based on feedback * Update `mediaTypes` description * Edit scope description for `{banner,native,video}` * There is no `mediaTypes.native.sizes` * Add link to docs on pre-defined native types * Update `native.title` description per feedback * Mark all native assets as optional * Update `native.body` description * `sponsoredBy` is an object * Update `native.image` description * Remove Prebid Native validation warning This already exists elsewhere, on the 'Show Native Ads' page. * Native ad validation checks for landing page URL * `sizes` and `aspect_ratios` are both allowed For example, see: https://github.com/prebid/Prebid.js/blob/master/test/spec/unit/core/adapterManager_spec.js#L836 * Update `native.title.len` description * Mark `context` as optional * Mark `required` properties as optional This seems to be confirmed by line 105 of `src/native.js` (as of this writing): ``` const requiredAssets = Object.keys(requestedAssets).filter( key => requestedAssets[key].required ); ``` * Media.net bidder added (#549) * vi bid adapter docs (#537) * vi bid adapter docs * VI bid adapter docs - added header * VI adapter docs - renamed file and changed according to example * Add : docs for NasmediaAdmixer Adapter (#536) * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Added Inskin bid adapter docs (#548) * RockYou Adapter: Added docs for the RockYou Bidder Adapter (#551) * Prebid v1 smart (#565) * Fix domain sample * Add HTTPS sample for domain parameter * Add HTTPS sample for domain parameter * Add Smart AdServer in the index and download list * Add currency parameter documentation * Revert "Merge remote-tracking branch 'refs/remotes/prebid/master'" This reverts commit 099edc2, reversing changes made to 07ce9fd. * Update documentation Specify "target" parameter development status * Adding documentation for bidfloor parameter. * Update our adapter documentation * Adding Optimera doc. (#569) * PubMatic 1.0 Adapter Updates (#530) * PubMatic 1.0 Adapter Updates * Remove $$PREBID_GLOBAL$$ reference * Add prebid_1_0_supported flag * Gjirafa bidder params documentation (#483) * Gjirafa bidder params documentation * Add Prebid 1.0 supported line * Change prebid support line * Add `body.len` to table with description * Update `mimes`, `protocols`, `playbackmethods` * s/sizes/playerSize/g for video ads * Pass `placementId` as a string in examples
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR has:
multiformat ad ops setup (which is basically presented here as a "diff" from the existing instructions for (1) speed, and (2) not wanting to replicate tons of existing, already-vetted content
multiformat developer setup
multiformat examples (which are based on Lane's example code but will need to be checked once the CDN is updated with the 1.2 release)