zachbadgett / mxmCherry-openrtb

Go (Golang) OpenRTB 2.5, 3.0 / AdCOM 1.0 / Native 1.2 types/enums

openrtb

OpenRTB, AdCOM and OpenRTB Dynamic Native Ads types for Go programming language

• openrtb2 - OpenRTB 2.5
• openrtb3 - OpenRTB 3.0
• adcom1 - AdCOM 1.0
• native1 - OpenRTB Dynamic Native Ads API 1.2

Requires Go 1.8+

Go 1.8+ is needed for proper Ext json.RawMessage marshaling: non-pointer json.RawMessage is marshaled as base64 string prior to Go 1.8.

This library uses json.RawMessage since v10.0.0.

This library is tested with Go 1.9+ since v12.0.0.

Using

go get -u "github.com/mxmCherry/openrtb/..."

import (
	openrtb2 "github.com/mxmCherry/openrtb/openrtb2"

	openrtb3 "github.com/mxmCherry/openrtb/openrtb3"
	adcom1 "github.com/mxmCherry/openrtb/adcom1"

	native1 "github.com/mxmCherry/openrtb/native1"
	nreq "github.com/mxmCherry/openrtb/native1/request"
	nres "github.com/mxmCherry/openrtb/native1/response"
)

This repo follows semver - see releases. Master always contains latest code, so better use some package manager to vendor specific version.

Guidelines

Naming convention

• UpperCamelCase
• Capitalized abbreviations (e.g., AT, COPPA, PMP etc.)
• Capitalized ID keys

Types

• 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 - other integral types
  • 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
  • OpenRTB (2.x) section "5.1 Content Categories" should remain untyped and have no constants

Pointers/omitempty

Pointer	Omitempty	When to use	Example
no	no	required in spec	Audio.mimes
yes	yes	required in spec, but is a part of mutually-exclusive group	Imp.{banner,video,audio,native}
no	yes	zero value ("", 0) is useless / has no meaning	Device.ua
yes	yes	zero value ("", 0) or value absence (null) has special meaning	Device.{dnt,lmt}

Using both pointer and omitempty is mostly just to save traffic / generate more "canonical" (strict) JSON.

Documentation (godoc)

• 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)

Code organization

• Each RTB type should be kept in its own file, named after type
• File names are in underscore_case, e.g., type BidRequest should be declared in bid_request.go
• go fmt your code
• EditorConfig (not required, but useful)