OpenRTB 2.6

README.md

@@ -1,8 +1,8 @@
-# openrtb [![Go Reference](https://pkg.go.dev/badge/github.com/mxmCherry/openrtb/v15.svg)](https://pkg.go.dev/github.com/mxmCherry/openrtb/v15) [![Test](https://github.com/mxmCherry/openrtb/actions/workflows/test.yml/badge.svg)](https://github.com/mxmCherry/openrtb/actions/workflows/test.yml)
+# openrtb [![Go Reference](https://pkg.go.dev/badge/github.com/mxmCherry/openrtb/v16.svg)](https://pkg.go.dev/github.com/mxmCherry/openrtb/v16) [![Test](https://github.com/mxmCherry/openrtb/actions/workflows/test.yml/badge.svg)](https://github.com/mxmCherry/openrtb/actions/workflows/test.yml)
 
 [OpenRTB](https://iabtechlab.com/standards/openrtb/), [AdCOM](https://iabtechlab.com/standards/openmedia) and [OpenRTB Dynamic Native Ads](https://iabtechlab.com/standards/openrtb-native/) types for [Go programming language](https://golang.org/)
 
-- [openrtb2](openrtb2/) - [OpenRTB](https://iabtechlab.com/standards/openrtb/) [2.5](https://iabtechlab.com/wp-content/uploads/2016/07/OpenRTB-API-Specification-Version-2-5-FINAL.pdf)
+- [openrtb2](openrtb2/) - [OpenRTB](https://iabtechlab.com/standards/openrtb/) [2.6](https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf)
 - [openrtb3](openrtb3/) - [OpenRTB](https://iabtechlab.com/standards/openrtb/) [3.0](https://github.com/InteractiveAdvertisingBureau/openrtb)
 - [adcom1](adcom1/) - [AdCOM](https://iabtechlab.com/standards/openmedia/) [1.0](https://github.com/InteractiveAdvertisingBureau/AdCOM)
 - [native1](native1/) - [OpenRTB Dynamic Native Ads API](https://iabtechlab.com/standards/openrtb-native/) [1.2](https://iabtechlab.com/wp-content/uploads/2016/07/OpenRTB-Native-Ads-Specification-Final-1.2.pdf)
@@ -16,19 +16,19 @@ Also, [test/matcher library](https://github.com/onsi/gomega) relies on newer Go
 # Using
 
 ```bash
-go get -u "github.com/mxmCherry/openrtb/v15/..."
+go get -u "github.com/mxmCherry/openrtb/v16/..."
 ```
 
 ```go
 import (
-	openrtb2 "github.com/mxmCherry/openrtb/v15/openrtb2"
+	openrtb2 "github.com/mxmCherry/openrtb/v16/openrtb2"
 
-	openrtb3 "github.com/mxmCherry/openrtb/v15/openrtb3"
-	adcom1 "github.com/mxmCherry/openrtb/v15/adcom1"
+	openrtb3 "github.com/mxmCherry/openrtb/v16/openrtb3"
+	adcom1 "github.com/mxmCherry/openrtb/v16/adcom1"
 
-	native1 "github.com/mxmCherry/openrtb/v15/native1"
-	nreq "github.com/mxmCherry/openrtb/v15/native1/request"
-	nres "github.com/mxmCherry/openrtb/v15/native1/response"
+	native1 "github.com/mxmCherry/openrtb/v16/native1"
+	nreq "github.com/mxmCherry/openrtb/v16/native1/request"
+	nres "github.com/mxmCherry/openrtb/v16/native1/response"
 )
 ```
 
@@ -41,6 +41,7 @@ Master always contains latest code, so better use some package manager to vendor
 - [UpperCamelCase](http://en.wikipedia.org/wiki/CamelCase)
 - Capitalized abbreviations (e.g., `AT`, `COPPA`, `PMP` etc.)
 - Capitalized `ID` keys
+- Enum items with versions should include minor/patch zeros, i.e. "Foo 1.0" -> `Foo10` (and not just `Foo1`), "Foo 1.1" -> `Foo11` etc
 
 ## Types
 - Key types should be chosen according to OpenRTB specification (attribute types)
@@ -64,7 +65,7 @@ Pointer | Omitempty | When to use
 
 Using both pointer and `omitempty` is mostly just to save traffic / generate more "canonical" (strict) JSON.
 
-## Documentation ([pkg.go.dev](https://pkg.go.dev/github.com/mxmCherry/openrtb/v15))
+## Documentation ([pkg.go.dev](https://pkg.go.dev/github.com/mxmCherry/openrtb/v16))
 - [Godoc: documenting Go code](http://blog.golang.org/godoc-documenting-go-code)
 - Each entity (type, struct key or constant) should be documented
 - Comments for entities should be copy-pasted "as-is" from OpenRTB specification (except section 5 - replace "table" with "list" there; ideally, each sentence must be on a new line)

adcom1/README.md

@@ -1,3 +1,3 @@
-# adcom1 [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/adcom1?status.svg)](https://pkg.go.dev/github.com/mxmCherry/openrtb/v15/adcom1)
+# adcom1 [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/adcom1?status.svg)](https://pkg.go.dev/github.com/mxmCherry/openrtb/v16/adcom1)
 
 [AdCOM](https://iabtechlab.com/standards/openmedia/) [1.0](https://github.com/InteractiveAdvertisingBureau/AdCOM) types for [Go programming language](https://golang.org/)

adcom1/adcom1_test.go

@@ -8,7 +8,7 @@ import (
 	. "github.com/onsi/ginkgo/extensions/table"
 	. "github.com/onsi/gomega"
 
-	. "github.com/mxmCherry/openrtb/v15/adcom1"
+	. "github.com/mxmCherry/openrtb/v16/adcom1"
 )
 
 var _ = DescribeTable(

adcom1/agent_type.go

@@ -0,0 +1,13 @@
+package adcom1
+
+// AgentType identifies the user agent types a user identifier is from.
+type AgentType int64
+
+// Agent types describing where the user agent is from.
+//
+// Values of 500+ hold vendor-specific codes.
+const (
+	AgentTypeWeb    AgentType = 1 // An ID which is tied to a specific web browser or device (cookie-based, probabilistic, or other).
+	AgentTypeApp    AgentType = 2 // In-app impressions, which will typically contain a type of device ID (or rather, the privacy-compliant versions of device IDs).
+	AgentTypePerson AgentType = 3 // A person-based ID, i.e., that is the same across devices.
+)

adcom1/api_framework.go

@@ -1,17 +1,19 @@
 package adcom1
 
 // APIFramework represents API frameworks either supported by a placement or required by an ad.
-type APIFramework int
+type APIFramework int64
 
 // API frameworks either supported by a placement or required by an ad.
 //
 // Values of 500+ hold vendor-specific codes.
 const (
-	APIVPAID1 APIFramework = 1 // VPAID 1.0
-	APIVPAID2 APIFramework = 2 // VPAID 2.0
-	APIMRAID1 APIFramework = 3 // MRAID 1.0
-	APIORMMA  APIFramework = 4 // ORMMA
-	APIMRAID2 APIFramework = 5 // MRAID 2.0
-	APIMRAID3 APIFramework = 6 // MRAID 3.0
-	APIOMID1  APIFramework = 7 // OMID 1.0
+	APIVPAID10 APIFramework = 1 // VPAID 1.0
+	APIVPAID20 APIFramework = 2 // VPAID 2.0
+	APIMRAID10 APIFramework = 3 // MRAID 1.0
+	APIORMMA   APIFramework = 4 // ORMMA
+	APIMRAID20 APIFramework = 5 // MRAID 2.0
+	APIMRAID30 APIFramework = 6 // MRAID 3.0
+	APIOMID10  APIFramework = 7 // OMID 1.0
+	APISIMID10 APIFramework = 8 // SIMID 1.0
+	APISIMID11 APIFramework = 9 // SIMID 1.1
 )

adcom1/app.go

@@ -59,11 +59,21 @@ type App struct {
 	// Attribute:
 	//   keywords
 	// Type:
-	//   string
+	//   string; DEPRECATED
 	// Definition:
-	//   Comma separated list of keywords about the app.
+	//   Comma-separated list of keywords about the app.
+	//   Only one of 'keywords' or 'kwarray' may be present.
+	//   NOTE: this field is deprecated, use 'kwarray' instead.
 	Keywords string `json:"keywords,omitempty"`
 
+	// Attribute:
+	//   kwarray
+	// Type:
+	//   string array
+	// Definition:
+	//   Array of keywords about the site. Only one of 'keywords' or 'kwarray' may be present.
+	KwArray []string `json:"kwarray,omitempty"`
+
 	// Attribute:
 	//   bundle
 	// Type:

adcom1/audio_placement.go

@@ -11,7 +11,7 @@ type AudioPlacement struct {
 	// Definition:
 	//   Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll placements.
 	//   For additional generic values, refer to List: Start Delay Modes.
-	Delay int64 `json:"delay,omitempty"`
+	Delay StartDelayMode `json:"delay,omitempty"`
 
 	// Attribute:
 	//   skip
@@ -117,6 +117,17 @@ type AudioPlacement struct {
 	//   Maximum creative duration in seconds.
 	MaxDur int64 `json:"maxdur,omitempty"`
 
+	// Attribute:
+	//   rqddurs
+	// Type:
+	//   integer array
+	// Definition:
+	//   Precise acceptable durations for video creatives in seconds. This field specifically
+	//   targets the Live TV use case where non-exact ad durations would result in undesirable
+	//   'dead air'. This field is mutually exclusive with mindur and maxdur; if rqddurs is
+	//   specified, mindur and maxdur must not be specified and vice versa.
+	RqdDurs []int64 `json:"rqddurs,omitempty"`
+
 	// Attribute:
 	//   maxext
 	// Type:
@@ -162,6 +173,57 @@ type AudioPlacement struct {
 	//   The maximum number of ads that can be played in an ad pod.
 	MaxSeq int64 `json:"maxseq,omitempty"`
 
+	// Attribute:
+	//   poddur
+	// Type:
+	//   integer
+	// Definition:
+	//   Indicates the total amount of time in seconds that advertisers may fill
+	//   for a “dynamic” video ad pod, or the dynamic portion of a “hybrid” ad pod.
+	//   This field is required only for the dynamic portion(s) of video ad pods.
+	//   This field refers to the length of the entire ad break, whereas
+	//   mindur/maxdur/rqddurs are constraints relating to the slots that make up the pod.
+	PodDur int64 `json:"poddur,omitempty"`
+
+	// Attribute:
+	//   podid
+	// Type:
+	//   integer
+	// Definition:
+	//   Unique identifier indicating that an impression opportunity belongs to a
+	//   video ad pod. If multiple impression opportunities within a bid request
+	//   share the same podid, this indicates that those impression opportunities
+	//   belong to the same video ad pod.
+	PodID int64 `json:"podid,omitempty"`
+
+	// Attribute:
+	//   podseq
+	// Type:
+	//   integer; default 0
+	// Definition:
+	//   The sequence (position) of the video ad pod within a content stream.
+	//   Refer to List: Pod Sequence for guidance on the use of this field.
+	PodSeq PodSequence `json:"podseq,omitempty"`
+
+	// Attribute:
+	//   slotinpod
+	// Type:
+	//   integer; default 0
+	// Definition:
+	//   For video ad pods, this value indicates that the seller can guarantee delivery
+	//   against the indicated slot position in the pod.
+	//   Refer to List: Slot Position in Pod for guidance on the use of this field.
+	SlotInPod SlotPositionInPod `json:"slotinpod,omitempty"`
+
+	// Attribute:
+	//   mincpmpersec
+	// Type:
+	//   float
+	// Definition:
+	//   Minimum CPM per second. This is a price floor for the “dynamic” portion of a
+	//   video ad pod, relative to the duration of bids an advertiser may submit.
+	MinCPMPerSec float64 `json:"mincpmpersec,omitempty"`
+
 	// Attribute:
 	//   comp
 	// Type:
@@ -180,6 +242,16 @@ type AudioPlacement struct {
 	//   Refer to List: Companion Types.
 	CompType []CompanionType `json:"comptype,omitempty"`
 
+	// Attribute:
+	//   overlayexpdir
+	// Type:
+	//   integer array
+	// Definition:
+	//   Directions in which the creative (video overlay) is permitted to expand.
+	//   This is primarily used for non-linear videos.
+	//   Refer to List: Expandable Directions.
+	OverlayExpDir []ExpandableDirection `json:"overlayexpdir,omitempty"`
+
 	// Attribute:
 	//   ext
 	// Type:

adcom1/brand_version.go

@@ -0,0 +1,32 @@
+package adcom1
+
+import "encoding/json"
+
+// BrandVersion provides further identification based on User-Agent Client Hints.
+// The BrandVersion object is used to identify a device’s browser or similar software component, and the user agent’s execution platform or operating system.
+type BrandVersion struct {
+	// Attribute:
+	//   brand
+	// Type:
+	//   string; recommended
+	// Definition:
+	//   A brand identifier, for example, “Chrome” or “Windows”.
+	//   The value may be sourced from the User-Agent Client Hints headers, representing either the user agent brand (from the Sec-CH-UA-Full-Version header) or the platform brand (from the Sec-CH-UA-Platform header).
+	Brand string `json:"brand,omitempty"`
+
+	// Attribute:
+	//   version
+	// Type:
+	//   string array
+	// Definition:
+	//   A sequence of version components, in descending hierarchical order (major, minor, micro, …).
+	Version []string `json:"version,omitempty"`
+
+	// Attribute:
+	//   ext
+	// Type:
+	//   object
+	// Definition:
+	//   Optional vendor-specific extensions.
+	Ext json.RawMessage `json:"ext,omitempty"`
+}

adcom1/category_taxonomy.go

@@ -1,13 +1,16 @@
 package adcom1
 
 // CategoryTaxonomy identifies the taxonomy in effect when content categories are listed.
-type CategoryTaxonomy int
+type CategoryTaxonomy int64
 
 // CategoryTaxonomy options.
 //
 // Values of 500+ hold vendor-specific codes.
 const (
-	CatTaxIABContent1 CategoryTaxonomy = 1 // 1	IAB Content Category Taxonomy 1.0.
-	CatTaxIABContent2 CategoryTaxonomy = 2 // 2	IAB Content Category Taxonomy 2.0: www.iab.com/guidelines/taxonomy
-	CatTaxIABProduct1 CategoryTaxonomy = 3 // 3	IAB Ad Product Taxonomy 1.0.
+	CatTaxIABContent10  CategoryTaxonomy = 1 // 1	IAB Content Category Taxonomy 1.0.
+	CatTaxIABContent20  CategoryTaxonomy = 2 // 2	IAB Content Category Taxonomy 2.0: www.iab.com/guidelines/taxonomy
+	CatTaxIABProduct10  CategoryTaxonomy = 3 // 3	IAB Ad Product Taxonomy 1.0.
+	CatTaxIABAudience11 CategoryTaxonomy = 4 // 4	IAB Audience Taxonomy 1.1.
+	CatTaxIABContent21  CategoryTaxonomy = 5 // 5	IAB Content Category Taxonomy 2.1.
+	CatTaxIABContent22  CategoryTaxonomy = 6 // 6	IAB Content Category Taxonomy 2.2
 )

adcom1/channel.go

@@ -0,0 +1,43 @@
+package adcom1
+
+import "encoding/json"
+
+// Channel describes the channel an ad will be displayed on.
+// A Channel is defined as the entity that curates a content library, or stream within a brand name for viewers.
+// Examples are specific view selectable ‘channels’ within linear and streaming television (MTV, HGTV, CNN, BBC One, etc) or a specific stream of audio content commonly called ‘stations.’
+// Name is human-readable field while domain and id can be used for reporting and targeting purposes.
+type Channel struct {
+	// Attribute:
+	//   id
+	// Type:
+	//   string
+	// Definition:
+	//   A unique identifier assigned by the publisher.
+	//   This may not be a unique identifier across all supply sources.
+	ID string `json:"id,omitempty"`
+
+	// Attribute:
+	//   name
+	// Type:
+	//   string
+	// Definition:
+	//   Channel the content is on (e.g., a local channel like "WABC-TV").
+	Name string `json:"name,omitempty"`
+
+	// Attribute:
+	//   domain
+	// Type:
+	//   string
+	// Definition:
+	//   The primary domain of the channel (e.g., “abc7ny.com” in the case of the local channel WABC-TV).
+	//   It is recommended to include the top private domain (PSL+1) for DSP targeting normalization purposes.
+	Domain string `json:"domain,omitempty"`
+
+	// Attribute:
+	//   ext
+	// Type:
+	//   object
+	// Definition:
+	//   Optional vendor-specific extensions.
+	Ext json.RawMessage `json:"ext,omitempty"`
+}

adcom1/content.go

@@ -153,11 +153,21 @@ type Content struct {
 	// Attribute:
 	//   keywords
 	// Type:
-	//   string
+	//   string; DEPRECATED
 	// Definition:
-	//   Comma separated list of keywords describing the content.
+	//   Comma-separated list of keywords describing the content.
+	//   Only one of 'keywords' or 'kwarray' may be present.
+	//   NOTE: this field is deprecated, use 'kwarray' instead.
 	Keywords string `json:"keywords,omitempty"`
 
+	// Attribute:
+	//   kwarray
+	// Type:
+	//   string array
+	// Definition:
+	//   Array of keywords about the site. Only one of 'keywords' or 'kwarray' may be present.
+	KwArray []string `json:"kwarray,omitempty"`
+
 	// Attribute:
 	//   live
 	// Type:
@@ -207,6 +217,24 @@ type Content struct {
 	//   Refer to Object: Producer.
 	Producer *Producer `json:"producer,omitempty"`
 
+	// Attribute:
+	//   network
+	// Type:
+	//   object
+	// Definition:
+	//   Details about the network.
+	//   Refer to Object: Network.
+	Network *Network `json:"network,omitempty"`
+
+	// Attribute:
+	//   channel
+	// Type:
+	//   object
+	// Definition:
+	//   Details about the channel.
+	//   Refer to Object: Channel.
+	Channel *Channel `json:"channel,omitempty"`
+
 	// Attribute:
 	//   data
 	// Type:

adcom1/creative_attribute.go

@@ -1,7 +1,7 @@
 package adcom1
 
 // CreativeAttribute specifies a standard list of creative attributes that can describe an actual ad or restrictions relative to a given placement.
-type CreativeAttribute int
+type CreativeAttribute int64
 
 // Standard list of creative attributes that can describe an actual ad or restrictions relative to a given placement.
 //