contrib/openrtb
1
0
Fork 0
mirror of https://github.com/prebid/openrtb.git synced 2026-06-14 14:06:38 +03:00
Code Issues Packages Projects Releases Wiki Activity

types: integral types hints in README

Browse Source
This commit is contained in:
Max Cherry
2018-12-30 12:45:55 +02:00
parent 1efc868257
commit 3b335c8434
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -3
View File
@@ -48,14 +48,13 @@ Master always contains latest code, so better use some package manager to vendor
- Key types should be chosen according to OpenRTB specification (attribute types)
- Numeric types:
- `int8` - short enums (with values <= 127), boolean-like attributes (like `BidRequest.test`)
- `int64` - time, duration, length, unbound enums (like `BidRequest.at` - exchange-specific auctions types are > 500)
- `uint64` - width, height, bitrate etc. (unbound positive numbers)
- `int64` - every other integral type
- `float64` - coordinates, prices etc.
- Enums:
- all enums, described in section 5, must be typed with section name singularized (e.g., "5.2 Banner Ad Types" -> `type BannerAdType int8`)
- all typed enums must have constants for each element, prefixed with type name (e.g., "5.2 Banner Ad Types - XHTML Text Ad (usually mobile)" -> `const BannerAdTypeXHTMLTextAd BannerAdType = 1`)
- never use `iota` for enum constants
- section "5.1 Content Categories" should remain untyped and have no constants
- OpenRTB (2.x) section "5.1 Content Categories" should remain untyped and have no constants
## Pointers/omitempty
Pointer | Omitempty | When to use | Example