Add all Native objects

Author: Ev Dolzhenko

native/request/asset.go

@@ -0,0 +1,17 @@
+package request
+
+import "encoding/json"
+
+// The main container object for each asset requested or supported by Exchange
+// on behalf of the rendering client.  Only one of the {title,img,video,data}
+// objects should be present in each object.  The id is to be unique within the
+// AssetObject array so that the response can be aligned.
+type Asset struct {
+	ID       int             `json:"id"`                 // Unique asset ID, assigned by exchange
+	Required int             `json:"required,omitempty"` // Set to 1 if asset is required
+	Title    *Title          `json:"title,omitempty"`    // Title object for title assets
+	Image    *Image          `json:"img,omitempty"`      // Image object for image assets
+	Video    *Video          `json:"video,omitempty"`    // Video object for video assets
+	Data     *Data           `json:"data,omitempty"`     // Data object for brand name, description, ratings, prices etc.
+	Ext      json.RawMessage `json:"ext,omitempty"`
+}

native/request/data.go

@@ -0,0 +1,27 @@
+package request
+
+import "encoding/json"
+
+type Data_Type int
+
+const (
+	Data_Sponsored      Data_Type = 1  // Sponsored By message where response should contain the brand name of the sponsor
+	Data_Desc           Data_Type = 2  // Descriptive text associated with the product or service being advertised
+	Data_Rating         Data_Type = 3  // Rating of the product being offered to the user
+	Data_Likes          Data_Type = 4  // Number of social ratings or “likes” of the product being offered to the user
+	Data_Downloads      Data_Type = 5  // Number downloads/installs of this product
+	Data_Price          Data_Type = 6  // Price for product / app / in-app purchase. Value should include currency symbol in localised format
+	Data_SalePrice      Data_Type = 7  // Sale price that can be used together with price to indicate a discounted price compared to a regular price. Value should include currency symbol in localised format
+	Data_Phone          Data_Type = 8  // Phone number
+	Data_Address        Data_Type = 9  // Address
+	Data_DescAdditional Data_Type = 10 // Additional descriptive text associated with the product or service being advertised
+	Data_DisplayURL     Data_Type = 11 // Display URL for the text ad. To be used when sponsoring entity doesn’t own the content. IE sponsored by BRAND on SITE (where SITE is transmitted in this field)
+	Data_CTADesc        Data_Type = 12 // CTA description - descriptive text describing a ‘call to action’ button for the destination URL
+
+)
+
+type Data struct {
+	Type   Data_Type       `json:"type"` // Type ID of the element supported by the publisher. The publisher can display this information in an appropriate format
+	Length int             `json:"len"`  // Maximum length of the text in the element’s response
+	Ext    json.RawMessage `json:"ext,omitempty"`
+}

native/request/image.go

@@ -0,0 +1,24 @@
+package request
+
+import "encoding/json"
+
+type Image_Type int
+
+const (
+	Image_Icon Image_Type = 1 // Icon image
+	Image_Logo Image_Type = 2 // Logo image for the brand/app
+	Image_Main Image_Type = 3 // Large image preview for the ad
+)
+
+type Image struct {
+	Type Image_Type `json:"type,omitempty"` // Type ID of the image element supported by the publisher
+
+	Width     int `json:"w,omitempty"`    // Width of the image in pixels
+	WidthMin  int `json:"wmin,omitempty"` // The minimum requested width of the image in pixels
+	Height    int `json:"h,omitempty"`    // Height of the image in pixels
+	HeightMin int `json:"hmin,omitempty"` // The minimum requested height of the image in pixels
+	// Either h/w or hmin/wmin should be transmitted. If only h/w is included, it
+	// should be considered an exact requirement
+	Mimes []string        `json:"mimes,omitempty"` // Whitelist of content MIME types supported
+	Ext   json.RawMessage `json:"ext,omitempty"`
+}

native/request/request.go

@@ -0,0 +1,79 @@
+package request
+
+import "encoding/json"
+
+type Request_Layout int
+
+const (
+	Request_ContentWall          Request_Layout = 1
+	Request_AppWall              Request_Layout = 2
+	Request_NewsFeed             Request_Layout = 3
+	Request_ChatList             Request_Layout = 4
+	Request_Carousel             Request_Layout = 5
+	Request_ContentStream        Request_Layout = 6
+	Request_GridAdjoiningContent Request_Layout = 7
+)
+
+type Request_AdUnit int
+
+const (
+	Request_PaidSearchUnits            Request_AdUnit = 1
+	Request_RecommendationWidgets      Request_AdUnit = 2
+	Request_PromotedListings           Request_AdUnit = 3
+	Request_InAdWithNativeElementUnits Request_AdUnit = 4
+	Request_Custom                     Request_AdUnit = 5
+)
+
+type Request_Context int
+
+const (
+	Request_Content Request_Context = 1 // newsfeed, article, image gallery, video gallery
+	Request_Social  Request_Context = 2 // social network feed, email, chat
+	Request_Product Request_Context = 3 // product listings, details, recommendations, reviews
+)
+
+type Request_ContextSubType int
+
+const (
+	Request_General        Request_ContextSubType = 10
+	Request_Article        Request_ContextSubType = 11
+	Request_Video          Request_ContextSubType = 12
+	Request_Audio          Request_ContextSubType = 13
+	Request_Image          Request_ContextSubType = 14
+	Request_UserGenerated  Request_ContextSubType = 15
+	Request_SubSocial      Request_ContextSubType = 20
+	Request_Email          Request_ContextSubType = 21
+	Request_Chat           Request_ContextSubType = 22
+	Request_Selling        Request_ContextSubType = 30
+	Request_AppStore       Request_ContextSubType = 31
+	Request_ProductReviews Request_ContextSubType = 32
+)
+
+type Request_PlacementType int
+
+const (
+	Request_InFeed         Request_PlacementType = 1 // In the feed of content - for example as an item inside the organic feed/grid/listing/carousel
+	Request_Atomic         Request_PlacementType = 2 // In the atomic unit of the content - IE in the article page or single image page
+	Request_Outside        Request_PlacementType = 3 // Outside the core content - for example in the ads section on the right rail, as a banner-style placement near the content, etc.
+	Request_Recommendation Request_PlacementType = 4 // Recommendation widget, most commonly presented below the article content
+)
+
+// This object represents a native type impression. Native ad units are intended to blend seamlessly into
+// the surrounding content (e.g., a sponsored Twitter or Facebook post). As such, the response must be
+// well-structured to afford the publisher fine-grained control over rendering.
+// The presence of a Native as a subordinate of the Imp object indicates that this impression is offered as
+// a native type impression. At the publisher’s discretion, that same impression may also be offered as
+// banner and/or video by also including as Imp subordinates the Banner and/or Video objects,
+// respectively. However, any given bid for the impression must conform to one of the offered types.
+type Request struct {
+	Ver            string                 `json:"ver,omitempty"`            // Version of the Native Markup
+	Layout         Request_Layout         `json:"layout,omitempty"`         // DEPRECATED The Layout ID of the native ad
+	AdUnit         Request_AdUnit         `json:"adunit,omitempty"`         // DEPRECATED The Ad unit ID of the native ad
+	Context        Request_Context        `json:"context,omitempty`         // The context in which the ad appears
+	ContextSubType Request_ContextSubType `json:"contextsubtype,omitempty"` // A more detailed context in which the ad appears
+	PlacementType  Request_PlacementType  `json:"plcmttype,omitempty"`      // The design/format/layout of the ad unit being offered
+	PlacementCount int                    `json:"plcmtcnt,omitempty"`       // The number of identical placements in this Layout
+	Sequence       int                    `json:"seq,omitempty"`            // 0 for the first ad, 1 for the second ad, and so on
+	Assets         []Asset                `json:"assets"`                   // An array of Asset Objects
+	Ext            json.RawMessage        `json:"ext,omitempty"`
+}

native/request/request_test.go

@@ -0,0 +1,43 @@
+package request
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Request", func() {
+	It("should parse correctly", func() {
+		Expect(fixture("testdata/request1.json")).To(Equal(Request{
+			Ver:            "1.1",
+			Context:        Request_Social,
+			ContextSubType: Request_SubSocial,
+			PlacementType:  Request_PlacementType(11),
+			PlacementCount: 1,
+			Sequence:       2,
+			Assets: []Asset{
+				{ID: 123, Required: 1, Title: &Title{Length: 140}},
+				{ID: 128, Image: &Image{Type: Image_Main, WidthMin: 836, HeightMin: 627, Width: 1000, Height: 800, Mimes: []string{"image/jpg"}}},
+				{ID: 126, Required: 1, Data: &Data{Type: Data_Sponsored, Length: 25}},
+				{ID: 127, Required: 1, Data: &Data{Type: Data_Desc, Length: 140}},
+				{ID: 4, Video: &Video{MinDuration: 15, MaxDuration: 30, Protocols: []int{2, 3}, Mimes: []string{"video/mp4"}}},
+			},
+		}))
+	})
+})
+
+func TestSuite(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "openrtb/native/request")
+}
+
+func fixture(path string) Request {
+	var subject Request
+	enc, err := ioutil.ReadFile(path)
+	Expect(err).ToNot(HaveOccurred())
+	Expect(json.Unmarshal(enc, &subject)).To(Succeed())
+	return subject
+}

native/request/testdata/request1.json

@@ -0,0 +1,55 @@
+{
+  "ver": "1.1",
+  "context": 2,
+  "contextsubtype": 20,
+  "plcmttype": 11,
+  "plcmtcnt": 1,
+  "seq": 2,
+  "assets": [
+    {
+      "id": 123,
+      "required": 1,
+      "title": {
+        "len": 140
+      }
+    },
+    {
+      "id": 128,
+      "required": 0,
+      "img": {
+        "w": 1000,
+        "h": 800,
+        "mimes": ["image/jpg"],
+        "wmin": 836,
+        "hmin": 627,
+        "type": 3
+      }
+    },
+    {
+      "id": 126,
+      "required": 1,
+      "data": {
+        "type": 1,
+        "len": 25
+      }
+    },
+    {
+      "id": 127,
+      "required": 1,
+      "data": {
+        "type": 2,
+        "len": 140
+      }
+    },
+    {
+      "id": 4,
+      "video": {
+        "linearity": 1,
+        "minduration": 15,
+        "maxduration": 30,
+        "protocols": [2, 3],
+        "mimes": ["video/mp4"]
+      }
+    }
+  ]
+}

native/request/title.go

@@ -0,0 +1,8 @@
+package request
+
+import "encoding/json"
+
+type Title struct {
+	Length int             `json:"len"` // Maximum length of the text in the title element
+	Ext    json.RawMessage `json:"ext,omitempty"`
+}

native/request/video.go

@@ -0,0 +1,12 @@
+package request
+
+import "encoding/json"
+
+// TODO unclear if its the same as imp.video https://github.com/openrtb/OpenRTB/issues/26
+type Video struct {
+	Mimes       []string        `json:"mimes,omitempty"`       // Whitelist of content MIME types supported
+	MinDuration int             `json:"minduration,omitempty"` // Minimum video ad duration in seconds
+	MaxDuration int             `json:"maxduration,omitempty"` // Maximum video ad duration in seconds
+	Protocols   []int           `json:"protocols,omitempty"`   // Video bid response protocols
+	Ext         json.RawMessage `json:"ext,omitempty"`
+}

native/response/asset.go

@@ -0,0 +1,20 @@
+package response
+
+import "encoding/json"
+
+// Corresponds to the Asset Object in the request. The main container object for
+// each asset requested or supported by Exchange on behalf of the rendering
+// client. Any object that is required is to be flagged as such. Only one of the
+// {title,img,video,data} objects should be present in each object. All others
+// should be null/absent. The id is to be unique within the AssetObject array so
+// that the response can be aligned.
+type Asset struct {
+	ID       int             `json:"id"`                 // Unique asset ID, assigned by exchange, must match one of the asset IDs in request
+	Required int             `json:"required,omitempty"` // Set to 1 if asset is required
+	Title    *Title          `json:"title,omitempty"`    // Title object for title assets
+	Image    *Image          `json:"img,omitempty"`      // Image object for image assets
+	Video    *Video          `json:"video,omitempty"`    // Video object for video assets
+	Data     *Data           `json:"data,omitempty"`     // Data object for brand name, description, ratings, prices etc.
+	Link     *Link           `json:"link,omitempty"`     // Link object for call to actions. The link object applies if the asset item is activated (clicked)
+	Ext      json.RawMessage `json:"ext,omitempty"`
+}

native/response/data.go

@@ -0,0 +1,9 @@
+package response
+
+import "encoding/json"
+
+type Data struct {
+	Label string          `json:"label,omitempty"` // The optional formatted string name of the data type to be displayed
+	Value string          `json:"value"`           // The formatted string of data to be displayed. Can contain a formatted value such as “5 stars” or “$10” or “3.4 stars out of 5”
+	Ext   json.RawMessage `json:"ext,omitempty"`
+}