vastbidder

package
v1.200.0 Latest Latest
Warning

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

 Go to latest Published: Nov 11, 2022 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	//Request
	MacroTest              = `test`
	MacroTimeout           = `timeout`
	MacroWhitelistSeat     = `wseat`
	MacroWhitelistLang     = `wlang`
	MacroBlockedSeat       = `bseat`
	MacroCurrency          = `cur`
	MacroBlockedCategory   = `bcat`
	MacroBlockedAdvertiser = `badv`
	MacroBlockedApp        = `bapp`

	//Source
	MacroFD             = `fd`
	MacroTransactionID  = `tid`
	MacroPaymentIDChain = `pchain`

	//Regs
	MacroCoppa = `coppa`

	//Impression
	MacroDisplayManager        = `displaymanager`
	MacroDisplayManagerVersion = `displaymanagerver`
	MacroInterstitial          = `instl`
	MacroTagID                 = `tagid`
	MacroBidFloor              = `bidfloor`
	MacroBidFloorCurrency      = `bidfloorcur`
	MacroSecure                = `secure`
	MacroPMP                   = `pmp`

	//Video
	MacroVideoMIMES            = `mimes`
	MacroVideoMinimumDuration  = `minduration`
	MacroVideoMaximumDuration  = `maxduration`
	MacroVideoProtocols        = `protocols`
	MacroVideoPlayerWidth      = `playerwidth`
	MacroVideoPlayerHeight     = `playerheight`
	MacroVideoStartDelay       = `startdelay`
	MacroVideoPlacement        = `placement`
	MacroVideoLinearity        = `linearity`
	MacroVideoSkip             = `skip`
	MacroVideoSkipMinimum      = `skipmin`
	MacroVideoSkipAfter        = `skipafter`
	MacroVideoSequence         = `sequence`
	MacroVideoBlockedAttribute = `battr`
	MacroVideoMaximumExtended  = `maxextended`
	MacroVideoMinimumBitRate   = `minbitrate`
	MacroVideoMaximumBitRate   = `maxbitrate`
	MacroVideoBoxing           = `boxingallowed`
	MacroVideoPlaybackMethod   = `playbackmethod`
	MacroVideoDelivery         = `delivery`
	MacroVideoPosition         = `position`
	MacroVideoAPI              = `api`

	//Site
	MacroSiteID       = `siteid`
	MacroSiteName     = `sitename`
	MacroSitePage     = `page`
	MacroSiteReferrer = `ref`
	MacroSiteSearch   = `search`
	MacroSiteMobile   = `mobile`

	//App
	MacroAppID       = `appid`
	MacroAppName     = `appname`
	MacroAppBundle   = `bundle`
	MacroAppStoreURL = `storeurl`
	MacroAppVersion  = `appver`
	MacroAppPaid     = `paid`

	//SiteAppCommon
	MacroCategory        = `cat`
	MacroDomain          = `domain`
	MacroSectionCategory = `sectioncat`
	MacroPageCategory    = `pagecat`
	MacroPrivacyPolicy   = `privacypolicy`
	MacroKeywords        = `keywords`

	//Publisher
	MacroPubID     = `pubid`
	MacroPubName   = `pubname`
	MacroPubDomain = `pubdomain`

	//Content
	MacroContentID                 = `contentid`
	MacroContentEpisode            = `episode`
	MacroContentTitle              = `title`
	MacroContentSeries             = `series`
	MacroContentSeason             = `season`
	MacroContentArtist             = `artist`
	MacroContentGenre              = `genre`
	MacroContentAlbum              = `album`
	MacroContentISrc               = `isrc`
	MacroContentURL                = `contenturl`
	MacroContentCategory           = `contentcat`
	MacroContentProductionQuality  = `contentprodq`
	MacroContentVideoQuality       = `contentvideoquality`
	MacroContentContext            = `context`
	MacroContentContentRating      = `contentrating`
	MacroContentUserRating         = `userrating`
	MacroContentQAGMediaRating     = `qagmediarating`
	MacroContentKeywords           = `contentkeywords`
	MacroContentLiveStream         = `livestream`
	MacroContentSourceRelationship = `sourcerelationship`
	MacroContentLength             = `contentlen`
	MacroContentLanguage           = `contentlanguage`
	MacroContentEmbeddable         = `contentembeddable`

	//Producer
	MacroProducerID   = `prodid`
	MacroProducerName = `prodname`

	//Device
	MacroUserAgent       = `useragent`
	MacroDNT             = `dnt`
	MacroLMT             = `lmt`
	MacroIP              = `ip`
	MacroDeviceType      = `devicetype`
	MacroMake            = `make`
	MacroModel           = `model`
	MacroDeviceOS        = `os`
	MacroDeviceOSVersion = `osv`
	MacroDeviceWidth     = `devicewidth`
	MacroDeviceHeight    = `deviceheight`
	MacroDeviceJS        = `js`
	MacroDeviceLanguage  = `lang`
	MacroDeviceIFA       = `ifa`
	MacroDeviceIFAType   = `ifa_type`
	MacroDeviceDIDSHA1   = `didsha1`
	MacroDeviceDIDMD5    = `didmd5`
	MacroDeviceDPIDSHA1  = `dpidsha1`
	MacroDeviceDPIDMD5   = `dpidmd5`
	MacroDeviceMACSHA1   = `macsha1`
	MacroDeviceMACMD5    = `macmd5`

	//Geo
	MacroLatitude  = `lat`
	MacroLongitude = `lon`
	MacroCountry   = `country`
	MacroRegion    = `region`
	MacroCity      = `city`
	MacroZip       = `zip`
	MacroUTCOffset = `utcoffset`

	//User
	MacroUserID      = `uid`
	MacroYearOfBirth = `yob`
	MacroGender      = `gender`

	//Extension
	MacroGDPRConsent = `consent`
	MacroGDPR        = `gdpr`
	MacroUSPrivacy   = `usprivacy`

	//Additional
	MacroCacheBuster = `cachebuster`
)

List of Tag Bidder Macros

Variables

View Source 
var GetRandomID = func() string {
	return strconv.FormatInt(rand.Int63(), intBase)
}
View Source 
var ParamKeys = []string{"param1", "param2", "param3", "param4", "param5"}

Functions

func Builder 

func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error)

Builder builds a new instance of the 33Across adapter for the given bidder with the given config.

func GetMacroKey 

func GetMacroKey(key string) string

GetMacroKey will return macro formatted key

func NormalizeJSON 

func NormalizeJSON(obj map[string]interface{}) map[string]string

func ObjectArrayToString 

func ObjectArrayToString(len int, separator string, cb func(i int) string) string

func RegisterNewBidderMacro 

func RegisterNewBidderMacro(bidder openrtb_ext.BidderName, macro func() IBidderMacro)

RegisterNewBidderMacro will be used by each bidder to set its respective macro IBidderMacro

Types

type BidderMacro 

type BidderMacro struct {
	IBidderMacro

	//Configuration Parameters
	Conf *config.Adapter

	//OpenRTB Specific Parameters
	Request   *openrtb2.BidRequest
	IsApp     bool
	HasGeo    bool
	Imp       *openrtb2.Imp
	Publisher *openrtb2.Publisher
	Content   *openrtb2.Content

	//Extensions
	ImpBidderExt openrtb_ext.ExtImpVASTBidder
	VASTTag      *openrtb_ext.ExtImpVASTBidderTag
	UserExt      *openrtb_ext.ExtUser
	RegsExt      *openrtb_ext.ExtRegs
	DeviceExt    *openrtb_ext.ExtDevice

	//Impression level Request Headers
	ImpReqHeaders http.Header
}

BidderMacro default implementation

func (*BidderMacro) GetBidderKeys 

func (tag *BidderMacro) GetBidderKeys() map[string]string

GetBidderKeys will set bidder level keys

func (*BidderMacro) GetHeaders 

func (tag *BidderMacro) GetHeaders() http.Header

GetHeaders returns list of custom request headers Override this method if your Vast bidder needs custom request headers

func (*BidderMacro) GetURI 

func (tag *BidderMacro) GetURI() string

GetURI get URL

func (*BidderMacro) InitBidRequest 

func (tag *BidderMacro) InitBidRequest(request *openrtb2.BidRequest)

InitBidRequest will initialise BidRequest

func (*BidderMacro) LoadImpression 

func (tag *BidderMacro) LoadImpression(imp *openrtb2.Imp) (*openrtb_ext.ExtImpVASTBidder, error)

LoadImpression will set current imp

func (*BidderMacro) LoadVASTTag 

func (tag *BidderMacro) LoadVASTTag(vastTag *openrtb_ext.ExtImpVASTBidderTag)

LoadVASTTag will set current VAST Tag details in bidder keys

func (*BidderMacro) MacroAppBundle 

func (tag *BidderMacro) MacroAppBundle(key string) string

MacroAppBundle contains definition for AppBundle Parameter

func (*BidderMacro) MacroAppID 

func (tag *BidderMacro) MacroAppID(key string) string

MacroAppID contains definition for AppID Parameter

func (*BidderMacro) MacroAppName 

func (tag *BidderMacro) MacroAppName(key string) string

MacroAppName contains definition for AppName Parameter

func (*BidderMacro) MacroAppPaid 

func (tag *BidderMacro) MacroAppPaid(key string) string

MacroAppPaid contains definition for AppPaid Parameter

func (*BidderMacro) MacroAppStoreURL 

func (tag *BidderMacro) MacroAppStoreURL(key string) string

MacroAppStoreURL contains definition for AppStoreURL Parameter

func (*BidderMacro) MacroAppVersion 

func (tag *BidderMacro) MacroAppVersion(key string) string

MacroAppVersion contains definition for AppVersion Parameter

func (*BidderMacro) MacroBidFloor 

func (tag *BidderMacro) MacroBidFloor(key string) string

MacroBidFloor contains definition for BidFloor Parameter

func (*BidderMacro) MacroBidFloorCurrency 

func (tag *BidderMacro) MacroBidFloorCurrency(key string) string

MacroBidFloorCurrency contains definition for BidFloorCurrency Parameter

func (*BidderMacro) MacroBlockedAdvertiser 

func (tag *BidderMacro) MacroBlockedAdvertiser(key string) string

MacroBlockedAdvertiser contains definition for BlockedAdvertiser Parameter

func (*BidderMacro) MacroBlockedApp 

func (tag *BidderMacro) MacroBlockedApp(key string) string

MacroBlockedApp contains definition for BlockedApp Parameter

func (*BidderMacro) MacroBlockedCategory 

func (tag *BidderMacro) MacroBlockedCategory(key string) string

MacroBlockedCategory contains definition for BlockedCategory Parameter

func (*BidderMacro) MacroBlockedSeat 

func (tag *BidderMacro) MacroBlockedSeat(key string) string

MacroBlockedSeat contains definition for Blockedseat Parameter

func (*BidderMacro) MacroCacheBuster 

func (tag *BidderMacro) MacroCacheBuster(key string) string

MacroCacheBuster contains definition for CacheBuster Parameter

func (*BidderMacro) MacroCategory 

func (tag *BidderMacro) MacroCategory(key string) string

MacroCategory contains definition for Category Parameter

func (*BidderMacro) MacroCity 

func (tag *BidderMacro) MacroCity(key string) string

MacroCity contains definition for City Parameter

func (*BidderMacro) MacroContentAlbum 

func (tag *BidderMacro) MacroContentAlbum(key string) string

MacroContentAlbum contains definition for ContentAlbum Parameter

func (*BidderMacro) MacroContentArtist 

func (tag *BidderMacro) MacroContentArtist(key string) string

MacroContentArtist contains definition for ContentArtist Parameter

func (*BidderMacro) MacroContentCategory 

func (tag *BidderMacro) MacroContentCategory(key string) string

MacroContentCategory contains definition for ContentCategory Parameter

func (*BidderMacro) MacroContentContentRating 

func (tag *BidderMacro) MacroContentContentRating(key string) string

MacroContentContentRating contains definition for ContentContentRating Parameter

func (*BidderMacro) MacroContentContext 

func (tag *BidderMacro) MacroContentContext(key string) string

MacroContentContext contains definition for ContentContext Parameter

func (*BidderMacro) MacroContentEmbeddable 

func (tag *BidderMacro) MacroContentEmbeddable(key string) string

MacroContentEmbeddable contains definition for ContentEmbeddable Parameter

func (*BidderMacro) MacroContentEpisode 

func (tag *BidderMacro) MacroContentEpisode(key string) string

MacroContentEpisode contains definition for ContentEpisode Parameter

func (*BidderMacro) MacroContentGenre 

func (tag *BidderMacro) MacroContentGenre(key string) string

MacroContentGenre contains definition for ContentGenre Parameter

func (*BidderMacro) MacroContentID 

func (tag *BidderMacro) MacroContentID(key string) string

MacroContentID contains definition for ContentID Parameter

func (*BidderMacro) MacroContentISrc 

func (tag *BidderMacro) MacroContentISrc(key string) string

MacroContentISrc contains definition for ContentISrc Parameter

func (*BidderMacro) MacroContentKeywords 

func (tag *BidderMacro) MacroContentKeywords(key string) string

MacroContentKeywords contains definition for ContentKeywords Parameter

func (*BidderMacro) MacroContentLanguage 

func (tag *BidderMacro) MacroContentLanguage(key string) string

MacroContentLanguage contains definition for ContentLanguage Parameter

func (*BidderMacro) MacroContentLength 

func (tag *BidderMacro) MacroContentLength(key string) string

MacroContentLength contains definition for ContentLength Parameter

func (*BidderMacro) MacroContentLiveStream 

func (tag *BidderMacro) MacroContentLiveStream(key string) string

MacroContentLiveStream contains definition for ContentLiveStream Parameter

func (*BidderMacro) MacroContentProductionQuality 

func (tag *BidderMacro) MacroContentProductionQuality(key string) string

MacroContentProductionQuality contains definition for ContentProductionQuality Parameter

func (*BidderMacro) MacroContentQAGMediaRating 

func (tag *BidderMacro) MacroContentQAGMediaRating(key string) string

MacroContentQAGMediaRating contains definition for ContentQAGMediaRating Parameter

func (*BidderMacro) MacroContentSeason 

func (tag *BidderMacro) MacroContentSeason(key string) string

MacroContentSeason contains definition for ContentSeason Parameter

func (*BidderMacro) MacroContentSeries 

func (tag *BidderMacro) MacroContentSeries(key string) string

MacroContentSeries contains definition for ContentSeries Parameter

func (*BidderMacro) MacroContentSourceRelationship 

func (tag *BidderMacro) MacroContentSourceRelationship(key string) string

MacroContentSourceRelationship contains definition for ContentSourceRelationship Parameter

func (*BidderMacro) MacroContentTitle 

func (tag *BidderMacro) MacroContentTitle(key string) string

MacroContentTitle contains definition for ContentTitle Parameter

func (*BidderMacro) MacroContentURL 

func (tag *BidderMacro) MacroContentURL(key string) string

MacroContentURL contains definition for ContentURL Parameter

func (*BidderMacro) MacroContentUserRating 

func (tag *BidderMacro) MacroContentUserRating(key string) string

MacroContentUserRating contains definition for ContentUserRating Parameter

func (*BidderMacro) MacroContentVideoQuality 

func (tag *BidderMacro) MacroContentVideoQuality(key string) string

MacroContentVideoQuality contains definition for ContentVideoQuality Parameter

func (*BidderMacro) MacroCoppa 

func (tag *BidderMacro) MacroCoppa(key string) string

MacroCoppa contains definition for Coppa Parameter

func (*BidderMacro) MacroCountry 

func (tag *BidderMacro) MacroCountry(key string) string

MacroCountry contains definition for Country Parameter

func (*BidderMacro) MacroCurrency 

func (tag *BidderMacro) MacroCurrency(key string) string

MacroCurrency contains definition for Currency Parameter

func (*BidderMacro) MacroDNT 

func (tag *BidderMacro) MacroDNT(key string) string

MacroDNT contains definition for DNT Parameter

func (*BidderMacro) MacroDeviceDIDMD5 

func (tag *BidderMacro) MacroDeviceDIDMD5(key string) string

MacroDeviceDIDMD5 contains definition for DeviceDIDMD5 Parameter

func (*BidderMacro) MacroDeviceDIDSHA1 

func (tag *BidderMacro) MacroDeviceDIDSHA1(key string) string

MacroDeviceDIDSHA1 contains definition for DeviceDIDSHA1 Parameter

func (*BidderMacro) MacroDeviceDPIDMD5 

func (tag *BidderMacro) MacroDeviceDPIDMD5(key string) string

MacroDeviceDPIDMD5 contains definition for DeviceDPIDMD5 Parameter

func (*BidderMacro) MacroDeviceDPIDSHA1 

func (tag *BidderMacro) MacroDeviceDPIDSHA1(key string) string

MacroDeviceDPIDSHA1 contains definition for DeviceDPIDSHA1 Parameter

func (*BidderMacro) MacroDeviceHeight 

func (tag *BidderMacro) MacroDeviceHeight(key string) string

MacroDeviceHeight contains definition for DeviceHeight Parameter

func (*BidderMacro) MacroDeviceIFA 

func (tag *BidderMacro) MacroDeviceIFA(key string) string

MacroDeviceIFA contains definition for DeviceIFA Parameter

func (*BidderMacro) MacroDeviceIFAType 

func (tag *BidderMacro) MacroDeviceIFAType(key string) string

MacroDeviceIFAType contains definition for DeviceIFAType

func (*BidderMacro) MacroDeviceJS 

func (tag *BidderMacro) MacroDeviceJS(key string) string

MacroDeviceJS contains definition for DeviceJS Parameter

func (*BidderMacro) MacroDeviceLanguage 

func (tag *BidderMacro) MacroDeviceLanguage(key string) string

MacroDeviceLanguage contains definition for DeviceLanguage Parameter

func (*BidderMacro) MacroDeviceMACMD5 

func (tag *BidderMacro) MacroDeviceMACMD5(key string) string

MacroDeviceMACMD5 contains definition for DeviceMACMD5 Parameter

func (*BidderMacro) MacroDeviceMACSHA1 

func (tag *BidderMacro) MacroDeviceMACSHA1(key string) string

MacroDeviceMACSHA1 contains definition for DeviceMACSHA1 Parameter

func (*BidderMacro) MacroDeviceOS 

func (tag *BidderMacro) MacroDeviceOS(key string) string

MacroDeviceOS contains definition for DeviceOS Parameter

func (*BidderMacro) MacroDeviceOSVersion 

func (tag *BidderMacro) MacroDeviceOSVersion(key string) string

MacroDeviceOSVersion contains definition for DeviceOSVersion Parameter

func (*BidderMacro) MacroDeviceType 

func (tag *BidderMacro) MacroDeviceType(key string) string

MacroDeviceType contains definition for DeviceType Parameter

func (*BidderMacro) MacroDeviceWidth 

func (tag *BidderMacro) MacroDeviceWidth(key string) string

MacroDeviceWidth contains definition for DeviceWidth Parameter

func (*BidderMacro) MacroDisplayManager 

func (tag *BidderMacro) MacroDisplayManager(key string) string

MacroDisplayManager contains definition for DisplayManager Parameter

func (*BidderMacro) MacroDisplayManagerVersion 

func (tag *BidderMacro) MacroDisplayManagerVersion(key string) string

MacroDisplayManagerVersion contains definition for DisplayManagerVersion Parameter

func (*BidderMacro) MacroDomain 

func (tag *BidderMacro) MacroDomain(key string) string

MacroDomain contains definition for Domain Parameter

func (*BidderMacro) MacroFD 

func (tag *BidderMacro) MacroFD(key string) string

MacroFD contains definition for FD Parameter

func (*BidderMacro) MacroGDPR 

func (tag *BidderMacro) MacroGDPR(key string) string

MacroGDPR contains definition for GDPR Parameter

func (*BidderMacro) MacroGDPRConsent 

func (tag *BidderMacro) MacroGDPRConsent(key string) string

MacroGDPRConsent contains definition for GDPRConsent Parameter

func (*BidderMacro) MacroGender 

func (tag *BidderMacro) MacroGender(key string) string

MacroGender contains definition for Gender Parameter

func (*BidderMacro) MacroIP 

func (tag *BidderMacro) MacroIP(key string) string

MacroIP contains definition for IP Parameter

func (*BidderMacro) MacroInterstitial 

func (tag *BidderMacro) MacroInterstitial(key string) string

MacroInterstitial contains definition for Interstitial Parameter

func (*BidderMacro) MacroKeywords 

func (tag *BidderMacro) MacroKeywords(key string) string

MacroKeywords contains definition for Keywords Parameter

func (*BidderMacro) MacroLMT 

func (tag *BidderMacro) MacroLMT(key string) string

MacroLMT contains definition for LMT Parameter

func (*BidderMacro) MacroLatitude 

func (tag *BidderMacro) MacroLatitude(key string) string

MacroLatitude contains definition for Latitude Parameter

func (*BidderMacro) MacroLongitude 

func (tag *BidderMacro) MacroLongitude(key string) string

MacroLongitude contains definition for Longitude Parameter

func (*BidderMacro) MacroMake 

func (tag *BidderMacro) MacroMake(key string) string

MacroMake contains definition for Make Parameter

func (*BidderMacro) MacroModel 

func (tag *BidderMacro) MacroModel(key string) string

MacroModel contains definition for Model Parameter

func (*BidderMacro) MacroPMP 

func (tag *BidderMacro) MacroPMP(key string) string

MacroPMP contains definition for PMP Parameter

func (*BidderMacro) MacroPageCategory 

func (tag *BidderMacro) MacroPageCategory(key string) string

MacroPageCategory contains definition for PageCategory Parameter

func (*BidderMacro) MacroPaymentIDChain 

func (tag *BidderMacro) MacroPaymentIDChain(key string) string

MacroPaymentIDChain contains definition for PaymentIDChain Parameter

func (*BidderMacro) MacroPrivacyPolicy 

func (tag *BidderMacro) MacroPrivacyPolicy(key string) string

MacroPrivacyPolicy contains definition for PrivacyPolicy Parameter

func (*BidderMacro) MacroProducerID 

func (tag *BidderMacro) MacroProducerID(key string) string

MacroProducerID contains definition for ProducerID Parameter

func (*BidderMacro) MacroProducerName 

func (tag *BidderMacro) MacroProducerName(key string) string

MacroProducerName contains definition for ProducerName Parameter

func (*BidderMacro) MacroPubDomain 

func (tag *BidderMacro) MacroPubDomain(key string) string

MacroPubDomain contains definition for PubDomain Parameter

func (*BidderMacro) MacroPubID 

func (tag *BidderMacro) MacroPubID(key string) string

MacroPubID contains definition for PubID Parameter

func (*BidderMacro) MacroPubName 

func (tag *BidderMacro) MacroPubName(key string) string

MacroPubName contains definition for PubName Parameter

func (*BidderMacro) MacroRegion 

func (tag *BidderMacro) MacroRegion(key string) string

MacroRegion contains definition for Region Parameter

func (*BidderMacro) MacroSectionCategory 

func (tag *BidderMacro) MacroSectionCategory(key string) string

MacroSectionCategory contains definition for SectionCategory Parameter

func (*BidderMacro) MacroSecure 

func (tag *BidderMacro) MacroSecure(key string) string

MacroSecure contains definition for Secure Parameter

func (*BidderMacro) MacroSiteID 

func (tag *BidderMacro) MacroSiteID(key string) string

MacroSiteID contains definition for SiteID Parameter

func (*BidderMacro) MacroSiteMobile 

func (tag *BidderMacro) MacroSiteMobile(key string) string

MacroSiteMobile contains definition for SiteMobile Parameter

func (*BidderMacro) MacroSiteName 

func (tag *BidderMacro) MacroSiteName(key string) string

MacroSiteName contains definition for SiteName Parameter

func (*BidderMacro) MacroSitePage 

func (tag *BidderMacro) MacroSitePage(key string) string

MacroSitePage contains definition for SitePage Parameter

func (*BidderMacro) MacroSiteReferrer 

func (tag *BidderMacro) MacroSiteReferrer(key string) string

MacroSiteReferrer contains definition for SiteReferrer Parameter

func (*BidderMacro) MacroSiteSearch 

func (tag *BidderMacro) MacroSiteSearch(key string) string

MacroSiteSearch contains definition for SiteSearch Parameter

func (*BidderMacro) MacroTagID 

func (tag *BidderMacro) MacroTagID(key string) string

MacroTagID contains definition for TagID Parameter

func (*BidderMacro) MacroTest 

func (tag *BidderMacro) MacroTest(key string) string

MacroTest contains definition for Test Parameter

func (*BidderMacro) MacroTimeout 

func (tag *BidderMacro) MacroTimeout(key string) string

MacroTimeout contains definition for Timeout Parameter

func (*BidderMacro) MacroTransactionID 

func (tag *BidderMacro) MacroTransactionID(key string) string

MacroTransactionID contains definition for TransactionID Parameter

func (*BidderMacro) MacroUSPrivacy 

func (tag *BidderMacro) MacroUSPrivacy(key string) string

MacroUSPrivacy contains definition for USPrivacy Parameter

func (*BidderMacro) MacroUTCOffset 

func (tag *BidderMacro) MacroUTCOffset(key string) string

MacroUTCOffset contains definition for UTCOffset Parameter

func (*BidderMacro) MacroUserAgent 

func (tag *BidderMacro) MacroUserAgent(key string) string

MacroUserAgent contains definition for UserAgent Parameter

func (*BidderMacro) MacroUserID 

func (tag *BidderMacro) MacroUserID(key string) string

MacroUserID contains definition for UserID Parameter

func (*BidderMacro) MacroVideoAPI 

func (tag *BidderMacro) MacroVideoAPI(key string) string

MacroVideoAPI contains definition for VideoAPI Parameter

func (*BidderMacro) MacroVideoBlockedAttribute 

func (tag *BidderMacro) MacroVideoBlockedAttribute(key string) string

MacroVideoBlockedAttribute contains definition for VideoBlockedAttribute Parameter

func (*BidderMacro) MacroVideoBoxing 

func (tag *BidderMacro) MacroVideoBoxing(key string) string

MacroVideoBoxing contains definition for VideoBoxing Parameter

func (*BidderMacro) MacroVideoDelivery 

func (tag *BidderMacro) MacroVideoDelivery(key string) string

MacroVideoDelivery contains definition for VideoDelivery Parameter

func (*BidderMacro) MacroVideoLinearity 

func (tag *BidderMacro) MacroVideoLinearity(key string) string

MacroVideoLinearity contains definition for VideoLinearity Parameter

func (*BidderMacro) MacroVideoMIMES 

func (tag *BidderMacro) MacroVideoMIMES(key string) string

MacroVideoMIMES contains definition for VideoMIMES Parameter

func (*BidderMacro) MacroVideoMaximumBitRate 

func (tag *BidderMacro) MacroVideoMaximumBitRate(key string) string

MacroVideoMaximumBitRate contains definition for VideoMaximumBitRate Parameter

func (*BidderMacro) MacroVideoMaximumDuration 

func (tag *BidderMacro) MacroVideoMaximumDuration(key string) string

MacroVideoMaximumDuration contains definition for VideoMaximumDuration Parameter

func (*BidderMacro) MacroVideoMaximumExtended 

func (tag *BidderMacro) MacroVideoMaximumExtended(key string) string

MacroVideoMaximumExtended contains definition for VideoMaximumExtended Parameter

func (*BidderMacro) MacroVideoMinimumBitRate 

func (tag *BidderMacro) MacroVideoMinimumBitRate(key string) string

MacroVideoMinimumBitRate contains definition for VideoMinimumBitRate Parameter

func (*BidderMacro) MacroVideoMinimumDuration 

func (tag *BidderMacro) MacroVideoMinimumDuration(key string) string

MacroVideoMinimumDuration contains definition for VideoMinimumDuration Parameter

func (*BidderMacro) MacroVideoPlacement 

func (tag *BidderMacro) MacroVideoPlacement(key string) string

MacroVideoPlacement contains definition for VideoPlacement Parameter

func (*BidderMacro) MacroVideoPlaybackMethod 

func (tag *BidderMacro) MacroVideoPlaybackMethod(key string) string

MacroVideoPlaybackMethod contains definition for VideoPlaybackMethod Parameter

func (*BidderMacro) MacroVideoPlayerHeight 

func (tag *BidderMacro) MacroVideoPlayerHeight(key string) string

MacroVideoPlayerHeight contains definition for VideoPlayerHeight Parameter

func (*BidderMacro) MacroVideoPlayerWidth 

func (tag *BidderMacro) MacroVideoPlayerWidth(key string) string

MacroVideoPlayerWidth contains definition for VideoPlayerWidth Parameter

func (*BidderMacro) MacroVideoPosition 

func (tag *BidderMacro) MacroVideoPosition(key string) string

MacroVideoPosition contains definition for VideoPosition Parameter

func (*BidderMacro) MacroVideoProtocols 

func (tag *BidderMacro) MacroVideoProtocols(key string) string

MacroVideoProtocols contains definition for VideoProtocols Parameter

func (*BidderMacro) MacroVideoSequence 

func (tag *BidderMacro) MacroVideoSequence(key string) string

MacroVideoSequence contains definition for VideoSequence Parameter

func (*BidderMacro) MacroVideoSkip 

func (tag *BidderMacro) MacroVideoSkip(key string) string

MacroVideoSkip contains definition for VideoSkip Parameter

func (*BidderMacro) MacroVideoSkipAfter 

func (tag *BidderMacro) MacroVideoSkipAfter(key string) string

MacroVideoSkipAfter contains definition for VideoSkipAfter Parameter

func (*BidderMacro) MacroVideoSkipMinimum 

func (tag *BidderMacro) MacroVideoSkipMinimum(key string) string

MacroVideoSkipMinimum contains definition for VideoSkipMinimum Parameter

func (*BidderMacro) MacroVideoStartDelay 

func (tag *BidderMacro) MacroVideoStartDelay(key string) string

MacroVideoStartDelay contains definition for VideoStartDelay Parameter

func (*BidderMacro) MacroWhitelistLang 

func (tag *BidderMacro) MacroWhitelistLang(key string) string

MacroWhitelistLang contains definition for WhitelistLang Parameter

func (*BidderMacro) MacroWhitelistSeat 

func (tag *BidderMacro) MacroWhitelistSeat(key string) string

MacroWhitelistSeat contains definition for WhitelistSeat Parameter

func (*BidderMacro) MacroYearOfBirth 

func (tag *BidderMacro) MacroYearOfBirth(key string) string

MacroYearOfBirth contains definition for YearOfBirth Parameter

func (*BidderMacro) MacroZip 

func (tag *BidderMacro) MacroZip(key string) string

MacroZip contains definition for Zip Parameter

func (*BidderMacro) SetAdapterConfig 

func (tag *BidderMacro) SetAdapterConfig(conf *config.Adapter)

SetAdapterConfig will set Adapter config

type HandlerType 

type HandlerType string

HandlerType list of tag based response handlers 

const (
	VASTTagHandlerType HandlerType = `vasttag`
)

type IBidderMacro 

type IBidderMacro interface {
	//Helper Function
	InitBidRequest(request *openrtb2.BidRequest)
	LoadImpression(imp *openrtb2.Imp) (*openrtb_ext.ExtImpVASTBidder, error)
	LoadVASTTag(tag *openrtb_ext.ExtImpVASTBidderTag)
	GetBidderKeys() map[string]string
	SetAdapterConfig(*config.Adapter)
	GetURI() string
	GetHeaders() http.Header

	//Request
	MacroTest(string) string
	MacroTimeout(string) string
	MacroWhitelistSeat(string) string
	MacroWhitelistLang(string) string
	MacroBlockedSeat(string) string
	MacroCurrency(string) string
	MacroBlockedCategory(string) string
	MacroBlockedAdvertiser(string) string
	MacroBlockedApp(string) string

	//Source
	MacroFD(string) string
	MacroTransactionID(string) string
	MacroPaymentIDChain(string) string

	//Regs
	MacroCoppa(string) string

	//Impression
	MacroDisplayManager(string) string
	MacroDisplayManagerVersion(string) string
	MacroInterstitial(string) string
	MacroTagID(string) string
	MacroBidFloor(string) string
	MacroBidFloorCurrency(string) string
	MacroSecure(string) string
	MacroPMP(string) string

	//Video
	MacroVideoMIMES(string) string
	MacroVideoMinimumDuration(string) string
	MacroVideoMaximumDuration(string) string
	MacroVideoProtocols(string) string
	MacroVideoPlayerWidth(string) string
	MacroVideoPlayerHeight(string) string
	MacroVideoStartDelay(string) string
	MacroVideoPlacement(string) string
	MacroVideoLinearity(string) string
	MacroVideoSkip(string) string
	MacroVideoSkipMinimum(string) string
	MacroVideoSkipAfter(string) string
	MacroVideoSequence(string) string
	MacroVideoBlockedAttribute(string) string
	MacroVideoMaximumExtended(string) string
	MacroVideoMinimumBitRate(string) string
	MacroVideoMaximumBitRate(string) string
	MacroVideoBoxing(string) string
	MacroVideoPlaybackMethod(string) string
	MacroVideoDelivery(string) string
	MacroVideoPosition(string) string
	MacroVideoAPI(string) string

	//Site
	MacroSiteID(string) string
	MacroSiteName(string) string
	MacroSitePage(string) string
	MacroSiteReferrer(string) string
	MacroSiteSearch(string) string
	MacroSiteMobile(string) string

	//App
	MacroAppID(string) string
	MacroAppName(string) string
	MacroAppBundle(string) string
	MacroAppStoreURL(string) string
	MacroAppVersion(string) string
	MacroAppPaid(string) string

	//SiteAppCommon
	MacroCategory(string) string
	MacroDomain(string) string
	MacroSectionCategory(string) string
	MacroPageCategory(string) string
	MacroPrivacyPolicy(string) string
	MacroKeywords(string) string

	//Publisher
	MacroPubID(string) string
	MacroPubName(string) string
	MacroPubDomain(string) string

	//Content
	MacroContentID(string) string
	MacroContentEpisode(string) string
	MacroContentTitle(string) string
	MacroContentSeries(string) string
	MacroContentSeason(string) string
	MacroContentArtist(string) string
	MacroContentGenre(string) string
	MacroContentAlbum(string) string
	MacroContentISrc(string) string
	MacroContentURL(string) string
	MacroContentCategory(string) string
	MacroContentProductionQuality(string) string
	MacroContentVideoQuality(string) string
	MacroContentContext(string) string
	MacroContentContentRating(string) string
	MacroContentUserRating(string) string
	MacroContentQAGMediaRating(string) string
	MacroContentKeywords(string) string
	MacroContentLiveStream(string) string
	MacroContentSourceRelationship(string) string
	MacroContentLength(string) string
	MacroContentLanguage(string) string
	MacroContentEmbeddable(string) string

	//Producer
	MacroProducerID(string) string
	MacroProducerName(string) string

	//Device
	MacroUserAgent(string) string
	MacroDNT(string) string
	MacroLMT(string) string
	MacroIP(string) string
	MacroDeviceType(string) string
	MacroMake(string) string
	MacroModel(string) string
	MacroDeviceOS(string) string
	MacroDeviceOSVersion(string) string
	MacroDeviceWidth(string) string
	MacroDeviceHeight(string) string
	MacroDeviceJS(string) string
	MacroDeviceLanguage(string) string
	MacroDeviceIFA(string) string
	MacroDeviceIFAType(string) string
	MacroDeviceDIDSHA1(string) string
	MacroDeviceDIDMD5(string) string
	MacroDeviceDPIDSHA1(string) string
	MacroDeviceDPIDMD5(string) string
	MacroDeviceMACSHA1(string) string
	MacroDeviceMACMD5(string) string

	//Geo
	MacroLatitude(string) string
	MacroLongitude(string) string
	MacroCountry(string) string
	MacroRegion(string) string
	MacroCity(string) string
	MacroZip(string) string
	MacroUTCOffset(string) string

	//User
	MacroUserID(string) string
	MacroYearOfBirth(string) string
	MacroGender(string) string

	//Extension
	MacroGDPRConsent(string) string
	MacroGDPR(string) string
	MacroUSPrivacy(string) string

	//Additional
	MacroCacheBuster(string) string
	// contains filtered or unexported methods
}

IBidderMacro interface will capture all macro definition

func GetNewBidderMacro 

func GetNewBidderMacro(bidder openrtb_ext.BidderName) IBidderMacro

GetNewBidderMacro will return IBidderMacro of specific bidder

func NewBidderMacro 

func NewBidderMacro() IBidderMacro

NewBidderMacro contains definition for all openrtb macro's

type ITagRequestHandler 

type ITagRequestHandler interface {
	MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error)
}

ITagRequestHandler parse bidder request

func GetRequestHandler 

func GetRequestHandler(responseType HandlerType) (ITagRequestHandler, error)

type ITagResponseHandler 

type ITagResponseHandler interface {
	Validate(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) []error
	MakeBids(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error)
}

ITagResponseHandler parse bidder response

func GetResponseHandler 

func GetResponseHandler(responseType HandlerType) (ITagResponseHandler, error)

GetResponseHandler returns response handler

type IVASTTagResponseHandler 

type IVASTTagResponseHandler interface {
	ITagResponseHandler
	ParseExtension(version string, tag *etree.Element, bid *adapters.TypedBid) []error
	GetStaticPrice(ext json.RawMessage) float64
}

IVASTTagResponseHandler to parse VAST Tag

type MacroProcessor 

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

MacroProcessor struct to hold openrtb request and cache values

func NewMacroProcessor 

func NewMacroProcessor(bidderMacro IBidderMacro, mapper Mapper) *MacroProcessor

NewMacroProcessor will process macro's of openrtb bid request

func (*MacroProcessor) Process 

func (mp *MacroProcessor) Process(in string) (response string)

Process : Substitute macros in input string

func (*MacroProcessor) SetBidderKeys 

func (mp *MacroProcessor) SetBidderKeys(keys map[string]string)

SetBidderKeys will flush and set bidder specific keys

func (*MacroProcessor) SetMacro 

func (mp *MacroProcessor) SetMacro(key, value string)

SetMacro Adding Custom Macro Manually

type Mapper 

type Mapper map[string]*macroCallBack

Mapper will map macro with its respective call back function

func GetDefaultMapper 

func GetDefaultMapper() Mapper

GetDefaultMapper will return clone of default Mapper function

type TagBidder 

type TagBidder struct {
	adapters.Bidder
	// contains filtered or unexported fields
}

TagBidder is default implementation of ITagBidder

func NewTagBidder 

func NewTagBidder(bidderName openrtb_ext.BidderName, config config.Adapter) *TagBidder

NewTagBidder is an constructor for TagBidder

func (*TagBidder) MakeBids 

func (a *TagBidder) MakeBids(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error)

MakeBids makes bids

func (*TagBidder) MakeRequests 

func (a *TagBidder) MakeRequests(request *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error)

MakeRequests will contains default definition for processing queries

type VASTTagResponseHandler 

type VASTTagResponseHandler struct {
	IVASTTagResponseHandler
	ImpBidderExt *openrtb_ext.ExtImpVASTBidder
	VASTTag      *openrtb_ext.ExtImpVASTBidderTag
}

VASTTagResponseHandler to parse VAST Tag

func NewVASTTagResponseHandler 

func NewVASTTagResponseHandler() *VASTTagResponseHandler

NewVASTTagResponseHandler returns new object

func (*VASTTagResponseHandler) MakeBids 

func (handler *VASTTagResponseHandler) MakeBids(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error)

MakeBids will return bids

func (*VASTTagResponseHandler) ParseExtension 

func (handler *VASTTagResponseHandler) ParseExtension(version string, ad *etree.Element, bid *adapters.TypedBid) []error

ParseExtension will parse VAST XML extension object

func (*VASTTagResponseHandler) Validate 

func (handler *VASTTagResponseHandler) Validate(internalRequest *openrtb2.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) []error

Validate will return bids

Source Files

View all Source files

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.