adapters

package
v0.0.0-...-97a8816 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2018 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultHTTPAdapterConfig = &HTTPAdapterConfig{
	MaxConns:        50,
	MaxConnsPerHost: 10,
	IdleConnTimeout: 60 * time.Second,
}

DefaultHTTPAdapterConfig is an HTTPAdapterConfig that chooses sensible default values.

Functions

func BadInput 

func BadInput(msg string) *errortypes.BadInput

func GDPRAwareSyncerIDs 

func GDPRAwareSyncerIDs(syncers map[openrtb_ext.BidderName]usersync.Usersyncer) map[openrtb_ext.BidderName]uint16

func MakeOpenRTBGeneric 

func MakeOpenRTBGeneric(req *pbs.PBSRequest, bidder *pbs.PBSBidder, bidderFamily string, allowedMediatypes []pbs.MediaType) (openrtb.BidRequest, error)

adapters.MakeOpenRTBGeneric makes an openRTB request from the PBS-specific structs.

Any objects pointed to by the returned BidRequest *must not be mutated*, or we will get race conditions. The only exception is the Imp property, whose objects will be created new by this method and can be mutated freely.

func ResolveMacros 

func ResolveMacros(template string) func(gdpr string, consent string) string

This function replaces macros in a sync endpoint template. It will replace: 

{{gdpr}} -- with the "gdpr" string (should be either "0", "1", or "")
{{gdpr_consent}} -- with the Raw base64 URL-encoded GDPR Vendor Consent string.

For example, the template: 

//some-domain.com/getuid?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&callback=prebid-server-domain.com%2Fsetuid%3Fbidder%3Dadnxs%26gdpr={{gdpr}}%26gdpr_consent={{gdpr_consent}}%26uid%3D%24UID

would evaluate to: 

//some-domain.com/getuid?gdpr=&gdpr_consent=BONciguONcjGKADACHENAOLS1rAHDAFAAEAASABQAMwAeACEAFw&callback=prebid-server-domain.com%2Fsetuid%3Fbidder%3Dadnxs%26gdpr=%26gdpr_consent=BONciguONcjGKADACHENAOLS1rAHDAFAAEAASABQAMwAeACEAFw%26uid%3D%24UID

if the "gdpr" arg was empty, and the consent arg was "BONciguONcjGKADACHENAOLS1rAHDAFAAEAASABQAMwAeACEAFw"

Types

type Adapter 

type Adapter interface {
	// Name must be identical to the BidderName.
	Name() string
	// Determines whether this adapter should get callouts if there is not a synched user ID.
	SkipNoCookies() bool
	// Call produces bids which should be considered, given the auction params.
	//
	// In practice, implementations almost always make one call to an external server here.
	// However, that is not a requirement for satisfying this interface.
	//
	// An error here will cause all bids to be ignored. If the error was caused by bad user input,
	// this should return a BadInputError. If it was caused by bad server behavior
	// (e.g. 500, unexpected response format, etc), this should return a BadServerResponseError.
	Call(ctx context.Context, req *pbs.PBSRequest, bidder *pbs.PBSBidder) (pbs.PBSBidSlice, error)
}

Adapter is a deprecated interface which connects prebid-server to a demand partner. PBS is currently being rewritten to use Bidder, and this will be removed after. Their primary purpose is to produce bids in response to Auction requests.

type Bidder 

type Bidder interface {
	// MakeRequests makes the HTTP requests which should be made to fetch bids.
	//
	// Bidder implementations can assume that the incoming BidRequest has:
	//
	//   1. Only {Imp.Type, Platform} combinations which are valid, as defined by the static/bidder-info.{bidder}.yaml file.
	//   2. Imp.Ext of the form {"bidder": params}, where "params" has been validated against the static/bidder-params/{bidder}.json JSON Schema.
	//
	// nil return values are acceptable, but nil elements *inside* those slices are not.
	//
	// The errors should contain a list of errors which explain why this bidder's bids will be
	// "subpar" in some way. For example: the request contained ad types which this bidder doesn't support.
	//
	// If the error is caused by bad user input, return an errortypes.BadInput.
	MakeRequests(request *openrtb.BidRequest) ([]*RequestData, []error)

	// MakeBids unpacks the server's response into Bids.
	//
	// The bids can be nil (for no bids), but should not contain nil elements.
	//
	// The errors should contain a list of errors which explain why this bidder's bids will be
	// "subpar" in some way. For example: the server response didn't have the expected format.
	//
	// If the error was caused by bad user input, return a errortypes.BadInput.
	// If the error was caused by a bad server response, return a errortypes.BadServerResponse
	MakeBids(internalRequest *openrtb.BidRequest, externalRequest *RequestData, response *ResponseData) (*BidderResponse, []error)
}

Bidder describes how to connect to external demand.

func EnforceBidderInfo 

func EnforceBidderInfo(bidder Bidder, info BidderInfo) Bidder

EnforceBidderInfo decorates the input Bidder by making sure that all the requests to it are in sync with its static/bidder-info/{bidder}.yaml file.

It adjusts incoming requests in the following ways:

  1. If App or Site traffic is not supported by the info file, then requests from those sources will be rejected before the delegate is called.
  2. If a given MediaType is not supported for the platform, then it will be set to nil before the request is forwarded to the delegate.
  3. Any Imps which have no MediaTypes left will be removed.
  4. If there are no valid Imps left, the delegate won't be called at all.

type BidderInfo 

type BidderInfo struct {
	Maintainer   *MaintainerInfo   `yaml:"maintainer" json:"maintainer"`
	Capabilities *CapabilitiesInfo `yaml:"capabilities" json:"capabilities"`
	AliasOf      string            `json:"aliasOf,omitempty"`
}

type BidderInfos 

type BidderInfos map[string]BidderInfo

func ParseBidderInfos 

func ParseBidderInfos(infoDir string, bidders []openrtb_ext.BidderName) BidderInfos

ParseBidderInfos reads all the static/bidder-info/{bidder}.yaml files from the filesystem. The map it returns will have a key for every element of the bidders array. If a {bidder}.yaml file does not exist for some bidder, it will panic.

func (BidderInfos) HasAppSupport 

func (infos BidderInfos) HasAppSupport(bidder openrtb_ext.BidderName) bool

func (BidderInfos) HasSiteSupport 

func (infos BidderInfos) HasSiteSupport(bidder openrtb_ext.BidderName) bool

func (BidderInfos) SupportsAppMediaType 

func (infos BidderInfos) SupportsAppMediaType(bidder openrtb_ext.BidderName, mediaType openrtb_ext.BidType) bool

func (BidderInfos) SupportsWebMediaType 

func (infos BidderInfos) SupportsWebMediaType(bidder openrtb_ext.BidderName, mediaType openrtb_ext.BidType) bool

type BidderResponse 

type BidderResponse struct {
	Currency string
	Bids     []*TypedBid
}

BidderResponse wraps the server's response with the list of bids and the currency used by the bidder.

Currency declaration is not mandatory but helps to detect an eventual currency mismatch issue. From the bid response, the bidder accepts a list of valid currencies for the bid. The currency is the same accross all bids.

func NewBidderResponse 

func NewBidderResponse() *BidderResponse

NewBidderResponse create a new BidderResponse initialising the bids array and the default currency value to "USD".

By default, Bids capacity will be set to 0. By default, currency is USD but this behavior might be subject to change.

func NewBidderResponseWithBidsCapacity 

func NewBidderResponseWithBidsCapacity(bidsCapacity int) *BidderResponse

NewBidderResponseWithBidsCapacity create a new BidderResponse initialising the bids array capacity and the default currency value to "USD".

bidsCapacity allows to set initial Bids array capacity. By default, currency is USD but this behavior might be subject to change.

type CallOneResult 

type CallOneResult struct {
	StatusCode   int
	ResponseBody string
	Bid          *pbs.PBSBid
	Error        error
}

used for callOne (possibly pull all of the shared code here)

type CapabilitiesInfo 

type CapabilitiesInfo struct {
	App  *PlatformInfo `yaml:"app" json:"app"`
	Site *PlatformInfo `yaml:"site" json:"site"`
}

type ExtImpBidder 

type ExtImpBidder struct {
	Prebid *openrtb_ext.ExtImpPrebid `json:"prebid"`

	// Bidder contain the bidder-specific extension. Each bidder should unmarshal this using their
	// corresponding openrtb_ext.ExtImp{Bidder} struct.
	//
	// For example, the Appnexus Bidder should unmarshal this with an openrtb_ext.ExtImpAppnexus object.
	//
	// Bidder implementations may safely assume that this JSON has been validated by their
	// static/bidder-params/{bidder}.json file.
	Bidder json.RawMessage `json:"bidder"`
}

ExtImpBidder can be used by Bidders to unmarshal any request.imp[i].ext.

type HTTPAdapter 

type HTTPAdapter struct {
	Client *http.Client
}

func NewHTTPAdapter 

func NewHTTPAdapter(c *HTTPAdapterConfig) *HTTPAdapter

NewHTTPAdapter creates an HTTPAdapter which obeys the rules given by the config, and has all the available SSL certs available in the project.

type HTTPAdapterConfig 

type HTTPAdapterConfig struct {
	// See IdleConnTimeout on https://golang.org/pkg/net/http/#Transport
	IdleConnTimeout time.Duration
	// See MaxIdleConns on https://golang.org/pkg/net/http/#Transport
	MaxConns int
	// See MaxIdleConnsPerHost on https://golang.org/pkg/net/http/#Transport
	MaxConnsPerHost int
}

HTTPAdapterConfig groups options which control how HTTP requests are made by adapters.

type InfoAwareBidder 

type InfoAwareBidder struct {
	Bidder
	// contains filtered or unexported fields
}

func (*InfoAwareBidder) MakeRequests 

func (i *InfoAwareBidder) MakeRequests(request *openrtb.BidRequest) ([]*RequestData, []error)

type MaintainerInfo 

type MaintainerInfo struct {
	Email string `yaml:"email" json:"email"`
}

type MisconfiguredAdapter 

type MisconfiguredAdapter struct {
	TheName string
	Err     error
}

func (*MisconfiguredAdapter) Call 

func (b *MisconfiguredAdapter) Call(ctx context.Context, req *pbs.PBSRequest, bidder *pbs.PBSBidder) (pbs.PBSBidSlice, error)

func (*MisconfiguredAdapter) Name 

func (b *MisconfiguredAdapter) Name() string

func (*MisconfiguredAdapter) SkipNoCookies 

func (b *MisconfiguredAdapter) SkipNoCookies() bool

type PlatformInfo 

type PlatformInfo struct {
	MediaTypes []openrtb_ext.BidType `yaml:"mediaTypes" json:"mediaTypes"`
}

type RequestData 

type RequestData struct {
	Method  string
	Uri     string
	Body    []byte
	Headers http.Header
}

RequestData packages together the fields needed to make an http.Request.

func (*RequestData) SetBasicAuth 

func (r *RequestData) SetBasicAuth(username string, password string)

type ResponseData 

type ResponseData struct {
	StatusCode int
	Body       []byte
	Headers    http.Header
}

ResponseData packages together information from the server's http.Response.

type SyncType 

type SyncType string
const (
	SyncTypeRedirect SyncType = "redirect"
	SyncTypeIframe   SyncType = "iframe"
)

type Syncer 

type Syncer struct {
	// contains filtered or unexported fields
}

func NewSyncer 

func NewSyncer(familyName string, vendorID uint16, endpointBulder func(gdpr string, consent string) string, syncType SyncType) *Syncer

func (*Syncer) FamilyName 

func (s *Syncer) FamilyName() string

func (*Syncer) GDPRVendorID 

func (s *Syncer) GDPRVendorID() uint16

func (*Syncer) GetUsersyncInfo 

func (s *Syncer) GetUsersyncInfo(gdpr string, consent string) *usersync.UsersyncInfo

type TypedBid 

type TypedBid struct {
	Bid     *openrtb.Bid
	BidType openrtb_ext.BidType
}

TypedBid packages the openrtb.Bid with any bidder-specific information that PBS needs to populate an openrtb_ext.ExtBidPrebid.

TypedBid.Bid.Ext will become "response.seatbid[i].bid.ext.bidder" in the final OpenRTB response. TypedBid.BidType will become "response.seatbid[i].bid.ext.prebid.type" in the final OpenRTB response.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.