Add native aspect ratio info to AN adapter docs #543

rmloveland · 2018-01-10T20:59:21Z

No description provided.

Also did some general cleanup and formatting while I was in there.

rmloveland · 2018-01-10T21:04:01Z

Hey @matthewlane few questions/comments on this PR:

Some of this diff is formatting stuff, sorry! Please ignore
Do you think the language "this implementation follows the OpenRTB native spec" is too strong a claim?
Other than setting up your ad unit set up correctly, is there any additional work needed? (e.g., ad ops, etc.)
Is there anything missing that should be here?

matthewlane

LGTM. For the questions,

I don't think the language around following OpenRTB is too strong of a claim, but would defer to @mjacobsonny 's opinion on that to be sure
No additional setup afaik and don't think anything else is missing!

mjacobsonny · 2018-01-10T22:56:32Z

dev-docs/bidders/appnexus.md

+
+<a name="appnexus-aspect-ratios" />
+
+#### Specify aspect ratios for native images and icons


Is native aspect ratio support documented somewhere else that is not specific to the appnexus adapter?

I think this is confusing, because I don't see any mention of "absolute sizes" for native images/ icons which "appnexus" can also support.

mjacobsonny · 2018-01-10T22:57:22Z

dev-docs/bidders/appnexus.md

+| `min_width`    | Optional | Integer | The required minimum width of the image asset in pixels. |
+
+{: .alert.alert-info :}
+This implementation follows the [OpenRTB Native 1.2 specification](https://www.iab.com/wp-content/uploads/2017/04/OpenRTB-Native-Ads-Specification-Draft_1.2_2017-04.pdf)


I would remove this note.

rmloveland · 2018-01-12T16:25:34Z

@mjacobsonny would appreciate another review of this when you have cycles.

Scope has increased to:

Update AppNexus bidder doc with links to various banner, native, video docs
Update 'Publisher API reference' so that native examples use aspect ratios (and note it needs bidder support)
Update 'Publisher API reference' so that all mentions of AST adapter become just "AppNexus"
Update 'Show Native Ads' with updated "image type" syntax, including aspect ratios (noting again that it needs bidder support)
Update 'Show Native Ads' so all mentions/usage of AST adapter become the 1.0 "AppNexus" adapter

mjacobsonny · 2018-01-16T15:08:00Z

dev-docs/publisher-api-reference.md

+                    /* If your bidder supports it, you can specify
+                       aspect ratios for image and icon native assets */
+
+                    aspect_ratios: [{


I think our basic native examples should show "mediaTypes.native.image.sizes", as this will be the most widely supported by bidder adapters.

Separately, we should document the following structures as the two possible methods for defining sizes for image-like assets:

mediaTypes.native.image.sizes

mediaTypes.native.image.aspect_ratios

@mjacobsonny thanks for the review - I think this comment (and the below) are addressed by my changes in 635016e.

Mind taking another look?

mjacobsonny · 2018-01-16T15:08:48Z

dev-docs/show-native-ads.md

@@ -166,19 +166,35 @@ And the following optional fields:
 + icon
 + cta

-A native `image` ad unit can be set up in the manner below:
+A native "image-type" ad unit can be set up as shown in the following example.


See note above about documenting "mediaTypes.native.image.sizes" and "mediaTypes.native.image.aspect_ratios"

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.

mjacobsonny · 2018-01-22T15:30:09Z

_includes/dev-docs/native-image-asset-sizes.md

+
+1. Using `mediaTypes.native.image.sizes` (or `mediaTypes.native.icon.sizes` for icons):
+
+    ```javascript


When I run this locally, I'm seeing this appear as in-line code as opposed to a code block with syntax highlighting.

Should be fixed by a921d39

mjacobsonny · 2018-01-22T15:30:20Z

_includes/dev-docs/native-image-asset-sizes.md

+
+2. Using `mediaTypes.native.image.aspect_ratios` (or `mediaTypes.native.icon.aspect_ratios` for icons):
+
+    ```javascript


Same as above.

Should be fixed by a921d39

mjacobsonny · 2018-01-22T15:36:05Z

dev-docs/bidders/appnexus.md

@@ -43,4 +55,33 @@ var adUnits = [{
 }]
 {% endhighlight %}

-(Sizes set in `adUnit` object will also apply to the AppNexus bid requests.)
+{: .alert.alert-info :}
+Sizes set in the `adUnit` object will also apply to the AppNexus bid requests.


Why do we need to break out these separate sections? For each media type below, it seems like we're just redirecting back to the standard documentation.

Why do we need to break out these separate sections?

It's intended as an enhancement. It's meant to provide another way for users to discover the features supported by the appnexus adapter beyond the section Bidders with video and native demand. For example, you can scan the mini-TOC and see that we support native ads.

For each media type below, it seems like we're just redirecting back to the standard documentation.

Yes. The idea is that once you see in the mini-TOC that we support native, from there, you can jump to the native ads documentation, knowing that the AN adapter supports the features described there (rather than us having a miniature "native" section of content here with info that is redundant with 'Show Native Ads').

Once the multiformat feature/docs are out, I would like to add another little section to this mini-TOC that points the user to the multi-format docs.

mjacobsonny · 2018-01-22T15:37:28Z

dev-docs/publisher-api-reference.md

-                required: true
+    pbjs.addAdUnits({
+        code: slot.code,
+        sizes: slot.size,


adUnit.sizes should be ignored on native ad units.

Oops - thanks. Fixed in 081cbee

mjacobsonny · 2018-01-22T15:38:00Z

dev-docs/publisher-api-reference.md

 ```

+{% include dev-docs/native-image-asset-sizes.md %}


Formatting issue, as described above.

Should be fixed by a921d39

mjacobsonny · 2018-01-22T15:42:14Z

dev-docs/publisher-api-reference.md

@@ -715,7 +719,7 @@ pbjs.addAdUnits({
            sizes: [[300, 250], [300, 600]]


looks like this adUnit has both adUnit.sizes as well as adUnit.mediaTypes.banner.sizes.

Thanks, addressed by cefb91e

mjacobsonny · 2018-01-22T15:44:03Z

dev-docs/show-native-ads.md

@@ -114,7 +114,8 @@ pbjs.addAdUnits({
    mediaTypes: {
        native: {
            image: {
-                required: true
+                required: true,
+                sizes: [150, 50]


looks like this adUnit has both adUnit.sizes as well as adUnit.mediaTypes.native.image.sizes and adUnit.mediaTypes.native.icon.sizes

http://www.nooooooooooooooo.com

OK, updated in fe4679c to remove adUnit.sizes - thanks!

mjacobsonny · 2018-01-22T15:45:01Z

dev-docs/show-native-ads.md

-A native `image` ad unit can be set up in the manner below:
-
-{% highlight js %}
+A native "image-type" ad unit can be set up as shown in the following example.


Are you sure that this is the correct way to set up a native "image-type" ad unit? This looks like standard native with just a single required asset.

http://www.nooooooooooooooo.com x 2

Was writing it out longhand by mistake. Fixed in b31cbb7 to use the shorthand.

* 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

@matthewlane

* 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

* 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

@matthewlane

* 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

@matthewlane

* 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

* 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

@matthewlane

* 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

@matthewlane

* 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

Rich Loveland added 2 commits January 10, 2018 15:37

Add native aspect ratios to AppNexus adapter docs

633ca6a

Also did some general cleanup and formatting while I was in there.

Update field defs a bit; add OpenRTB native link

19fa274

rmloveland requested a review from matthewlane January 10, 2018 20:59

matthewlane approved these changes Jan 10, 2018

View reviewed changes

mjacobsonny reviewed Jan 10, 2018

View reviewed changes

Rich Loveland added 6 commits January 11, 2018 10:51

Remove OpenRTB note based on feedback

1229a72

Add banner, video, and native sections

d976b46

WIP native updates across several pages

5b856a5

Tweak language in AN bidder doc links

7ab41d7

Edit down to a single native example; s/Ast//g

11f2427

Update native example code; s/Ast//g

9c977b1

mjacobsonny reviewed Jan 16, 2018

View reviewed changes

mjacobsonny reviewed Jan 22, 2018

View reviewed changes

Rich Loveland added 5 commits January 22, 2018 15:28

Fix code formatting issue with included file

a921d39

adUnit.sizes is ignored on native ad units

081cbee

Remove adUnit.sizes since banner sizes are used

cefb91e

Remove redundant adUnit.sizes from native ad

fe4679c

Use correct syntax for native "image-type" ad

b31cbb7

rmloveland merged commit 30ddadc into master Jan 24, 2018

rmloveland deleted the RAD-1813 branch January 24, 2018 01:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add native aspect ratio info to AN adapter docs #543

Add native aspect ratio info to AN adapter docs #543

rmloveland commented Jan 10, 2018

rmloveland commented Jan 10, 2018

matthewlane left a comment

mjacobsonny Jan 10, 2018

mjacobsonny Jan 10, 2018

rmloveland commented Jan 12, 2018

mjacobsonny Jan 16, 2018

rmloveland Jan 17, 2018

mjacobsonny Jan 16, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018

mjacobsonny Jan 22, 2018

rmloveland Jan 22, 2018


		<a name="appnexus-aspect-ratios" />

		#### Specify aspect ratios for native images and icons


		1. Using `mediaTypes.native.image.sizes` (or `mediaTypes.native.icon.sizes` for icons):

		```javascript


		2. Using `mediaTypes.native.image.aspect_ratios` (or `mediaTypes.native.icon.aspect_ratios` for icons):

		```javascript

		@@ -715,7 +719,7 @@ pbjs.addAdUnits({
		sizes: [[300, 250], [300, 600]]

Add native aspect ratio info to AN adapter docs #543

Add native aspect ratio info to AN adapter docs #543

Conversation

rmloveland commented Jan 10, 2018

rmloveland commented Jan 10, 2018

matthewlane left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmloveland commented Jan 12, 2018

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

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