move everything from root package to openrtb2/native1 subpackages

This commit is contained in:
Max Cherry
2018-12-28 13:58:41 +02:00
parent 39d0e974b2
commit 1459501aaf
112 changed files with 115 additions and 115 deletions
+1 -1
View File
@@ -1,4 +1,4 @@
# native [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/native?status.svg)](https://godoc.org/github.com/mxmCherry/openrtb/native)
# native1 [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/native?status.svg)](https://godoc.org/github.com/mxmCherry/openrtb/native)
[Go](https://golang.org/) implementation of [OpenRTB](https://www.iab.com/guidelines/real-time-bidding-rtb-project/) [Dynamic Native Ads API
Specification Version 1.2](https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) types/enums.
+1 -1
View File
@@ -1,4 +1,4 @@
package native
package native1
// 7.2 Native Ad Unit IDs in version 1.1.
// Deprecated/removed in version 1.2.
@@ -1,4 +1,4 @@
package native
package native1
// 7.2 Context Sub Type IDs
//
@@ -1,4 +1,4 @@
package native
package native1
// 7.1 Context Type IDs
//
@@ -1,4 +1,4 @@
package native
package native1
// 7.4 Data Asset Types
//
@@ -1,4 +1,4 @@
package native
package native1
// 7.7 Event Tracking Methods Table
type EventTrackingMethod int8
@@ -1,4 +1,4 @@
package native
package native1
// 7.6 Event Types Table
type EventType int8
@@ -1,4 +1,4 @@
package native
package native1
// 7.5 Image Asset Types
//
+1 -1
View File
@@ -1,4 +1,4 @@
package native
package native1
// 7.1 Native Layout IDs in version 1.1.
// Deprecated/removed in version 1.2.
+2 -2
View File
@@ -1,5 +1,5 @@
// Package native provides OpenRTB Dynamic Native Ads API Specification Version 1.2
// Package native1 provides OpenRTB Dynamic Native Ads API Specification Version 1.2
// section 7 Reference Lists/Enumerations types/constants:
// https://www.iab.com/guidelines/real-time-bidding-rtb-project/
// https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf
package native
package native1
@@ -1,4 +1,4 @@
package native
package native1
// 7.3 Placement Type IDs
//
+1 -1
View File
@@ -1,4 +1,4 @@
package native
package native1
// 5.8 Protocols (from OpenRTB spec 2.5)
//
@@ -1,4 +1,4 @@
# native/request [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/native/request?status.svg)](https://godoc.org/github.com/mxmCherry/openrtb/native/request)
# native1/request [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/native/request?status.svg)](https://godoc.org/github.com/mxmCherry/openrtb/native/request)
[Go](https://golang.org/) implementation of [OpenRTB](https://www.iab.com/guidelines/real-time-bidding-rtb-project/) [Dynamic Native Ads API
Specification Version 1.2](https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) section 4 Native Ad Request Markup Details types.
@@ -14,11 +14,11 @@ import "encoding/json"
// So if a request for a title object is sent with id 1, then the response containing the title should have an id of 1.
//
// Since version 1.1 of the spec, there are recommended sizes/lengths/etc with some of the asset types.
// The goal for asset requirements standardization is to facilitate adoption of native by DSPs by limiting the diverse types/sizes/requirements of assets they must have available to purchase a native ad impression.
// The goal for asset requirements standardization is to facilitate adoption of native1 by DSPs by limiting the diverse types/sizes/requirements of assets they must have available to purchase a native ad impression.
// While great diversity may exist in publishers, advertisers/DSPs can not be expected to provide infinite headline lengths, thumbnail aspect ratios, etc.
// While we have not gone as far as creating a single standard, we've honed in on a few options that cover the most common cases.
// SSPs can deviate from these standards, but should understand they may limit applicable DSP demand by doing so.
// DSPs should feel confident that if they support these standards they'll be able to access most native inventory.
// DSPs should feel confident that if they support these standards they'll be able to access most native1 inventory.
type Asset struct {
// Field:
// id
@@ -3,13 +3,13 @@ package request
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 4.6 Data Object
//
// The Data Object is to be used for all non-core elements of the native unit such as Brand Name, Ratings, Review Count, Stars, Download count, descriptions etc.
// It is also generic for future native elements not contemplated at the time of the writing of this document.
// The Data Object is to be used for all non-core elements of the native1 unit such as Brand Name, Ratings, Review Count, Stars, Download count, descriptions etc.
// It is also generic for future native1 elements not contemplated at the time of the writing of this document.
// In some cases, additional recommendations are also included in the Data Asset Types table.
type Data struct {
@@ -23,7 +23,7 @@ type Data struct {
// Type ID of the element supported by the publisher.
// The publisher can display this information in an appropriate format.
// See Data Asset Types table for commonly used examples.
Type native.DataAssetType `json:"type"`
Type native1.DataAssetType `json:"type"`
// Field:
// len
@@ -3,7 +3,7 @@ package request
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 4.7 Event Trackers Request Object
@@ -20,7 +20,7 @@ type EventTracker struct {
// Description:
// Type of event available for tracking.
// See Event Types table.
Event native.EventType `json:"event"`
Event native1.EventType `json:"event"`
// Field:
// methods
@@ -31,7 +31,7 @@ type EventTracker struct {
// Description:
// Array of the types of tracking available for the given event.
// See Event Tracking Methods table
Methods []native.EventTrackingMethod `json:"methods"`
Methods []native1.EventTrackingMethod `json:"methods"`
// Field:
// ext
@@ -3,7 +3,7 @@ package request
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 4.4 Image Object
@@ -22,7 +22,7 @@ type Image struct {
// Type ID of the image element supported by the publisher.
// The publisher can display this information in an appropriate format.
// See Table Image Asset Types.
Type native.ImageAssetType `json:"type,omitempty"`
Type native1.ImageAssetType `json:"type,omitempty"`
// Field:
// w
@@ -7,17 +7,17 @@ package request
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 4.1 Native Markup Request Object
//
// The Native Object defines the native advertising opportunity available for bid via this bid request.
// It will be included as a JSON-encoded string in the bid requests imp.native field or as a direct JSON object, depending on the choice of the exchange.
// The Native Object defines the native1 advertising opportunity available for bid via this bid request.
// It will be included as a JSON-encoded string in the bid requests imp.native1 field or as a direct JSON object, depending on the choice of the exchange.
// While OpenRTB 2.x officially supports only JSON-encoded strings, many exchanges have implemented a formal object.
// Check with your integration docs.
//
// Note: Prior to VERSION 1.1, the specification could be interpreted as requiring the native request to have a root node with a single field “native” that would contain the object above as its value.
// Note: Prior to VERSION 1.1, the specification could be interpreted as requiring the native1 request to have a root node with a single field “native” that would contain the object above as its value.
// The Native Markup Request Object specified above is now the root object.
type Request struct {
@@ -40,9 +40,9 @@ type Request struct {
// Type:
// integer
// Description:
// The Layout ID of the native ad unit.
// The Layout ID of the native1 ad unit.
// See the Table of Layout IDs below.
Layout native.Layout `json:"layout,omitempty"`
Layout native1.Layout `json:"layout,omitempty"`
// Field:
// adunit
@@ -51,9 +51,9 @@ type Request struct {
// Type:
// integer
// Description:
// The Ad unit ID of the native ad unit.
// The Ad unit ID of the native1 ad unit.
// See Table of Ad Unit IDs below for a list of supported core ad units.
AdUnit native.AdUnit `json:"adunit,omitempty"`
AdUnit native1.AdUnit `json:"adunit,omitempty"`
// Field:
// context
@@ -64,7 +64,7 @@ type Request struct {
// Description:
// The context in which the ad appears.
// See Table of Context IDs below for a list of supported context types.
Context native.ContextType `json:"context,omitempty"`
Context native1.ContextType `json:"context,omitempty"`
// Field:
// contextsubtype
@@ -75,7 +75,7 @@ type Request struct {
// Description:
// A more detailed context in which the ad appears.
// See Table of Context SubType IDs below for a list of supported context subtypes.
ContextSubType native.ContextSubType `json:"contextsubtype,omitempty"`
ContextSubType native1.ContextSubType `json:"contextsubtype,omitempty"`
// Field:
// plcmttype
@@ -86,7 +86,7 @@ type Request struct {
// Description:
// The design/format/layout of the ad unit being offered.
// See Table of Placement Type IDs below for a list of supported placement types.
PlcmtType native.PlacementType `json:"plcmttype,omitempty"`
PlcmtType native1.PlacementType `json:"plcmttype,omitempty"`
// Field:
// plcmtcnt
@@ -171,8 +171,8 @@ type Request struct {
// Default:
// 0
// Description:
// Set to 1 when the native ad supports buyer-specific privacy notice.
// Set to 0 (or field absent) when the native ad doesnt support custom privacy links or if support is unknown.
// Set to 1 when the native1 ad supports buyer-specific privacy notice.
// Set to 0 (or field absent) when the native1 ad doesnt support custom privacy links or if support is unknown.
Privacy int8 `json:"privacy,omitempty"`
// Field:
@@ -5,7 +5,7 @@ import (
"io/ioutil"
"path/filepath"
. "github.com/mxmCherry/openrtb/native/request"
. "github.com/mxmCherry/openrtb/native1/request"
. "github.com/onsi/ginkgo"
. "github.com/onsi/ginkgo/extensions/table"
@@ -3,7 +3,7 @@ package request
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 4.5 Video Object
@@ -23,7 +23,7 @@ type Video struct {
// Description:
// Content MIME types supported.
// Popular MIME types include,but are not limited to “video/x-mswmv” for Windows Media, and “video/x-flv” for Flash Video, or “video/mp4”.
// Note that native frequently does not support flash.
// Note that native1 frequently does not support flash.
MIMEs []string `json:"mimes"`
// Field:
@@ -55,7 +55,7 @@ type Video struct {
// Description:
// An array of video protocols the publisher can accept in the bid response.
// See OpenRTB Table Video Bid Response Protocols for a list of possible values.
Protocols []native.Protocol `json:"protocols"`
Protocols []native1.Protocol `json:"protocols"`
// Field:
// ext
@@ -1,4 +1,4 @@
# native/response [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/native/response?status.svg)](https://godoc.org/github.com/mxmCherry/openrtb/native/response)
# native1/response [![GoDoc](https://godoc.org/github.com/mxmCherry/openrtb/native/response?status.svg)](https://godoc.org/github.com/mxmCherry/openrtb/native/response)
[Go](https://golang.org/) implementation of [OpenRTB](https://www.iab.com/guidelines/real-time-bidding-rtb-project/) [Dynamic Native Ads API
Specification Version 1.2](https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) section 5 Native Ad Response Markup Details types.
@@ -3,14 +3,14 @@ package response
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 5.5 Object: Data
//
// Corresponds to the Data Object in the request, with the value filled in.
// The Data Object is to be used for all miscellaneous elements of the native unit such as Brand Name, Ratings, Review Count, Stars, Downloads, Price count etc.
// It is also generic for future native elements not contemplated at the time of the writing of this document.
// The Data Object is to be used for all miscellaneous elements of the native1 unit such as Brand Name, Ratings, Review Count, Stars, Downloads, Price count etc.
// It is also generic for future native1 elements not contemplated at the time of the writing of this document.
type Data struct {
// Field:
// type
@@ -21,7 +21,7 @@ type Data struct {
// Description:
// Required for assetsurl/dcourl responses, not required for embedded asset responses.
// The type of data element being submitted from the Data Asset Types table.
Type native.DataAssetType `json:"type,omitempty"`
Type native1.DataAssetType `json:"type,omitempty"`
// Field:
// len
@@ -3,7 +3,7 @@ package response
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 5.8 Event Tracker Response Object
@@ -21,7 +21,7 @@ type EventTracker struct {
// Description:
// Type of event to track.
// See Event Types table.
Event native.EventType `json:"event"`
Event native1.EventType `json:"event"`
// Field:
// method
@@ -32,7 +32,7 @@ type EventTracker struct {
// Description:
// Type of tracking requested
// See Event Tracking Methods table.
Method native.EventTrackingMethod `json:"method"`
Method native1.EventTrackingMethod `json:"method"`
// Field:
// url
@@ -3,7 +3,7 @@ package response
import (
"encoding/json"
"github.com/mxmCherry/openrtb/native"
"github.com/mxmCherry/openrtb/native1"
)
// 5.4 Object: Image
@@ -22,7 +22,7 @@ type Image struct {
// Description:
// Required for assetsurl or dcourl responses, not required for embedded asset responses.
// The type of image element being submitted from the Image Asset Types table.
Type native.ImageAssetType `json:"type,omitempty"`
Type native1.ImageAssetType `json:"type,omitempty"`
// Field:
// url
@@ -8,8 +8,8 @@ import "encoding/json"
// 5.1 Object: Response
//
// The native object is the top level JSON object which identifies a native response.
// Note: Prior to VERSION 1.1, the native responses root node was an object with a single field “native” that would contain the object above as its value.
// The native1 object is the top level JSON object which identifies a native response.
// Note: Prior to VERSION 1.1, the native1 responses root node was an object with a single field “native” that would contain the object above as its value.
// The Native Object specified above is now the root object.
//
// Note re: assetsurl format responses: In the case of assetsurl or dcourl (beta) bidding, since the ultimate buyer/creative engine cannot alter the assets response based on the details inside the assets request (as it does not receive said request), it is critical that all required assets are provided, and such communications will need to be handled offline for recommended/optional elements.
@@ -44,7 +44,7 @@ type Response struct {
// Type:
// object array
// Description:
// List of native ads assets.
// List of native1 ads assets.
// Required if no assetsurl.
// Recommended as fallback even if assetsurl is provided.
Assets []Asset `json:"assets,omitempty"`
@@ -70,7 +70,7 @@ type Response struct {
// string
// Description:
// URL where a dynamic creative specification may be found for populating this ad, per the Dynamic Content Ads Specification.
// Note this is a beta option as the interpretation of the Dynamic Content Ads Specification and how to assign those elements into a native ad is outside the scope of this spec and must be agreed offline between the parties or as may be specified in a future revision of the Dynamic Content Ads spec.
// Note this is a beta option as the interpretation of the Dynamic Content Ads Specification and how to assign those elements into a native1 ad is outside the scope of this spec and must be agreed offline between the parties or as may be specified in a future revision of the Dynamic Content Ads spec.
// Where present, overrides the asset object in the response.
DCOURL string `json:"dcourl,omitempty"`
@@ -5,7 +5,7 @@ import (
"io/ioutil"
"path/filepath"
. "github.com/mxmCherry/openrtb/native/response"
. "github.com/mxmCherry/openrtb/native1/response"
. "github.com/onsi/ginkgo"
. "github.com/onsi/ginkgo/extensions/table"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.4 Ad Position
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.6 API Frameworks
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.2 Banner Ad Types
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
@@ -1,11 +1,11 @@
package openrtb_test
package openrtb2_test
import (
"encoding/json"
"io/ioutil"
"path/filepath"
. "github.com/mxmCherry/openrtb"
. "github.com/mxmCherry/openrtb/openrtb2"
. "github.com/onsi/ginkgo"
. "github.com/onsi/ginkgo/extensions/table"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
@@ -1,11 +1,11 @@
package openrtb_test
package openrtb2_test
import (
"encoding/json"
"io/ioutil"
"path/filepath"
. "github.com/mxmCherry/openrtb"
. "github.com/mxmCherry/openrtb/openrtb2"
. "github.com/onsi/ginkgo"
. "github.com/onsi/ginkgo/extensions/table"
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.14 Companion Types
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.22 Connection Type
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.18 Content Context
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.15 Content Delivery Methods
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.3 Creative Attributes
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.21 Device Type
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.5 Expandable Direction
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.16 Feed Types
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.23 IP Location Services
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.19 IQG Media Ratings
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.20 Location Type
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.25 Loss Reason Codes
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.24 No-Bid Reason Codes
//
+1 -1
View File
@@ -1,4 +1,4 @@
// Package openrtb provides OpenRTB v2.5 types:
// https://www.iab.com/guidelines/real-time-bidding-rtb-project/
// https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf
package openrtb
package openrtb2
@@ -1,4 +1,4 @@
package openrtb_test
package openrtb2_test
import (
. "github.com/onsi/ginkgo"
@@ -7,7 +7,7 @@ import (
"testing"
)
func TestOpenrtb(t *testing.T) {
func TestOpenrtb2(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Openrtb Suite")
RunSpecs(t, "Openrtb2 Suite")
}
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.11 Playback Cessation Modes
//
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.10 Playback Methods
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.13 Production Quality
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.8 Protocols
//
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// Int8Ptr returns pointer to passed argument.
func Int8Ptr(n int8) *int8 {
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
import "encoding/json"
+1 -1
View File
@@ -1,4 +1,4 @@
package openrtb
package openrtb2
// 5.12 Start Delay
//

Some files were not shown because too many files have changed in this diff Show More