Main OpenRTB 2.6 Changes

Author: SyntaxNode

README.md

@@ -2,7 +2,7 @@
 
 [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/2016/07/OpenRTB-API-Specification-Version-2-5-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)

native1/protocol.go

@@ -1,6 +1,6 @@
 package native1
 
-// 5.8 Protocols (from OpenRTB spec 2.5)
+// 5.8 Protocols (from AdCOM spec 1.0)
 //
 // Options for the various bid response protocols that could be supported by an exchange.
 //
@@ -18,4 +18,8 @@ const (
 	ProtocolVAST40Wrapper  Protocol = 8  // VAST 4.0 Wrapper
 	ProtocolDAAST10        Protocol = 9  // DAAST 1.0
 	ProtocolDAAST10Wrapper Protocol = 10 // DAAST 1.0 Wrapper
+	ProtocolVAST41         Protocol = 11 // VAST 4.1
+	ProtocolVAST41Wrapper  Protocol = 11 // VAST 4.1 Wrapper
+	ProtocolVAST42         Protocol = 11 // VAST 4.2
+	ProtocolVAST42Wrapper  Protocol = 11 // VAST 4.2 Wrapper
 )

openrtb2/README.md

@@ -1,3 +1,3 @@
 # openrtb2 [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/openrtb2?status.svg)](https://pkg.go.dev/github.com/mxmCherry/openrtb/v16/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) types for [Go programming language](https://golang.org/)
+[OpenRTB](https://iabtechlab.com/standards/openrtb/) [2.6](https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf) types for [Go programming language](https://golang.org/)

openrtb2/ad_position.go

@@ -30,10 +30,12 @@ type App struct {
 	// Type:
 	//   string
 	// Description:
-	//   A platform-specific application identifier intended to be
-	//   unique to the app and independent of the exchange. On
-	//   Android, this should be a bundle or package name (e.g.,
-	//   com.foo.mygame). On iOS, it is typically a numeric ID.
+	//   The store ID of the app in an app store. See OTT/CTV Store
+	//   Assigned App Identification Guidelines for more details about
+	//   expected strings for CTV app stores. For mobile apps in
+	//   Google Play Store, these should be bundle or package names
+	//   (e.g. com.foo.mygame). For apps in Apple App Store, these
+	//   should be a numeric ID.
 	Bundle string `json:"bundle,omitempty"`
 
 	// Attribute:
@@ -52,12 +54,23 @@ type App struct {
 	//   App store URL for an installed app; for IQG 2.1 compliance.
 	StoreURL string `json:"storeurl,omitempty"`
 
+	// Attribute:
+	//   cattax
+	// Type:
+	//   integer; default 1
+	// Description:
+	//   The taxonomy in use. Refer to the AdCOM list List: Category
+	//   Taxonomies for values.
+	CatTax int64 `json:"cattax,omitempty"`
+
 	// Attribute:
 	//   cat
 	// Type:
 	//   string array
 	// Description:
-	//   Array of IAB content categories of the app. Refer to List 5.1
+	//   Array of IAB content categories of the app. The taxonomy to be
+	//   used is defined by the cattax field. If no cattax field is supplied
+	//   IAB Content Category Taxonomy 1.0 is assumed.
 	Cat []string `json:"cat,omitempty"`
 
 	// Attribute:
@@ -66,7 +79,8 @@ type App struct {
 	//   string array
 	// Description:
 	//   Array of IAB content categories that describe the current
-	//   section of the app. Refer to List 5.1.
+	//   section of the app.
+	//   The taxonomy to be used is defined by the cattax field.
 	SectionCat []string `json:"sectioncat,omitempty"`
 
 	// Attribute:
@@ -75,7 +89,8 @@ type App struct {
 	//   string array
 	// Description:
 	//   Array of IAB content categories that describe the current page
-	//   or view of the app. Refer to List 5.1.
+	//   or view of the app.
+	//   The taxonomy to be used is defined by the cattax field.
 	PageCat []string `json:"pagecat,omitempty"`
 
 	// Attribute:
@@ -126,6 +141,15 @@ type App struct {
 	//   Comma separated list of keywords about the app.
 	Keywords string `json:"keywords,omitempty"`
 
+	// Attribute:
+	//   kwarray
+	// Type:
+	//   string
+	// Description:
+	//   Array of keywords about the site. Only one of ‘keywords’ or
+	//   ‘kwarray’ may be present.
+	KwArray []string `json:"kwarray,omitempty"`
+
 	// Attribute:
 	//   ext
 	// Type:

openrtb2/api_framework.go

@@ -25,7 +25,7 @@ type Audio struct {
 	// Attribute:
 	//   minduration
 	// Type:
-	//   integer; recommended
+	//   integer; default 0; recommended
 	// Description:
 	//   Minimum audio ad duration in seconds.
 	MinDuration int64 `json:"minduration,omitempty"`
@@ -38,40 +38,112 @@ type Audio struct {
 	//   Maximum audio ad duration in seconds.
 	MaxDuration int64 `json:"maxduration,omitempty"`
 
+	// Attribute:
+	//   poddur
+	// Type:
+	//   integer; recommended
+	// Description:
+	//   Indicates the total amount of time that advertisers may fill for a
+	//   "dynamic" audio ad pod, or the dynamic portion of a "hybrid"
+	//   ad pod. This field is required only for the dynamic portion(s) of
+	//   audio ad pods. This field refers to the length of the entire ad
+	//   break, whereas minduration/maxduration/rqddurs are
+	//   constraints relating to the slots that make up the pod.
+	PodDur int64 `json:"poddur,omitempty"`
+
 	// Attribute:
 	//   protocols
 	// Type:
 	//   integer array; recommended
 	// Description:
-	//   Array of supported audio protocols. Refer to List 5.8.
-	Protocols []Protocol `json:"protocols,omitempty"`
+	//   Array of supported audio protocols. Refer to List: Creative
+	//   Subtypes - Audio/Video in AdCOM 1.0.
+	Protocols []int8 `json:"protocols,omitempty"`
 
 	// Attribute:
 	//   startdelay
 	// Type:
 	//   integer; recommended
 	// Description:
 	//   Indicates the start delay in seconds for pre-roll, mid-roll, or
-	//   post-roll ad placements. Refer to List 5.12.
-	StartDelay *StartDelay `json:"startdelay,omitempty"`
+	//   post-roll ad placements. Refer to List: Start Delay Modes in
+	//   AdCOM 1.0.
+	StartDelay *int8 `json:"startdelay,omitempty"`
 
 	// Attribute:
-	//   sequence
+	//   rqddurs
+	// Type:
+	//   integer array
+	// Description:
+	//   Precise acceptable durations for audio creatives in seconds. This
+	//   field specifically targets the live audio/radio use case where
+	//   non-exact ad durations would result in undesirable ‘dead air’.
+	//   This field is mutually exclusive with minduration and
+	//   maxduration; if rqddurs is specified, minduration and
+	//   maxduration must not be specified and vice versa.
+	RqdDurs []int64 `json:"rqddurs,omitempty"`
+
+	// Attribute:
+	//   podid
 	// Type:
 	//   integer
 	// Description:
+	//   Unique identifier indicating that an impression opportunity
+	//   belongs to an audioad pod. If multiple impression opportunities
+	//   within a bid request share the same podid, this indicates that
+	//   those impression opportunities belong to the same audio ad
+	//   pod.
+	PodID int64 `json:"podid,omitempty"`
+
+	// Attribute:
+	//   podid
+	// Type:
+	//   integer; default 0
+	// Description:
+	//   The sequence (position) of the audio ad pod within a
+	//   content stream. Refer to List: Pod Sequence in AdCOM 1.0
+	//   for guidance on the use of this field.
+	PodSeq int8 `json:"podseq,omitempty"`
+
+	// Attribute:
+	//   sequence
+	// Type:
+	//   integer; default 0; DEPRECATED
+	// Description:
 	//   If multiple ad impressions are offered in the same bid request,
 	//   the sequence number will allow for the coordinated delivery
 	//   of multiple creatives.
 	Sequence int64 `json:"sequence,omitempty"`
 
+	// Attribute:
+	//   slotinpod
+	// Type:
+	//   integer; default 0
+	// Description:
+	//   For audio ad pods, this value indicates that the seller can
+	//   guarantee delivery against the indicated sequence. Refer to
+	//   List: Slot Position in Pod in AdCOM 1.0 for guidance on the
+	//   use of this field.
+	SlotInPod *int8 `json:"slotinpod,omitempty"`
+
+	// Attribute:
+	//   mincpmpersec
+	// Type:
+	//   float
+	// Description:
+	//   Minimum CPM per second. This is a price floor for the
+	//   "dynamic" portion of an audio ad pod, relative to the duration
+	//   of bids an advertiser may submit.
+	MinCPMPerSec float64 `json:"mincpmpersec,omitempty"`
+
 	// Attribute:
 	//   battr
 	// Type:
 	//   integer array
 	// Description:
-	//   Blocked creative attributes. Refer to List 5.3.
-	BAttr []CreativeAttribute `json:"battr,omitempty"`
+	//   Blocked creative attributes. Refer to List: Creative Attributes in
+	//   AdCOM 1.0.
+	BAttr []int64 `json:"battr,omitempty"`
 
 	// Attribute:
 	//   maxextended
@@ -107,8 +179,9 @@ type Audio struct {
 	//   integer array
 	// Description:
 	//   Supported delivery methods (e.g., streaming, progressive). If
-	//   none specified, assume all are supported. Refer to List 5.15.
-	Delivery []ContentDeliveryMethod `json:"delivery,omitempty"`
+	//   none specified, assume all are supported. Refer to List: Delivery
+	//   Methods in AdCOM 1.0.
+	Delivery []int8 `json:"delivery,omitempty"`
 
 	// Attribute:
 	//   companionad
@@ -125,37 +198,35 @@ type Audio struct {
 	//   integer array
 	// Description:
 	//   List of supported API frameworks for this impression. Refer to
-	//   List 5.6. If an API is not explicitly listed, it is assumed not to be
-	//   supported.
-	API []APIFramework `json:"api,omitempty"`
+	//   List: API Frameworks in AdCOM 1.0. If an API is not explicitly
+	//   listed, it is assumed not to be supported.
+	API []int64 `json:"api,omitempty"`
 
 	// Attribute:
 	//   companiontype
 	// Type:
 	//   integer array
 	// Description:
-	//   Supported DAAST companion ad types. Refer to List 5.14.
-	//   Recommended if companion Banner objects are included via
-	//   the companionad array.
-	CompanionType []CompanionType `json:"companiontype,omitempty"`
+	//   Supported companion ad types. Refer to List: Companion
+	//   Types in AdCOM 1.0. Recommended if companion Banner
+	//   objects are included via the companionad array.
+	CompanionType []int8 `json:"companiontype,omitempty"`
 
 	// Attribute:
 	//   maxseq
 	// Type:
 	//   integer
 	// Description:
 	//   The maximum number of ads that can be played in an ad pod.
-	//   OpenRTB API Specification Version 2.5 IAB Technology Lab
-	//   www.iab.com/openrtb Page 18
 	MaxSeq int64 `json:"maxseq,omitempty"`
 
 	// Attribute:
 	//   feed
 	// Type:
 	//   integer
 	// Description:
-	//   Type of audio feed. Refer to List 5.16.
-	Feed FeedType `json:"feed,omitempty"`
+	//   Type of audio feed. Refer to List: Feed Types in AdCOM 1.0.
+	Feed int8 `json:"feed,omitempty"`
 
 	// Attribute:
 	//   stitched
@@ -171,8 +242,9 @@ type Audio struct {
 	// Type:
 	//   integer
 	// Description:
-	//   Volume normalization mode. Refer to List 5.17.
-	NVol *VolumeNormalizationMode `json:"nvol,omitempty"`
+	//   Volume normalization mode. Refer to List: Volume
+	//   Normalization Modes in AdCOM 1.0.
+	NVol int8 `json:"nvol,omitempty"`
 
 	// Attribute:
 	//   ext