native.go

package openrtb2

import (
	"encoding/json"

	"github.com/prebid/openrtb/v20/adcom1"
	native1 "github.com/prebid/openrtb/v20/native1/request"
)

// 3.2.9 Object: Native
//
// This object represents a native type impression.
// Native ad units are intended to blend seamlessly into the surrounding content (e.g., a sponsored Twitter or Facebook post).
// As such, the response must be well-structured to afford the publisher fine-grained control over rendering.
//
// The Native Subcommittee has developed a companion specification to OpenRTB called the Dynamic Native Ads API.
// It defines the request parameters and response markup structure of native ad units.
// This object provides the means of transporting request parameters as an opaque string so that the specific parameters can evolve separately under the auspices of the Dynamic Native Ads API.
// Similarly, the ad markup served will be structured according to that specification.
//
// The presence of a Native as a subordinate of the Imp object indicates that this impression is offered as a native type impression.
// At the publisher’s discretion, that same impression may also be offered as banner, video, and/or audio by also including as Imp subordinates objects of those types.
// However, any given bid for the impression must conform to one of the offered types.
type Native struct {

	// Attribute:
	//   request_native
	// Type:
	//   object; required
	// Description:
	// 		Native Struct for BidSwitch
	//		https://protocol.bidswitch.com/ssp-protocol/ssp-native-request.html
	RequestNative *native1.Request `json:"request_native,omitempty"`

	// Attribute:
	//   requestobj
	// Type:
	//   object; required
	// Description:
	// 		Native Struct for Rubicon
	RequestObj *native1.Request `json:"requestobj,omitempty"`

	// Attribute:
	//   request
	// Type:
	//   string; required
	// Description:
	//   Request payload complying with the Native Ad Specification.
	//   The root node of the payload, “native”, was dropped in the
	//   Native Ad Specification 1.1.
	//
	//   For Native 1.0, this is a JSON-encoded string consisting of a
	//   unnamed root object with a single subordinate object named
	//   'native', which is the Native Markup Request object, section 4.1
	//   of OpenRTB Native 1.0 specification.
	//
	//   For Native 1.1 and higher, this is a JSON-encoded string
	//   consisting of an unnamed root object which is itself the Native
	//   Markup Request Object, section 4.1 of OpenRTB Native 1.1+.
	Request string `json:"request,omitempty"`

	// Attribute:
	//   ver
	// Type:
	//   string; recommended
	// Description:
	//   Version of the Dynamic Native Ads API to which request
	//   complies; highly recommended for efficient parsing.
	Ver string `json:"ver,omitempty"`

	// Attribute:
	//   api
	// Type:
	//   integer array
	// Description:
	//   List of supported API frameworks for this impression. Refer to
	//   List: API Frameworks in AdCOM. If an API is not explicitly listed,
	//   it is assumed not to be supported.
	// Note:
	//   OpenRTB <=2.5 defined only frameworks 1..6.
	API []adcom1.APIFramework `json:"api,omitempty"`

	// Attribute:
	//   sequence
	// Type:
	//   integer array
	// Description:
	//   Blocked creative attributes. Refer to List: Creative Attributes in
	//   AdCOM.
	// Note:
	//   OpenRTB <=2.5 defined only attributes with IDs 1..17.
	BAttr []adcom1.CreativeAttribute `json:"battr,omitempty"`

	// Attribute:
	//   ext
	// Type:
	//   object
	// Description:
	//   Placeholder for exchange-specific extensions to OpenRTB.
	Ext json.RawMessage `json:"ext,omitempty"`
}