Added JSON export for requests

Author: dim

app.go

@@ -4,21 +4,21 @@ package openrtb
 // (as opposed to a mobile website).  A bid request must not contain both an "app" object and a
 // "site" object.
 type App struct {
-	Id            *string // App ID on the exchange
-	Name          *string // App name
-	Domain        *string
-	Cat           []string // Array of IAB content categories
-	Sectioncat    []string // Array of IAB content categories for subsection
-	Pagecat       []string // Array of IAB content categories for page
-	Ver           *string  // App version
-	Bundle        *string  // App bundle or package name
-	Privacypolicy *int     // Default: 1 ("1": site has a privacy policy)
-	Paid          *int     // "1": Paid, "2": Free
-	Publisher     *Publisher
+	Id            *string    `json:"id,omitempty"`   // App ID on the exchange
+	Name          *string    `json:"name,omitempty"` // App name
+	Domain        *string    `json:"domain,omitempty"`
+	Cat           []string   `json:"cat,omitempty"`           // Array of IAB content categories
+	Sectioncat    []string   `json:"sectioncat,omitempty"`    // Array of IAB content categories for subsection
+	Pagecat       []string   `json:"pagecat,omitempty"`       // Array of IAB content categories for page
+	Ver           *string    `json:"ver,omitempty"`           // App version
+	Bundle        *string    `json:"bundle,omitempty"`        // App bundle or package name
+	Privacypolicy *int       `json:"privacypolicy,omitempty"` // Default: 1 ("1": site has a privacy policy)
+	Paid          *int       `json:"paid,omitempty"`          // "1": Paid, "2": Free
+	Publisher     *Publisher `json:"publisher,omitempty"`
 	// Content       Content
-	Keywords []string
-	Storeurl *string // App store URL for an installed app
-	Ext      Extensions
+	Keywords []string   `json:"keywords,omitempty"`
+	Storeurl *string    `json:"storeurl,omitempty"` // App store URL for an installed app
+	Ext      Extensions `json:"ext,omitempty"`
 }
 
 // Returns the privacy policy status, with default fallback

banner.go

@@ -7,17 +7,17 @@ package openrtb
 // VAST response to dictate placement of the companion creatives when multiple companion ad
 // opportunities of the same size are available on a page.
 type Banner struct {
-	W        *int     // Width
-	H        *int     // Height
-	Id       *string  // A unique identifier
-	Pos      *int     // Ad Position
-	Btype    []int    // Blocked creative types
-	Battr    []int    // Blocked creative attributes
-	Mimes    []string // Whitelist of content MIME types supported
-	Topframe *int     // Default: 0 ("1": Delivered in top frame, "0": Elsewhere)
-	Expdir   []int    // Specify properties for an expandable ad
-	Api      []int    // List of supported API frameworks
-	Ext      Extensions
+	W        *int       `json:"w,omitempty"`        // Width
+	H        *int       `json:"h,omitempty"`        // Height
+	Id       *string    `json:"id,omitempty"`       // A unique identifier
+	Pos      *int       `json:"pos,omitempty"`      // Ad Position
+	Btype    []int      `json:"btype,omitempty"`    // Blocked creative types
+	Battr    []int      `json:"battr,omitempty"`    // Blocked creative attributes
+	Mimes    []string   `json:"mimes,omitempty"`    // Whitelist of content MIME types supported
+	Topframe *int       `json:"topframe,omitempty"` // Default: 0 ("1": Delivered in top frame, "0": Elsewhere)
+	Expdir   []int      `json:"expdir,omitempty"`   // Specify properties for an expandable ad
+	Api      []int      `json:"api,omitempty"`      // List of supported API frameworks
+	Ext      Extensions `json:"ext,omitempty"`
 }
 
 // Returns topframe status, with default fallback

device.go

@@ -4,26 +4,26 @@ package openrtb
 // platform, location, and carrier. This device can refer to a mobile handset, a desktop computer,
 // set top box or other digital device.
 type Device struct {
-	Dnt            *int    // "1": Do not track
-	Ua             *string // User agent
-	Ip             *string // IPv4
-	Geo            *Geo
-	Didsha1        *string // SHA1 hashed device ID
-	Didmd5         *string // MD5 hashed device ID
-	Dpidsha1       *string // SHA1 hashed platform device ID
-	Dpidmd5        *string // MD5 hashed platform device ID
-	Ipv6           *string // IPv6
-	Carrier        *string // Carrier or ISP derived from the IP address
-	Language       *string // Browser language
-	Make           *string // Device make
-	Model          *string // Device model
-	Os             *string // Device OS
-	Osv            *string // Device OS version
-	Js             *int    // Javascript status ("0": Disabled, "1": Enabled)
-	Connectiontype *int
-	Devicetype     *int
-	Flashver       *string // Flash version
-	Ext            map[string]string
+	Dnt            *int              `json:"dnt,omitempty"` // "1": Do not track
+	Ua             *string           `json:"ua,omitempty"`  // User agent
+	Ip             *string           `json:"ip,omitempty"`  // IPv4
+	Geo            *Geo              `json:"geo,omitempty"`
+	Didsha1        *string           `json:"didsha1,omitempty"`  // SHA1 hashed device ID
+	Didmd5         *string           `json:"didmd5,omitempty"`   // MD5 hashed device ID
+	Dpidsha1       *string           `json:"dpidsha1,omitempty"` // SHA1 hashed platform device ID
+	Dpidmd5        *string           `json:"dpidmd5,omitempty"`  // MD5 hashed platform device ID
+	Ipv6           *string           `json:"ipv6,omitempty"`     // IPv6
+	Carrier        *string           `json:"carrier,omitempty"`  // Carrier or ISP derived from the IP address
+	Language       *string           `json:"language,omitempty"` // Browser language
+	Make           *string           `json:"make,omitempty"`     // Device make
+	Model          *string           `json:"model,omitempty"`    // Device model
+	Os             *string           `json:"os,omitempty"`       // Device OS
+	Osv            *string           `json:"osv,omitempty"`      // Device OS version
+	Js             *int              `json:"js,omitempty"`       // Javascript status ("0": Disabled, "1": Enabled)
+	Connectiontype *int              `json:"connectiontype,omitempty"`
+	Devicetype     *int              `json:"devicetype,omitempty"`
+	Flashver       *string           `json:"flashver,omitempty"` // Flash version
+	Ext            map[string]string `json:"ext,omitempty"`
 }
 
 // Returns the DNT status, with default fallback

impression.go

@@ -10,17 +10,17 @@ import (
 // bids can reference them individually.  An exchange can also conduct private auctions by
 // restricting involvement to specific subsets of seats within bidders.
 type Impression struct {
-	Id                *string // A unique identifier for this impression
-	Banner            *Banner
-	Video             *Video
-	Displaymanager    *string  // Name of ad mediation partner, SDK technology, etc
-	Displaymanagerver *string  // Version of the above
-	Instl             *int     // Interstitial, Default: 0 ("1": Interstitial, "0": Something else)
-	Tagid             *string  // Identifier for specific ad placement or ad tag
-	Bidfloor          *float32 // Bid floor for this impression in CPM
-	Bidfloorcur       *string  // Currency of bid floor
-	Iframebuster      []string // Array of names for supportediframe busters.
-	Ext               Extensions
+	Id                *string    `json:"id` // A unique identifier for this impression
+	Banner            *Banner    `json:"banner,omitempty"`
+	Video             *Video     `json:"video,omitempty"`
+	Displaymanager    *string    `json:"displaymanager,omitempty"`    // Name of ad mediation partner, SDK technology, etc
+	Displaymanagerver *string    `json:"displaymanagerver,omitempty"` // Version of the above
+	Instl             *int       `json:"instl,omitempty"`             // Interstitial, Default: 0 ("1": Interstitial, "0": Something else)
+	Tagid             *string    `json:"tagid,omitempty"`             // Identifier for specific ad placement or ad tag
+	Bidfloor          *float32   `json:"bidfloor,omitempty"`          // Bid floor for this impression in CPM
+	Bidfloorcur       *string    `json:"bidfloorcur,omitempty"`       // Currency of bid floor
+	Iframebuster      []string   `json:"iframebuster,omitempty"`      // Array of names for supportediframe busters.
+	Ext               Extensions `json:"ext,omitempty"`
 }
 
 // Validation errors

openrtb.go

@@ -65,11 +65,11 @@ const (
 
 // Abstract third-party
 type ThirdParty struct {
-	Id     *string
-	Name   *string
-	Cat    []string // Array of IAB content categories
-	Domain *string
-	Ext    Extensions
+	Id     *string    `json:"id,omitempty"`
+	Name   *string    `json:"name,omitempty"`
+	Cat    []string   `json:"cat,omitempty"` // Array of IAB content categories
+	Domain *string    `json:"domain,omitempty"`
+	Ext    Extensions `json:"ext,omitempty"`
 }
 
 // The publisher object itself and all of its parameters are optional, so default values are not
@@ -87,70 +87,70 @@ type Producer ThirdParty
 // (such as IP geo lookup), or by user registration information (for example provided to a publisher
 // through a user registration).
 type Geo struct {
-	Lat           *float32 // Latitude from -90 to 90
-	Lon           *float32 // Longitude from -180 to 180
-	Country       *string  // Country using ISO 3166-1 Alpha 3
-	Region        *string  // Region using ISO 3166-2
-	Regionfips104 *string  // Region of a country using fips 10-4
-	Metro         *string
-	City          *string
-	Zip           *string
-	Type          *int // Indicate the source of the geo data
-	Ext           Extensions
+	Lat           *float32   `json:"lat,omitempty"`           // Latitude from -90 to 90
+	Lon           *float32   `json:"lon,omitempty"`           // Longitude from -180 to 180
+	Country       *string    `json:"country,omitempty"`       // Country using ISO 3166-1 Alpha 3
+	Region        *string    `json:"region,omitempty"`        // Region using ISO 3166-2
+	Regionfips104 *string    `json:"regionfips104,omitempty"` // Region of a country using fips 10-4
+	Metro         *string    `json:"metro,omitempty"`
+	City          *string    `json:"city,omitempty"`
+	Zip           *string    `json:"zip,omitempty"`
+	Type          *int       `json:"type,omitempty"` // Indicate the source of the geo data
+	Ext           Extensions `json:"ext,omitempty"`
 }
 
 // The "user" object contains information known or derived about the human user of the device.
 // Note that the user ID is an exchange artifact (refer to the "device" object for hardware or
 // platform derived IDs) and may be subject to rotation policies. However, this user ID must be
 // stable long enough to serve reasonably as the basis for frequency capping.
 type User struct {
-	Id         *string // Unique consumer ID of this user on the exchange
-	Buyeruid   *string // Buyer's user ID
-	Yob        *int    // Year-of-birth
-	Gender     *string // Gender ("M": male, "F" female, "O" Other)
-	Keywords   *string
-	Customdata *string
-	Geo        *Geo
-	Data       []Data
-	Ext        Extensions
+	Id         *string    `json:"id,omitempty"`       // Unique consumer ID of this user on the exchange
+	Buyeruid   *string    `json:"buyeruid,omitempty"` // Buyer's user ID
+	Yob        *int       `json:"yob,omitempty"`      // Year-of-birth
+	Gender     *string    `json:"gender,omitempty"`   // Gender ("M": male, "F" female, "O" Other)
+	Keywords   *string    `json:"keywords,omitempty"`
+	Customdata *string    `json:"customdata,omitempty"`
+	Geo        *Geo       `json:"geo,omitempty"`
+	Data       []Data     `json:"data,omitempty"`
+	Ext        Extensions `json:"ext,omitempty"`
 }
 
 // The data and segment objects together allow data about the user to be passed to bidders in the
 // bid request.  This data may be from multiple sources (e.g., the exchange itself, third party
 // providers) as specified by the data object ID field.  A bid request can mix data objects from
 // multiple providers.
 type Data struct {
-	Id      *string
-	Name    *string
-	Segment []Segment
-	Ext     Extensions
+	Id      *string    `json:"id,omitempty"`
+	Name    *string    `json:"name,omitempty"`
+	Segment []Segment  `json:"segment,omitempty"`
+	Ext     Extensions `json:"ext,omitempty"`
 }
 
 // The data and segment objects together allow data about the user to be passed to bidders in the
 // bid request.  Segment objects convey specific units of information from the provider identified
 // in the parent data object.
 type Segment struct {
-	Id    *string
-	Name  *string
-	Value *string
-	Ext   Extensions
+	Id    *string    `json:"id,omitempty"`
+	Name  *string    `json:"name,omitempty"`
+	Value *string    `json:"value,omitempty"`
+	Ext   Extensions `json:"ext,omitempty"`
 }
 
 // Private Marketplace Object
 type Pmp struct {
-	Private *int
-	Deals   []Deal
-	Ext     Extensions
+	Private *int       `json:"private,omitempty"`
+	Deals   []Deal     `json:"deals,omitempty"`
+	Ext     Extensions `json:"ext,omitempty"`
 }
 
 // Private Marketplace Deal
 type Deal struct {
-	Id       *string  // Unique deal ID
-	At       *int     // Auction type, Default: 2 ("1": first price auction, "2": then second price auction)
-	Seats    []string // List of seat IDs attached to this deal
-	Type     *int     // Deal indicator ("1": Eplicit Deal, "2": Trading Agreement Deal)
-	Bidfloor *float32
-	Ext      Extensions
+	Id       *string    `json:"id,omitempty"`    // Unique deal ID
+	At       *int       `json:"at,omitempty"`    // Auction type, Default: 2 ("1": first price auction, "2": then second price auction)
+	Seats    []string   `json:"seats,omitempty"` // List of seat IDs attached to this deal
+	Type     *int       `json:"type,omitempty"`  // Deal indicator ("1": Eplicit Deal, "2": Trading Agreement Deal)
+	Bidfloor *float32   `json:"bidfloor,omitempty"`
+	Ext      Extensions `json:"ext,omitempty"`
 }
 
 // General Extensions

request.go

@@ -10,21 +10,21 @@ import (
 // attribute is required as is at least one "imp" (i.e., impression) object.  Other attributes are
 // optional since an exchange may establish default values.
 type Request struct {
-	Id      *string // Unique ID of the bid request
-	Imp     []Impression
-	Site    *Site
-	App     *App
-	Device  *Device
-	User    *User
-	At      *int     // Auction type, Default: 2 ("1": first price auction, "2": then second price auction)
-	Tmax    *int     // Maximum amount of time in milliseconds to submit a bid
-	Wseat   []string // Array of buyer seats allowed to bid on this auction
-	Allimps *int     // Flag to indicate whether exchange can verify that all impressions offered represent all of the impressions available in context, Default: 0
-	Cur     []string // Array of allowed currencies
-	Bcat    []string // Blocked Advertiser Categories.
-	Badv    []string // Array of strings of blocked toplevel domains of advertisers
-	Pmp     *Pmp
-	Ext     Extensions
+	Id      *string      `json:"id"` // Unique ID of the bid request
+	Imp     []Impression `json:"imp,omitempty"`
+	Site    *Site        `json:"site,omitempty"`
+	App     *App         `json:"app,omitempty"`
+	Device  *Device      `json:"device,omitempty"`
+	User    *User        `json:"user,omitempty"`
+	At      *int         `json:"at"`                // Auction type, Default: 2 ("1": first price auction, "2": then second price auction)
+	Tmax    *int         `json:"tmax,omitempty"`    // Maximum amount of time in milliseconds to submit a bid
+	Wseat   []string     `json:"wseat,omitempty"`   // Array of buyer seats allowed to bid on this auction
+	Allimps *int         `json:"allimps,omitempty"` // Flag to indicate whether exchange can verify that all impressions offered represent all of the impressions available in context, Default: 0
+	Cur     []string     `json:"cur,omitempty"`     // Array of allowed currencies
+	Bcat    []string     `json:"bcat,omitempty"`    // Blocked Advertiser Categories.
+	Badv    []string     `json:"badv,omitempty"`    // Array of strings of blocked toplevel domains of advertisers
+	Pmp     *Pmp         `json:"pmp,omitempty"`
+	Ext     Extensions   `json:"ext,omitempty"`
 }
 
 // Parses an OpenRTB Request struct from an io.Reader
@@ -53,6 +53,11 @@ var (
 	invalidReqSaA = errors.New("openrtb parse: request has site and app")
 )
 
+// Generate JSON
+func (req *Request) JSON() ([]byte, error) {
+	return json.Marshal(req)
+}
+
 // Validates the request
 func (req *Request) Valid() (bool, error) {
 	if req.Id == nil {

request_test.go

@@ -62,6 +62,18 @@ func TestRequest_WithDefaults(t *testing.T) {
 	assert.Equal(t, "pending", "TODO")
 }
 
+func TestRequest_JSON(t *testing.T) {
+	req, err := ParseRequest(bytes.NewBuffer(expandableCreative))
+	assert.Nil(t, err)
+
+	if req != nil {
+		assert.Equal(t, "pending", "TODO")
+		// json, err := req.JSON()
+		// assert.Nil(t, err)
+		// assert.Equal(t, string(json), string(expandableCreative))
+	}
+}
+
 var simpleBanner []byte = []byte(`
 {
   "id":"1234534625254",

site.go

@@ -3,20 +3,20 @@ package openrtb
 // A site object should be included if the ad supported content is part of a website (as opposed to
 // an application).  A bid request must not contain both a site object and an app object.
 type Site struct {
-	Id            *string // Site ID on the exchange
-	Name          *string // Site name
-	Domain        *string
-	Cat           []string // Array of IAB content categories
-	Sectioncat    []string // Array of IAB content categories for subsection
-	Pagecat       []string // Array of IAB content categories for page
-	Page          *string  // URL of the page
-	Privacypolicy *int     // Default: 1 ("1": site has a privacy policy)
-	Ref           *string  // Referrer URL
-	Search        *string  // Search string that caused naviation
-	Publisher     *Publisher
+	Id            *string    `json:"id,omitempty"`   // Site ID on the exchange
+	Name          *string    `json:"name,omitempty"` // Site name
+	Domain        *string    `json:"domain,omitempty"`
+	Cat           []string   `json:"cat,omitempty"`           // Array of IAB content categories
+	Sectioncat    []string   `json:"sectioncat,omitempty"`    // Array of IAB content categories for subsection
+	Pagecat       []string   `json:"pagecat,omitempty"`       // Array of IAB content categories for page
+	Page          *string    `json:"page,omitempty"`          // URL of the page
+	Privacypolicy *int       `json:"privacypolicy,omitempty"` // Default: 1 ("1": site has a privacy policy)
+	Ref           *string    `json:"ref,omitempty"`           // Referrer URL
+	Search        *string    `json:"search,omitempty"`        // Search string that caused naviation
+	Publisher     *Publisher `json:"publisher,omitempty"`
 	// Content       Content
-	Keywords []string
-	Ext      Extensions
+	Keywords []string   `json:"keywords,omitempty"`
+	Ext      Extensions `json:"ext,omitempty"`
 }
 
 // Returns the privacy policy status, with default fallback