Full Code of openrtb/OpenRTB for AI

Repository: openrtb/OpenRTB
Branch: master
Commit: 76a6d25c74a0
Files: 5
Total size: 10.0 KB

Directory structure:
gitextract_5r59viej/

├── CHANGELOG
├── Diagrams_OpenRTB_2_2.docx
├── LICENSE
├── README.md
└── proposals.txt

================================================
FILE CONTENTS
================================================

================================================
FILE: CHANGELOG
================================================


This section of the CHANGELOG describes changes to the OpenRTB 2.2 SPEC.  See the openrtb-dev mailing list for discussions

Oct 25, 2013 Release Candiate RC1
  Changes:
     http://code.google.com/p/openrtb/wiki/MobileMods
     http://code.google.com/p/openrtb/wiki/COPPASignaling
     http://code.google.com/p/openrtb/wiki/VideoLinearityChange
     http://code.google.com/p/openrtb/wiki/ProposalforPrivateMarketplaceDealIDExtensions
     http://code.google.com/p/openrtb/wiki/OpenRTBNonHumanTrafficSignaling

November 20, 2013 Release Candidate RC2
  Changes:
    - re-did the object diagrams in Word "Shapes" (uggggg)
    - fixed a few typos
    - added option #3 fixed-price deals for at field values.
    - private_auction is an integer flag

Jan 17, 2014 Release Candiate RC3
   Changes:
    - updated the examples
    - added link to GitHub examples repository
    - update keywords descriptions to note inconsistencies of in-the-wild implementations  
   
Feb 4, 2014 Release Candidate RC4
   Changes since RC3:
    - Change hopepage of the project to the github repository
         (Google Code is no longer accepting uploads)
    - Add note on Github repository in examples section
    - All examples various orgs provided are now in GitHub.
    - misc typos and capitalization errors
    - insert comment per thread "Device type phone vs tablet" in Table 6.16
    - add optional hmax & wmax to banner object per "banner.wmin/hmin" thread
    - add optional version header to response object

Feb 4, 2014 Release Candidate RC5
   Changes:
    - added wadomain as optional field as list of strings in Deals object.
    - tweaked wording of Deals wseats description to be more clear.
    - corrected two typos from Word's obsessive auto-correction & auto-capitalization of field names. 

Feb 6, 2014 Release Candidate RC6
   Changes
    - added video.protocols field and tweaked language of video.protocol

Feb 9, 2014 Release Candidate RC7
   Changes
    - further tweak of video.protocol and video.protocols description
    - promotion of video.protocols to recommended
    - demotion of video.protocols to optional
    - added e.g. note to the device.ifa field

Feb 12, 2014 Release Candidate RC8
   Changes
    - Capitalization corrections needed for imp.Id, video.Mimes, video.Pos, video.Api, and video.Ext
    - pmp.deals declared as an "array of objects".
    - pmp.private_auction now indicates the meaning of its values in the description
    - Added section and link to the public validator developed by NextAge

March 18, 2014 Release Candidate RC9
   Changes
    - add imp.secure flag for positive signaling of HTTPS/SSL creative assests in the bids.

March 19, 2014 Release Candidate FINAL
   Changes
    - Cosmetic changes to URL links broken in the conversion from Word to PDF.

April 21, 2014
   Changes
   - add 'integer' as field type for h/v in bid response object.  FINAL DRAFT.




================================================
FILE: LICENSE
================================================
Copyright (c) 2014, OpenRTB Project
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this
  list of conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

================================================
FILE: README.md
================================================
OpenRTB Spec
=======

The home for documentation and issue tracking for OpenRTB

For general information, see [openrtb.github.io/OpenRTB](http://openrtb.github.io/OpenRTB)

To file an issue, use [GitHub Issues](https://github.com/openrtb/OpenRTB/issues).

OpenRTB has two mailing lists you can join:

- for discussions about **the development** of the OpenRTB spec, visit 
[openrtb-dev](https://groups.google.com/forum/#!forum/openrtb-dev).

- for discussions about **using** OpenRTB: visit
[openrtb-user](https://groups.google.com/forum/#!forum/openrtb-user)



================================================
FILE: proposals.txt
================================================

=======  Multi Size support ==========

In OpenRTB 2.32 we introduced wmin/wmax and hmin/hmax in an attempt to support one bid request for multiple sizes.
Unfortunately it didn't solve the problem well as it does not give the bidder unambiguous directions.

Problem statement:
A seller wants to expose an impression that support multiple 'formats'. Example:
Single impression will support [600x250] that changes shape on rollover via a well defined 
IAB Rising stars unit or [300x250] with a fixed creative size.

Using wmin/wmax & hmin/hmax allows the seller's exchange to specify the below:
"wmin": 300
"wmax": 600
"w":    300
"hmin": 250
"hmax": 250
"h":    250
 
However these instructions to the bidder are ambiguous as a 500x250 format is technically within the constraints expressed, 
yet not desired by the seller.  Additionally the seller wants confirmation of the format of the bid response in order to price 
the ad placement differently based upon the bid's creative size.  Analytics and reporting on ad formats is also more difficult
as the exchange must map the bid response back to a standard adunit size supported, also a source of ambiguity.


The following work-arounds are known to exist to eliminate this ambiguity in OpenRTB
- use of private extension to specify an array of w/h pairs.
- parallel bid requests to the same bidder with different sizes
- sequential cascaded requests to the same bidder with different sizes

We propose the following approach for OpenRTB 2.3 or a subsequent draft.

Request object changes

Banner object
|| Field || Scope || Type || Default || Description ||
| w      | optional/recommended | integer | - | Width of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible. |
| h      | optional/recommended |  integer | - | Height of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible. |
| wmin   | optional | integer | - | Deprecated |
| wmax   | optional | integer | - | Deprecated |
| hmin   | optional | integer | - | Deprecated |
| hmax   | optional | integer | - | Deprecated |
| sizes  | optional | array of objects  | - | An array of objects representing available ad sizes and formats for bid on this impression.  If utilized it is recommended that the array contain at least one entry.  See Sizes Object for more detail. |

Note that if w & h are omitted is recommended that the sizes array of objects be present and populated with at least one entry.

Sizes Object
|| Field || Scope || Type || Default || Description ||
| w      | recommended | integer | - | Width of the ad size in pixels.  |
| h      | recommended | integer | - | Height of the ad size in pixels. |
| fmt    | optional    | integer | - | The format ID of the ad.  See Table X.Y below |

Response Object changes

Bid Object
|| Field || Scope || Type || Default || Description ||
| w      | recommended | integer | - | Width of the ad size in pixels.  |
| h      | recommended | integer | - | Height of the ad size in pixels. |
| fmt | optional | integer | - | The format ID of the ad.  See Table X.Y below |

Example Request:

"banner": { 
    "sizes": [ 
        {
            "w": 600,
            "h": 250,
            "fmt: 55
        },
        {
            "w": 300,
            "h": 250,
            "fmt:  3
        }

     ],
    "pos": 0 
    },

An advantage of this representation is that the bidder can simply iterate on the sizes array and match the w/h/fmt with its internal list of ad formats available for bidding.

As a note Google's AdX protocol provides a facility to solve this problem via an array of w & h sizes.  This has proven to work in practice yet doesn't allow the optional 'format id' to unambiguously specify that a given ad format is supported for bidding (along with all known features of that ad format).
"w": [600,300]
"h": [250,250]


=======  Viewability support ==========

The viewability of a given impression is now emerging an important factor to buyers and sellers of ad unit inventory for mobile, video, social and display.

Impression object 
|| Field || Scope || Type || Default || Description ||
| viewstats | Optional | object | -  | The measured viewability statistics of associated impression.  Ideally these statistics are specific to the 'tagid' ie placement within the larger content and ad layout. See View Stats object. | 

View Stats object 
|| Field || Scope || Type || Default || Description ||
| onesec | Optional | string | -  | The probability of the impression's placement being at least 50% in-view of the user for 1 second.  | 
| fivesec | Optional | string | -  | The probability of the impression's placement being at least 50% in-view of the user for 5 seconds.  | 
| cnfd | optional | float | - | The confidence interval expressed as a probability of the viewability statistics. |
| vendor | Optional | string | -  | An optional identifier of the vendor of the viewability statistics | 

Example:

"imp": [
{
    "id": "1",
    "banner": { 
        "w": 728, 
        "h": 90, 
        "pos": 1,
        "btype": [ 4 ], 
        "battr": [ 14 ],
        "api": [ 3 ] 
    },
    "instl": 0,
    "bidfloor": 0.5,
    "tagid": "agltb3B1Yi1pbmNyDQsSBFNpdGUY7fD0FAw", 
    "viewstats": {
        "onesec": 0.85,
        "cnfd"  " 0.99,
        "vendor": "XYZ.com"
    }
}