analytics

Documentation

Index

• type AmpObject
• type Analytics
• type AuctionObject
• type CookieSyncBidder
• type CookieSyncObject
• type EventRequest
• type EventType
• type Module
• type NotificationEvent
• type ResponseFormat
• type Runner
• type SetUIDObject
• type UsersyncInfo
• type VastType
• type VideoObject

Types

type AmpObject

type AmpObject struct {
	Status               int
	Errors               []error
	AuctionResponse      *openrtb2.BidResponse
	AmpTargetingValues   map[string]string
	Origin               string
	StartTime            time.Time
	HookExecutionOutcome []hookexecution.StageOutcome
	SeatNonBid           []openrtb_ext.SeatNonBid
	RequestWrapper       *openrtb_ext.RequestWrapper
}

Loggable object of a transaction at /openrtb2/amp endpoint

type Analytics

type Analytics string

Analytics indicates if the notification event should be handled or not

const (
	Enabled  Analytics = "1"
	Disabled Analytics = "0"
)

type AuctionObject

type AuctionObject struct {
	Status               int
	Errors               []error
	Response             *openrtb2.BidResponse
	Account              *config.Account
	StartTime            time.Time
	HookExecutionOutcome []hookexecution.StageOutcome
	SeatNonBid           []openrtb_ext.SeatNonBid
	RequestWrapper       *openrtb_ext.RequestWrapper
}

Loggable object of a transaction at /openrtb2/auction endpoint

type CookieSyncBidder

type CookieSyncBidder struct {
	BidderCode   string        `json:"bidder"`
	NoCookie     bool          `json:"no_cookie,omitempty"`
	UsersyncInfo *UsersyncInfo `json:"usersync,omitempty"`
}

type CookieSyncObject

type CookieSyncObject struct {
	Status       int
	Errors       []error
	BidderStatus []*CookieSyncBidder
}

Loggable object of a transaction at /cookie_sync

type EventRequest

type EventRequest struct {
	Type        EventType      `json:"type,omitempty"`
	Format      ResponseFormat `json:"format,omitempty"`
	Analytics   Analytics      `json:"analytics,omitempty"`
	BidID       string         `json:"bidid,omitempty"`
	AccountID   string         `json:"account_id,omitempty"`
	Bidder      string         `json:"bidder,omitempty"`
	Timestamp   int64          `json:"timestamp,omitempty"`
	Integration string         `json:"integration,omitempty"`
	VType       VastType       `json:"vtype,omitempty"`
}

type EventType

type EventType string

EventType enumerates the values of events Prebid Server can receive for an ad.

const (
	Win  EventType = "win"
	Imp  EventType = "imp"
	Vast EventType = "vast"
)

Possible values of events Prebid Server can receive for an ad.

type Module

type Module interface {
	LogAuctionObject(*AuctionObject)
	LogVideoObject(*VideoObject)
	LogCookieSyncObject(*CookieSyncObject)
	LogSetUIDObject(*SetUIDObject)
	LogAmpObject(*AmpObject)
	LogNotificationEventObject(*NotificationEvent)
}

Module must be implemented by analytics modules to extract the required information and logging activities. Do not use marshal the parameter objects directly as they can change over time. Use a separate model for each analytics module and transform as appropriate.

type NotificationEvent

type NotificationEvent struct {
	Request *EventRequest   `json:"request"`
	Account *config.Account `json:"account"`
}

NotificationEvent object of a transaction at /event

type ResponseFormat

type ResponseFormat string

ResponseFormat enumerates the values of a Prebid Server event.

const (
	// Blank describes an event which returns an HTTP 200 with an empty body.
	Blank ResponseFormat = "b"
	// Image describes an event which returns an HTTP 200 with a PNG body.
	Image ResponseFormat = "i"
)

type Runner

type Runner interface {
	LogAuctionObject(*AuctionObject, privacy.ActivityControl)
	LogVideoObject(*VideoObject, privacy.ActivityControl)
	LogCookieSyncObject(*CookieSyncObject)
	LogSetUIDObject(*SetUIDObject)
	LogAmpObject(*AmpObject, privacy.ActivityControl)
	LogNotificationEventObject(*NotificationEvent, privacy.ActivityControl)
}

type SetUIDObject

type SetUIDObject struct {
	Status  int
	Bidder  string
	UID     string
	Errors  []error
	Success bool
}

Loggable object of a transaction at /setuid

type UsersyncInfo

type UsersyncInfo struct {
	URL         string `json:"url,omitempty"`
	Type        string `json:"type,omitempty"`
	SupportCORS bool   `json:"supportCORS,omitempty"`
}

type VastType

type VastType string

VastType enumerates the values of vast type events Prebid Server can receive

const (
	Start         VastType = "start"
	FirstQuartile VastType = "firstQuartile"
	MidPoint      VastType = "midPoint"
	ThirdQuartile VastType = "thirdQuartile"
	Complete      VastType = "complete"
)

Possible value of VastType event prebid server can receive.

type VideoObject

type VideoObject struct {
	Status         int
	Errors         []error
	Response       *openrtb2.BidResponse
	VideoRequest   *openrtb_ext.BidRequestVideo
	VideoResponse  *openrtb_ext.BidResponseVideo
	StartTime      time.Time
	SeatNonBid     []openrtb_ext.SeatNonBid
	RequestWrapper *openrtb_ext.RequestWrapper
}

Loggable object of a transaction at /openrtb2/video endpoint