mirror of
https://github.com/prebid/openrtb.git
synced 2026-06-14 14:06:38 +03:00
Change Repo Path + Reset Version
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# openrtb [](https://pkg.go.dev/github.com/mxmCherry/openrtb/v17) [](https://github.com/mxmCherry/openrtb/actions/workflows/test.yml)
|
||||
# openrtb [](https://pkg.go.dev/github.com/prebid/openrtb/v1) [](https://github.com/prebid/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/)
|
||||
|
||||
@@ -9,30 +9,30 @@
|
||||
|
||||
**Requires Go 1.13+**
|
||||
|
||||
This library is switched to [Go modules](https://golang.org/ref/mod) ([tl;dr](https://blog.golang.org/using-go-modules)) as of [v14.0.0](https://github.com/mxmCherry/openrtb/releases/tag/v14.0.0), so it requires Go [1.11](https://golang.org/doc/go1.11)+ (older Go versions are not capable of using versioned paths).
|
||||
This library is switched to [Go modules](https://golang.org/ref/mod) ([tl;dr](https://blog.golang.org/using-go-modules)) as of [v14.0.0](https://github.com/prebid/openrtb/releases/tag/v14.0.0), so it requires Go [1.11](https://golang.org/doc/go1.11)+ (older Go versions are not capable of using versioned paths).
|
||||
|
||||
Also, [test/matcher library](https://github.com/onsi/gomega) relies on newer Go [error handling approach](https://blog.golang.org/go1.13-errors), so tests require Go [1.13](https://golang.org/doc/go1.13)+.
|
||||
|
||||
# Using
|
||||
|
||||
```bash
|
||||
go get -u "github.com/mxmCherry/openrtb/v17/..."
|
||||
go get -u "github.com/prebid/openrtb/v1/..."
|
||||
```
|
||||
|
||||
```go
|
||||
import (
|
||||
openrtb2 "github.com/mxmCherry/openrtb/v17/openrtb2"
|
||||
openrtb2 "github.com/prebid/openrtb/v1/openrtb2"
|
||||
|
||||
openrtb3 "github.com/mxmCherry/openrtb/v17/openrtb3"
|
||||
adcom1 "github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
openrtb3 "github.com/prebid/openrtb/v1/openrtb3"
|
||||
adcom1 "github.com/prebid/openrtb/v1/adcom1"
|
||||
|
||||
native1 "github.com/mxmCherry/openrtb/v17/native1"
|
||||
nreq "github.com/mxmCherry/openrtb/v17/native1/request"
|
||||
nres "github.com/mxmCherry/openrtb/v17/native1/response"
|
||||
native1 "github.com/prebid/openrtb/v1/native1"
|
||||
nreq "github.com/prebid/openrtb/v1/native1/request"
|
||||
nres "github.com/prebid/openrtb/v1/native1/response"
|
||||
)
|
||||
```
|
||||
|
||||
This repo follows [semver](http://semver.org/) - see [releases](https://github.com/mxmCherry/openrtb/releases).
|
||||
This repo follows [semver](http://semver.org/) - see [releases](https://github.com/prebid/openrtb/releases).
|
||||
The `main` branch always contains latest code, so better use some package manager to vendor specific version.
|
||||
|
||||
# Guidelines
|
||||
@@ -65,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/v17))
|
||||
## Documentation ([pkg.go.dev](https://pkg.go.dev/github.com/prebid/openrtb/v1))
|
||||
- [Godoc: documenting Go code](http://blog.golang.org/godoc-documenting-go-code)
|
||||
- Each entity (type, struct key or constant) should be documented
|
||||
- Ideally, copy-paste descriptions as-is, but feel free to omit section numbers, so just `<GoTypeName> defines <copy-pasted description from spec>`
|
||||
|
||||
+1
-1
@@ -1,3 +1,3 @@
|
||||
# adcom1 [](https://pkg.go.dev/github.com/mxmCherry/openrtb/v17/adcom1)
|
||||
# adcom1 [](https://pkg.go.dev/github.com/prebid/openrtb/v1/adcom1)
|
||||
|
||||
[AdCOM](https://iabtechlab.com/standards/openmedia/) [1.0](https://github.com/InteractiveAdvertisingBureau/AdCOM) types for [Go programming language](https://golang.org/)
|
||||
|
||||
@@ -8,7 +8,7 @@ import (
|
||||
. "github.com/onsi/ginkgo/extensions/table"
|
||||
. "github.com/onsi/gomega"
|
||||
|
||||
. "github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
. "github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
var _ = DescribeTable(
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
module github.com/mxmCherry/openrtb/v17
|
||||
module github.com/prebid/openrtb/v1
|
||||
|
||||
go 1.16
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# native1 [](https://pkg.go.dev/github.com/mxmCherry/openrtb/v17/native1)
|
||||
# native1 [](https://pkg.go.dev/github.com/prebid/openrtb/v1/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) section "7 Reference Lists/Enumerations" types for [Go programming language](https://golang.org/)
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# native1/request [](https://pkg.go.dev/github.com/mxmCherry/openrtb/v17/native1/request)
|
||||
# native1/request [](https://pkg.go.dev/github.com/prebid/openrtb/v1/native1/request)
|
||||
|
||||
[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) section "4 Native Ad Request Markup Details" types for [Go programming language](https://golang.org/)
|
||||
|
||||
@@ -3,7 +3,7 @@ package request
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/native1"
|
||||
"github.com/prebid/openrtb/v1/native1"
|
||||
)
|
||||
|
||||
// 4.6 Data Object
|
||||
|
||||
@@ -3,7 +3,7 @@ package request
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/native1"
|
||||
"github.com/prebid/openrtb/v1/native1"
|
||||
)
|
||||
|
||||
// 4.7 Event Trackers Request Object
|
||||
|
||||
@@ -3,7 +3,7 @@ package request
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/native1"
|
||||
"github.com/prebid/openrtb/v1/native1"
|
||||
)
|
||||
|
||||
// 4.4 Image Object
|
||||
|
||||
@@ -8,7 +8,7 @@ package request
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/native1"
|
||||
"github.com/prebid/openrtb/v1/native1"
|
||||
)
|
||||
|
||||
// 4.1 Native Markup Request Object
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
|
||||
. "github.com/mxmCherry/openrtb/v17/native1/request"
|
||||
. "github.com/prebid/openrtb/v1/native1/request"
|
||||
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/ginkgo/extensions/table"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package request
|
||||
|
||||
import (
|
||||
"github.com/mxmCherry/openrtb/v17/openrtb2"
|
||||
"github.com/prebid/openrtb/v1/openrtb2"
|
||||
)
|
||||
|
||||
// 4.5 Video Object
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# native1/response [](https://pkg.go.dev/github.com/mxmCherry/openrtb/v17/native1/response)
|
||||
# native1/response [](https://pkg.go.dev/github.com/prebid/openrtb/v1/native1/response)
|
||||
|
||||
[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) section "5 Native Ad Response Markup Details" types for [Go programming language](https://golang.org/)
|
||||
|
||||
@@ -3,7 +3,7 @@ package response
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/native1"
|
||||
"github.com/prebid/openrtb/v1/native1"
|
||||
)
|
||||
|
||||
// 5.5 Object: Data
|
||||
|
||||
@@ -3,7 +3,7 @@ package response
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/native1"
|
||||
"github.com/prebid/openrtb/v1/native1"
|
||||
)
|
||||
|
||||
// 5.8 Event Tracker Response Object
|
||||
|
||||
@@ -3,7 +3,7 @@ package response
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/native1"
|
||||
"github.com/prebid/openrtb/v1/native1"
|
||||
)
|
||||
|
||||
// 5.4 Object: Image
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
|
||||
. "github.com/mxmCherry/openrtb/v17/native1/response"
|
||||
. "github.com/prebid/openrtb/v1/native1/response"
|
||||
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/ginkgo/extensions/table"
|
||||
|
||||
+1
-1
@@ -1,3 +1,3 @@
|
||||
# openrtb2 [](https://pkg.go.dev/github.com/mxmCherry/openrtb/v17/openrtb2)
|
||||
# openrtb2 [](https://pkg.go.dev/github.com/prebid/openrtb/v1/openrtb2)
|
||||
|
||||
[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/)
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.14 Object: App
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.8 Object: Audio
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.6 Object: Banner
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 4.3.3 Object: Bid
|
||||
|
||||
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.1 Object: BidRequest
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
|
||||
. "github.com/mxmCherry/openrtb/v17/openrtb2"
|
||||
. "github.com/prebid/openrtb/v1/openrtb2"
|
||||
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/ginkgo/extensions/table"
|
||||
|
||||
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/openrtb3"
|
||||
"github.com/prebid/openrtb/v1/openrtb3"
|
||||
)
|
||||
|
||||
// 4.3.1 Object: BidResponse
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
|
||||
. "github.com/mxmCherry/openrtb/v17/openrtb2"
|
||||
. "github.com/prebid/openrtb/v1/openrtb2"
|
||||
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/ginkgo/extensions/table"
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.16 Object: Content
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.18 Object: Device
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.19 Object: Geo
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.9 Object: Native
|
||||
|
||||
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.17 Object: Producer
|
||||
|
||||
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.15 Object: Publisher
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.13 Object: Site
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.28 Object: UID
|
||||
|
||||
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.29 Object: UserAgent
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ package openrtb2
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/mxmCherry/openrtb/v17/adcom1"
|
||||
"github.com/prebid/openrtb/v1/adcom1"
|
||||
)
|
||||
|
||||
// 3.2.7 Object: Video
|
||||
|
||||
+1
-1
@@ -1,3 +1,3 @@
|
||||
# openrtb3 [](https://pkg.go.dev/github.com/mxmCherry/openrtb/v17/openrtb3)
|
||||
# openrtb3 [](https://pkg.go.dev/github.com/prebid/openrtb/v1/openrtb3)
|
||||
|
||||
[OpenRTB](https://iabtechlab.com/standards/openrtb/) [3.0](https://github.com/InteractiveAdvertisingBureau/openrtb) types for [Go programming language](https://golang.org/)
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
|
||||
. "github.com/mxmCherry/openrtb/v17/openrtb3"
|
||||
. "github.com/prebid/openrtb/v1/openrtb3"
|
||||
|
||||
. "github.com/onsi/ginkgo/extensions/table"
|
||||
. "github.com/onsi/gomega"
|
||||
|
||||
Reference in New Issue
Block a user