banner.go

package openrtb

import "encoding/json"

// The "banner" object must be included directly in the impression object if the impression offered
// for auction is display or rich media, or it may be optionally embedded in the video object to
// describe the companion banners available for the linear or non-linear video ad.  The banner
// object may include a unique identifier; this can be useful if these IDs can be leveraged in the
// 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             `json:"w,omitempty"`        // Width
	H        int             `json:"h,omitempty"`        // Height
	Format   []Format        `json:"format,omitempty"`   //Array of format objects representing the banner sizes permitted.
	WMax     int             `json:"wmax,omitempty"`     // Width maximum DEPRECATED
	HMax     int             `json:"hmax,omitempty"`     // Height maximum DEPRECATED
	WMin     int             `json:"wmin,omitempty"`     // Width minimum DEPRECATED
	HMin     int             `json:"hmin,omitempty"`     // Height minimum DEPRECATED
	ID       string          `json:"id,omitempty"`       // A unique identifier
	BType    []int           `json:"btype,omitempty"`    // Blocked creative types
	BAttr    []int           `json:"battr,omitempty"`    // Blocked creative attributes
	Pos      int             `json:"pos,omitempty"`      // Ad Position
	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      json.RawMessage `json:"ext,omitempty"`
}