macros

Documentation

Index

• Constants
• func ResolveMacros(aTemplate *template.Template, params interface{}) (string, error)
• type EndpointTemplateParams
• type MacroProvider
  • func NewProvider(reqWrapper *openrtb_ext.RequestWrapper) *MacroProvider
  • func (b *MacroProvider) GetMacro(key string) string
  • func (b *MacroProvider) PopulateBidMacros(bid *entities.PbsOrtbBid, seat string)
  • func (b *MacroProvider) PopulateEventMacros(vastCreativeID, eventType, vastEvent string)
• type Replacer
  • func NewStringIndexBasedReplacer() Replacer
• type UserSyncPrivacy

Constants

const (
	MacroKeyBidID       = "PBS-BIDID"
	MacroKeyAppBundle   = "PBS-APPBUNDLE"
	MacroKeyDomain      = "PBS-DOMAIN"
	MacroKeyPubDomain   = "PBS-PUBDOMAIN"
	MacroKeyPageURL     = "PBS-PAGEURL"
	MacroKeyAccountID   = "PBS-ACCOUNTID"
	MacroKeyLmtTracking = "PBS-LIMITADTRACKING"
	MacroKeyConsent     = "PBS-GDPRCONSENT"
	MacroKeyBidder      = "PBS-BIDDER"
	MacroKeyIntegration = "PBS-INTEGRATION"
	MacroKeyVastCRTID   = "PBS-VASTCRTID"
	MacroKeyTimestamp   = "PBS-TIMESTAMP"
	MacroKeyAuctionID   = "PBS-AUCTIONID"
	MacroKeyChannel     = "PBS-CHANNEL"
	MacroKeyEventType   = "PBS-EVENTTYPE"
	MacroKeyVastEvent   = "PBS-VASTEVENT"
)

const (
	CustomMacroPrefix = "PBS-MACRO-"
)

Functions

func ResolveMacros

func ResolveMacros(aTemplate *template.Template, params interface{}) (string, error)

ResolveMacros resolves macros in the given template with the provided params

Types

type EndpointTemplateParams

type EndpointTemplateParams struct {
	Host        string
	PublisherID string
	ZoneID      string
	SourceId    string
	AccountID   string
	AdUnit      string
	MediaType   string
	GvlID       string
	PageID      string
	SupplyId    string
	SspId       string
	SspID       string
	SeatID      string
	TokenID     string
}

EndpointTemplateParams specifies macros for bidder endpoints.

type MacroProvider

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

func NewProvider

func NewProvider(reqWrapper *openrtb_ext.RequestWrapper) *MacroProvider

NewBuilder returns the instance of macro buidler

func (*MacroProvider) GetMacro

func (b *MacroProvider) GetMacro(key string) string

func (*MacroProvider) PopulateBidMacros

func (b *MacroProvider) PopulateBidMacros(bid *entities.PbsOrtbBid, seat string)

func (*MacroProvider) PopulateEventMacros

func (b *MacroProvider) PopulateEventMacros(vastCreativeID, eventType, vastEvent string)

type Replacer

type Replacer interface {
	// Replace the macros and returns replaced string
	// if any error the error will be returned
	Replace(result *strings.Builder, url string, macroProvider *MacroProvider)
}

func NewStringIndexBasedReplacer

func NewStringIndexBasedReplacer() Replacer

NewStringIndexBasedReplacer will return instance of string index based macro replacer

type UserSyncPrivacy

type UserSyncPrivacy struct {
	GDPR        string
	GDPRConsent string
	USPrivacy   string
	GPP         string
	GPPSID      string
}

UserSyncPrivacy specifies privacy policy macros, represented as strings, for user sync urls.