response.go

package openrtb

import (
	"encoding/json"
	"errors"
	"io"
)

// ID and at least one “seatbid” object is required, which contains a bid on at least one impression.
// Other attributes are optional since an exchange may establish default values.
// No-Bids on all impressions should be indicated as a HTTP 204 response.
// For no-bids on specific impressions, the bidder should omit these from the bid response.
type Response struct {
	Id         *string    `json:"id"`                   // Reflection of the bid request ID for logging purposes
	Seatbid    []Seatbid  `json:"seatbid"`              // Array of seatbid objects
	Bidid      *string    `json:"bidid,omitempty"`      // Optional response tracking ID for bidders
	Cur        *string    `json:"cur,omitempty"`        // Bid currency
	Customdata *string    `json:"customdata,omitempty"` // Encoded user features
	Nbr        *int       `json:"nbr,omitempty"`        // Reason for not bidding, where 0 = unknown error, 1 = technical error, 2 = invalid request, 3 = known web spider, 4 = suspected Non-Human Traffic, 5 = cloud, data center, or proxy IP, 6 = unsupported device, 7 = blocked publisher or site, 8 = unmatched user
	Ext        Extensions `json:"ext,omitempty"`        // Custom specifications in Json
}

// Validation errors
var (
	ErrInvalidResID      = errors.New("openrtb response: missing ID")
	ErrInvalidResSeatbid = errors.New("openrtb response: missing seatbids")
)

//Parses an OpenRTB Response from an io.Reader
func ParseResponse(reader io.Reader) (resp *Response, err error) {
	dec := json.NewDecoder(reader)
	if err = dec.Decode(&resp); err != nil {
		return nil, err
	}
	return resp, nil
}

//Parses an OpenRTB Response from bytes
func ParseResponseBytes(data []byte) (resp *Response, err error) {
	if err = json.Unmarshal(data, &resp); err != nil {
		return nil, err
	}
	return resp, nil
}

// Validate Response required attributes
// @return [Boolean,Error] true if response,seatbid,bid required attrs present
func (res *Response) Valid() (bool, error) {

	if res.Id == nil {
		return false, ErrInvalidResID
	} else if res.Seatbid == nil || len(res.Seatbid) < 1 {
		return false, ErrInvalidResSeatbid
	}

	for _, sb := range res.Seatbid {
		if ok, err := sb.Valid(); !ok {
			return ok, err
		}
	}

	return true, nil
}