Add a reference doc for the `adUnit` object #558

rmloveland · 2018-01-22T23:07:07Z

This addresses #555

rmloveland · 2018-01-22T23:09:03Z

Hey @mjacobsonny would appreciate a review on this. It's a first cut that can definitely be fleshed out more, but I think I've captured a fair number of the various properties, and at least it's better than what we have now. :-)

It doesn't mention multiformat yet so the PR stays modular, but can easily be updated with multiformat info once that content is live.

mjacobsonny

At the top, I think we should provide a high-level description of what an adUnit is.

The TOC looks a bit cluttered at the moment, but I don't necessarily have a better suggestion for how to fix it.

I don't think that the section headings should be monospaced, and I'm not sure whether I like that each section header gets smaller as the objects get more nested.

mjacobsonny · 2018-01-24T14:06:15Z

dev-docs/adunit-reference.md

+| Name         | Scope    | Type                                  | Description                                                                                                                                                         |
+|--------------+----------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `code`       | Required | String                                | Unique identifier you create and assign to this ad unit.  Used to set query string targeting on the ad. If using GPT, we recommend setting this to slot element ID. |
+| `sizes`      | Required | Array[Number] or Array[Array[Number]] | All sizes this ad unit can accept.  Examples: `[400, 600]`, `[[300, 250], [300, 600]]`.  For 1.0 and later, prefer one of the `mediaTypes.*.sizes` listed below.    |


Instead of "For 1.0 and later, prefer one of the mediaTypes.*.sizes listed below.", let's say "For 1.0 and later, best practice is to define size(s) within the appropriate mediaTypes.banner|native|video object"

Updated in f3ffb3a

mjacobsonny · 2018-01-24T14:09:48Z

dev-docs/adunit-reference.md

+|--------------+----------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `code`       | Required | String                                | Unique identifier you create and assign to this ad unit.  Used to set query string targeting on the ad. If using GPT, we recommend setting this to slot element ID. |
+| `sizes`      | Required | Array[Number] or Array[Array[Number]] | All sizes this ad unit can accept.  Examples: `[400, 600]`, `[[300, 250], [300, 600]]`.  For 1.0 and later, prefer one of the `mediaTypes.*.sizes` listed below.    |
+| `bids`       | Required | Array[Object]                         | Each bid represents a request to a bidder.  For a list of properties, see [Bids](#bids) below.                                                                      |


"Array of bid objects representing the demand partners and associated parameters for a given adUnit. See Bids below".

Updated in 73a556d

mjacobsonny · 2018-01-24T14:15:10Z

dev-docs/adunit-reference.md

+| `code`       | Required | String                                | Unique identifier you create and assign to this ad unit.  Used to set query string targeting on the ad. If using GPT, we recommend setting this to slot element ID. |
+| `sizes`      | Required | Array[Number] or Array[Array[Number]] | All sizes this ad unit can accept.  Examples: `[400, 600]`, `[[300, 250], [300, 600]]`.  For 1.0 and later, prefer one of the `mediaTypes.*.sizes` listed below.    |
+| `bids`       | Required | Array[Object]                         | Each bid represents a request to a bidder.  For a list of properties, see [Bids](#bids) below.                                                                      |
+| `mediaTypes` | Optional | Object                                | Defines the media type of the ad.  For a list of properties, see [Media Types](#mediatypes) below.                                                                  |


I assume we'll modify this wording later to refer to multiple media types?

Updated the description to note that there can be one or more media types on a single ad unit in d898dcb

Happy to update that description if you have additional comments!

mjacobsonny · 2018-01-24T14:16:44Z

dev-docs/adunit-reference.md

+{: .table .table-bordered .table-striped }
+| Name     | Scope                                                        | Type   | Description                                                                                    |
+|----------+--------------------------------------------------------------+--------+------------------------------------------------------------------------------------------------|
+| `banner` | Required, unless either of the other properties are present. | Object | Defines properties of a banner ad.  For examples, see [`adUnit.mediaTypes.banner`](#banner).   |


"At least one of the 'banner', 'native' or 'video' objects is required."

Updated in 0d91a4c

mjacobsonny · 2018-01-24T14:18:37Z

dev-docs/adunit-reference.md

+{: .table .table-bordered .table-striped }
+| Name          | Scope    | Type                                  | Description                                                                                                                       |
+|---------------+----------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------|
+| `sizes`       | Required | Array[Number] or Array[Array[Number]] | All sizes this ad unit can accept.  Examples: `[400, 600]`, `[[300, 250], [300, 600]]`.                                           |


"mediaTypes.native.sizes" should not be a property, as a native ad does not have a size. Sizes may be specified on certain assets.

Ah, nice catch - thanks!

Removed in deadcb4

mjacobsonny · 2018-01-24T14:38:32Z

dev-docs/adunit-reference.md

+{: .table .table-bordered .table-striped }
+| Name             | Scope    | Type                   | Description                                                                                                                                             |
+|------------------+----------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `context`        | Required | String                 | The video context, either `"instream"` or `"outstream"`.  Example: `context: "outstream"`                                                               |


At the moment, I think video.context is optional.

Thanks, updated in 8b2c1c1

mjacobsonny · 2018-01-24T14:41:18Z

dev-docs/adunit-reference.md

+|------------------+----------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `context`        | Required | String                 | The video context, either `"instream"` or `"outstream"`.  Example: `context: "outstream"`                                                               |
+| `playerSize`     | Optional | Array[Integer,Integer] | The size (width, height) of the video player on the page, in pixels.  Example: `playerSize: [640, 480]`                                                 |
+| `mimes`          | Optional | Array[String]          | Required by OpenRTB when using [Prebid Server]({{site.baseurl}}/dev-docs/get-started-with-prebid-server.html).  Example: `mimes: ['video/mp4']`         |


The note about "Required by Prebid Server" should feature more prominently. Let's change the scope to something like "Recommended. Required by OpenRTB when using Prebid Server...".

Description should be taken from OpenRTB spec:

Content MIME types supported (e.g., “video/x-ms-wmv”,
“video/mp4”)

Updated in 53a6e3f

mjacobsonny · 2018-01-24T14:43:16Z

dev-docs/adunit-reference.md

+| `context`        | Required | String                 | The video context, either `"instream"` or `"outstream"`.  Example: `context: "outstream"`                                                               |
+| `playerSize`     | Optional | Array[Integer,Integer] | The size (width, height) of the video player on the page, in pixels.  Example: `playerSize: [640, 480]`                                                 |
+| `mimes`          | Optional | Array[String]          | Required by OpenRTB when using [Prebid Server]({{site.baseurl}}/dev-docs/get-started-with-prebid-server.html).  Example: `mimes: ['video/mp4']`         |
+| `protocols`      | Optional | Array[Integer]         | Required by OpenRTB when using [Prebid Server]({{site.baseurl}}/dev-docs/get-started-with-prebid-server.html).  Example: `protocols: [1,2,3,4,5,6,7,8]` |


Description should be taken from/ reference the OpenRTB spec:

"Array of supported video protocols"

Updated in 53a6e3f

mjacobsonny · 2018-01-24T14:43:23Z

dev-docs/adunit-reference.md

+| `playerSize`     | Optional | Array[Integer,Integer] | The size (width, height) of the video player on the page, in pixels.  Example: `playerSize: [640, 480]`                                                 |
+| `mimes`          | Optional | Array[String]          | Required by OpenRTB when using [Prebid Server]({{site.baseurl}}/dev-docs/get-started-with-prebid-server.html).  Example: `mimes: ['video/mp4']`         |
+| `protocols`      | Optional | Array[Integer]         | Required by OpenRTB when using [Prebid Server]({{site.baseurl}}/dev-docs/get-started-with-prebid-server.html).  Example: `protocols: [1,2,3,4,5,6,7,8]` |
+| `playbackmethod` | Optional | Array[Integer]         | Required by OpenRTB when using [Prebid Server]({{site.baseurl}}/dev-docs/get-started-with-prebid-server.html).  Example: `playbackmethod: [2]`          |


Description should be taken from/ reference the OpenRTB spec.

Updated in 53a6e3f

mjacobsonny · 2018-01-24T14:56:53Z

dev-docs/adunit-reference.md

+| `type`        | Optional | String                                | Used as a shorthand, e.g., `type: 'image'` implies required fields `image`, `title`, `sponsoredBy`, `clickUrl`.                   |
+| `title`       | Required | Object                                | The title of the ad, usually a call to action or a brand name.  For properties, see [`native.title`](#native-title).              |
+| `body`        | Required | Object                                | Text of the ad copy.  For properties, see [`native.body`](#native-body).                                                          |
+| `sponsoredBy` | Required | String                                | The name of the brand associated with the ad.  For properties, see [`native.sponsoredBy`](#native-sponsoredby).                   |


sponsoredBy is an Object, not a String.

Nice catch, thanks! Updated in a761885

* 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

* Add note about non-1.0 adapters * Add trailing spaces back

Update for Vertamedia Adapter description Add examples

@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

* update prebid version * review update

Also, remove some unnecessary nesting from a few headers

rmloveland · 2018-01-30T16:48:13Z

@mjacobsonny responding to some work items in your overall comment -

At the top, I think we should provide a high-level description of what an adUnit is.

Added a description in 34312ae, let me know what you think of it.

The TOC looks a bit cluttered at the moment, but I don't necessarily have a better suggestion for how to fix it.

Not sure either. My goal is for the TOC (and in-page anchor links) to match the "shape" of the object exactly so it's easier to jump to exactly what you need. Unfortunately the visual of the TOC nested by property names is ... not great.

I don't think that the section headings should be monospaced, and I'm not sure whether I like that each section header gets smaller as the objects get more nested.

Removed the monospacing from headers in f91563f.

I'm not a fan of the header text shrinking like that either. I filed an issue to fix: #581

This already exists elsewhere, on the 'Show Native Ads' page.

For example, see: https://github.com/prebid/Prebid.js/blob/master/test/spec/unit/core/adapterManager_spec.js#L836

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 ); ```

* vi bid adapter docs * VI bid adapter docs - added header * VI adapter docs - renamed file and changed according to example

* Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter * Add: documentation for nasmediaAdmixer Adapter

* 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

* PubMatic 1.0 Adapter Updates * Remove $$PREBID_GLOBAL$$ reference * Add prebid_1_0_supported flag

* Gjirafa bidder params documentation * Add Prebid 1.0 supported line * Change prebid support line

rmloveland · 2018-02-06T18:25:40Z

@mjacobsonny do you have any additional feedback items on this PR I should address so we can merge?

mjacobsonny

Few minor comments, but otherwise looks good to me!

mjacobsonny · 2018-02-07T14:06:13Z

dev-docs/adunit-reference.md

+    mediaTypes: {
+        video: {
+            context: "instream",
+            sizes: [640, 480],


Should be "playerSize" instead of "sizes".

Addressed in 0333fd6

mjacobsonny · 2018-02-07T14:06:46Z

dev-docs/adunit-reference.md

+    mediaTypes: {
+        video: {
+            context: 'outstream',
+            sizes: [640, 480]


"playerSize" instead of "sizes"

Addressed in 0333fd6

mjacobsonny · 2018-02-07T14:08:42Z

dev-docs/adunit-reference.md

+            bids: [{
+                bidder: 'appnexus',
+                params: {
+                    placementId: 12340414,


Here, "placementId" is being passed as an int, but above it's being passed as a String. Let's make sure we're consistent across examples.

Thanks - updated in 42b9c7d to pass as string, since that's also what we show in the AN adapter example on the Bidder params page

rmloveland · 2018-02-08T16:06:39Z

Thanks again for the great review @mjacobsonny

@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 22, 2018 17:51

Add first draft of ad unit reference

bf8530d

Add examples to ad unit reference

6075ad1

rmloveland requested a review from mjacobsonny January 22, 2018 23:07

This was referenced Jan 23, 2018

Document complete list of parameters supported by mediaTypes.video object #525

Closed

Update ad unit reference with multiformat info #562

Closed

mjacobsonny reviewed Jan 24, 2018

View reviewed changes

mkendall07 self-assigned this Jan 24, 2018

rmloveland and others added 11 commits January 30, 2018 11:31

Add multiformat ad unit information (#541)

5c31c6c

* 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)

849e775

* update tag samples with multiformat syntax * reverting part of change on show-native-ads.md

Re-add trailing spaces to info boxes (#573)

2a1f434

Add note about non-1.0 adapters (#570)

7838c6c

* Add note about non-1.0 adapters * Add trailing spaces back

suppord prebid.js 1.0 Colossusssp (#560)

8485dc6

Update vertamedia.md (#567)

6528878

Update for Vertamedia Adapter description Add examples

update prebid version download page 1.2.0 & 0.34.2 (#580)

21792fa

* update prebid version * review update

Provide a high-level description of an ad unit

34312ae

Remove monospacing from section headers

f91563f

Also, remove some unnecessary nesting from a few headers

Rich Loveland added 10 commits January 30, 2018 11:54

Fix up anchor links to use object properties

59f410b

Add multi-format example

c24e6b5

Update description of sizes per feedback

f3ffb3a

Update bids description based on feedback

73a556d

Update mediaTypes description

d898dcb

Edit scope description for {banner,native,video}

0d91a4c

There is no mediaTypes.native.sizes

deadcb4

Add link to docs on pre-defined native types

3525e50

Update native.title description per feedback

d371f5b

Mark all native assets as optional

bccf932

Rich Loveland and others added 20 commits January 30, 2018 14:50

Update native.body description

900b2e4

sponsoredBy is an object

a761885

Update native.image description

27bc64b

Remove Prebid Native validation warning

ca5181d

This already exists elsewhere, on the 'Show Native Ads' page.

Native ad validation checks for landing page URL

083a247

sizes and aspect_ratios are both allowed

84afc6c

For example, see: https://github.com/prebid/Prebid.js/blob/master/test/spec/unit/core/adapterManager_spec.js#L836

Update native.title.len description

cecd7a4

Mark context as optional

8b2c1c1

Mark required properties as optional

dbc79b2

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)

7332e64

vi bid adapter docs (#537)

e5e69d1

* 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)

1a29498

* 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)

74dd56c

RockYou Adapter: Added docs for the RockYou Bidder Adapter (#551)

78b4bac

Adding Optimera doc. (#569)

b915cca

PubMatic 1.0 Adapter Updates (#530)

201f427

* PubMatic 1.0 Adapter Updates * Remove $$PREBID_GLOBAL$$ reference * Add prebid_1_0_supported flag

Gjirafa bidder params documentation (#483)

67e7f23

* Gjirafa bidder params documentation * Add Prebid 1.0 supported line * Change prebid support line

Add body.len to table with description

be02c24

Update mimes, protocols, playbackmethods

53a6e3f

rmloveland mentioned this pull request Feb 2, 2018

Add section on renderer.options #556

Merged

Merge branch 'master' into adunit-reference

4faeda1

mjacobsonny reviewed Feb 7, 2018

View reviewed changes

Rich Loveland added 2 commits February 8, 2018 11:03

s/sizes/playerSize/g for video ads

0333fd6

Pass placementId as a string in examples

42b9c7d

rmloveland merged commit 7057cf5 into master Feb 8, 2018

rmloveland deleted the adunit-reference branch February 8, 2018 16:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a reference doc for the `adUnit` object #558

Add a reference doc for the `adUnit` object #558

rmloveland commented Jan 22, 2018

rmloveland commented Jan 22, 2018

mjacobsonny left a comment

mjacobsonny Jan 24, 2018

rmloveland Jan 30, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 30, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 30, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 30, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 30, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 30, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 31, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 31, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 31, 2018

mjacobsonny Jan 24, 2018

rmloveland Jan 30, 2018

rmloveland commented Jan 30, 2018

rmloveland commented Feb 6, 2018

mjacobsonny left a comment

mjacobsonny Feb 7, 2018

rmloveland Feb 8, 2018

mjacobsonny Feb 7, 2018

rmloveland Feb 8, 2018

mjacobsonny Feb 7, 2018

rmloveland Feb 8, 2018

rmloveland commented Feb 8, 2018

Add a reference doc for the adUnit object #558

Add a reference doc for the adUnit object #558

Conversation

rmloveland commented Jan 22, 2018

rmloveland commented Jan 22, 2018

mjacobsonny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

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

rmloveland commented Jan 30, 2018

rmloveland commented Feb 6, 2018

mjacobsonny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmloveland commented Feb 8, 2018

Add a reference doc for the `adUnit` object #558

Add a reference doc for the `adUnit` object #558