Versions in this module Expand all Collapse all v3 v3.5.0 Dec 16, 2024 v3.4.0 Dec 10, 2024 v3.3.0 Nov 26, 2024 v3.2.0 Nov 13, 2024 v3.1.0 Oct 31, 2024 Changes in this version + const AdCertsSignerModeInprocess + const AdCertsSignerModeOff + const AdCertsSignerModeRemote + const MIN_COOKIE_SIZE_BYTES + const SyncResponseFormatIFrame + const SyncResponseFormatRedirect + const TCF2EnforceAlgoBasic + const TCF2EnforceAlgoFull + const ValidationEnforce + const ValidationSkip + const ValidationWarn + var ErrInProcessSignerInvalidPrivateKey = errors.New("private key for inprocess signer cannot be empty") + var ErrMsgInProcessSignerInvalidDNSCheckInterval = "invalid dns check interval for inprocess signer" + var ErrMsgInProcessSignerInvalidDNSRenewalInterval = "invalid dns renewal interval for inprocess signer" + var ErrMsgInProcessSignerInvalidURL = "invalid url for inprocess signer" + var ErrMsgInvalidRemoteSignerSigningTimeout = "invalid signing timeout for remote signer" + var ErrMsgInvalidRemoteSignerURL = "invalid url for remote signer" + var ErrSignerModeIncorrect = errors.New("signer mode is not specified, specify 'off', 'inprocess' or 'remote'") + var ResolvedInterstitialSizes = []InterstitialSize + func SetupViper(v *viper.Viper, filename string, bidderInfos BidderInfos) + func UnpackDSADefault(dsa *AccountDSA) error + type Account struct + AlternateBidderCodes *openrtb_ext.ExtAlternateBidderCodes + BidAdjustments *openrtb_ext.ExtRequestPrebidBidAdjustments + CCPA AccountCCPA + CacheTTL DefaultTTLs + CookieSync CookieSync + DebugAllow bool + DefaultBidLimit int + DefaultIntegration string + Disabled bool + Events Events + GDPR AccountGDPR + Hooks AccountHooks + ID string + PriceFloors AccountPriceFloors + Privacy AccountPrivacy + TruncateTargetAttribute *int + Validations Validations + type AccountCCPA struct + ChannelEnabled AccountChannel + Enabled *bool + func (a *AccountCCPA) EnabledForChannelType(channelType ChannelType) *bool + type AccountChannel struct + AMP *bool + App *bool + DOOH *bool + Video *bool + Web *bool + func (a *AccountChannel) GetByChannelType(channelType ChannelType) *bool + type AccountDSA struct + Default string + DefaultUnpacked *openrtb_ext.ExtRegsDSA + GDPROnly bool + type AccountFloorFetch struct + AccountID string + Enabled bool + MaxAge int + MaxFileSizeKB int + MaxRules int + MaxSchemaDims int + Period int + Timeout int + URL string + type AccountGDPR struct + BasicEnforcementVendors []string + BasicEnforcementVendorsMap map[string]struct{} + ChannelEnabled AccountChannel + Enabled *bool + Purpose1 AccountGDPRPurpose + Purpose10 AccountGDPRPurpose + Purpose2 AccountGDPRPurpose + Purpose3 AccountGDPRPurpose + Purpose4 AccountGDPRPurpose + Purpose5 AccountGDPRPurpose + Purpose6 AccountGDPRPurpose + Purpose7 AccountGDPRPurpose + Purpose8 AccountGDPRPurpose + Purpose9 AccountGDPRPurpose + PurposeConfigs map[consentconstants.Purpose]*AccountGDPRPurpose + PurposeOneTreatment AccountGDPRPurposeOneTreatment + SpecialFeature1 AccountGDPRSpecialFeature + func (a *AccountGDPR) EnabledForChannelType(channelType ChannelType) *bool + func (a *AccountGDPR) FeatureOneEnforced() (value, exists bool) + func (a *AccountGDPR) FeatureOneVendorException(bidder openrtb_ext.BidderName) (value, exists bool) + func (a *AccountGDPR) PurposeEnforced(purpose consentconstants.Purpose) (value, exists bool) + func (a *AccountGDPR) PurposeEnforcementAlgo(purpose consentconstants.Purpose) (value TCF2EnforcementAlgo, exists bool) + func (a *AccountGDPR) PurposeEnforcingVendors(purpose consentconstants.Purpose) (value, exists bool) + func (a *AccountGDPR) PurposeOneTreatmentAccessAllowed() (value, exists bool) + func (a *AccountGDPR) PurposeOneTreatmentEnabled() (value, exists bool) + func (a *AccountGDPR) PurposeVendorExceptions(purpose consentconstants.Purpose) (value map[string]struct{}, exists bool) + type AccountGDPRPurpose struct + EnforceAlgo string + EnforceAlgoID TCF2EnforcementAlgo + EnforcePurpose *bool + EnforceVendors *bool + VendorExceptionMap map[string]struct{} + VendorExceptions []string + type AccountGDPRPurposeOneTreatment struct + AccessAllowed *bool + Enabled *bool + type AccountGDPRSpecialFeature struct + Enforce *bool + VendorExceptionMap map[openrtb_ext.BidderName]struct{} + VendorExceptions []openrtb_ext.BidderName + type AccountHooks struct + ExecutionPlan HookExecutionPlan + Modules AccountModules + type AccountModules map[string]map[string]json.RawMessage + func (m AccountModules) ModuleConfig(id string) (json.RawMessage, error) + type AccountPriceFloors struct + AdjustForBidAdjustment bool + Enabled bool + EnforceDealFloors bool + EnforceFloorsRate int + Fetcher AccountFloorFetch + MaxRule int + MaxSchemaDims int + UseDynamicData bool + func (pf *AccountPriceFloors) IsAdjustForBidAdjustmentEnabled() bool + type AccountPrivacy struct + AllowActivities *AllowActivities + DSA *AccountDSA + IPv4Config IPv4 + IPv6Config IPv6 + PrivacySandbox PrivacySandbox + type Activity struct + Default *bool + Rules []ActivityRule + type ActivityCondition struct + ComponentName []string + ComponentType []string + type ActivityRule struct + Allow bool + Condition ActivityCondition + type Adapter struct + AppSecret string + Endpoint string + ExtraAdapterInfo string + PlatformID string + XAPI AdapterXAPI + type AdapterXAPI struct + Password string + Tracker string + Username string + type Admin struct + Enabled bool + type AdsCertInProcess struct + DNSCheckIntervalInSeconds int + DNSRenewalIntervalInSeconds int + Origin string + PrivateKey string + type AdsCertRemote struct + SigningTimeoutMs int + Url string + type AgmaAnalytics struct + Accounts []AgmaAnalyticsAccount + Buffers AgmaAnalyticsBuffer + Enabled bool + Endpoint AgmaAnalyticsHttpEndpoint + type AgmaAnalyticsAccount struct + Code string + PublisherId string + SiteAppId string + type AgmaAnalyticsBuffer struct + BufferSize string + EventCount int + Timeout string + type AgmaAnalyticsHttpEndpoint struct + Gzip bool + Timeout string + Url string + type AllowActivities struct + EnrichUserFPD Activity + FetchBids Activity + ReportAnalytics Activity + SyncUser Activity + TransmitPreciseGeo Activity + TransmitTids Activity + TransmitUniqueRequestIds Activity + TransmitUserFPD Activity + type Analytics struct + Agma AgmaAnalytics + File FileLogs + Pubstack Pubstack + type AuctionTimeouts struct + Default uint64 + Max uint64 + func (cfg *AuctionTimeouts) LimitAuctionTimeout(requested time.Duration) time.Duration + type BidderAdsCert struct + Enabled bool + type BidderInfo struct + AliasOf string + AppSecret string + Capabilities *CapabilitiesInfo + Debug *DebugInfo + Disabled bool + Endpoint string + EndpointCompression string + Experiment BidderInfoExperiment + ExtraAdapterInfo string + GVLVendorID uint16 + Maintainer *MaintainerInfo + ModifyingVastXmlAllowed bool + OpenRTB *OpenRTBInfo + PlatformID string + Syncer *Syncer + XAPI AdapterXAPI + func (bi BidderInfo) IsEnabled() bool + type BidderInfoExperiment struct + AdsCert BidderAdsCert + type BidderInfos map[string]BidderInfo + func LoadBidderInfo(reader InfoReader) (BidderInfos, error) + func LoadBidderInfoFromDisk(path string) (BidderInfos, error) + func (infos BidderInfos) ToGVLVendorIDMap() map[openrtb_ext.BidderName]uint16 + type CCPA struct + Enforce bool + type Cache struct + DefaultTTLs DefaultTTLs + ExpectedTimeMillis int + Host string + Query string + Scheme string + func (cfg *Cache) GetBaseURL() string + type CacheEventsConfig struct + Enabled bool + Endpoint string + type CapabilitiesInfo struct + App *PlatformInfo + DOOH *PlatformInfo + Site *PlatformInfo + type ChannelType string + const ChannelAMP + const ChannelApp + const ChannelDOOH + const ChannelVideo + const ChannelWeb + type Compression struct + Request CompressionInfo + Response CompressionInfo + type CompressionInfo struct + GZIP bool + func (cfg *CompressionInfo) IsSupported(contentEncoding httputil.ContentEncoding) bool + type Configuration struct + AMPTimeoutAdjustment int64 + AccountDefaults Account + AccountRequired bool + Accounts StoredRequests + Admin Admin + AdminPort int + Analytics Analytics + AuctionTimeouts AuctionTimeouts + AutoGenSourceTID bool + BidderInfos BidderInfos + BlockedApps []string + BlockedAppsLookup map[string]bool + CCPA CCPA + CacheClient HTTPClient + CacheURL Cache + CategoryMapping StoredRequests + Client HTTPClient + Compression Compression + CurrencyConverter CurrencyConverter + DataCenter string + Debug Debug + DefReqConfig DefReqConfig + Event Event + Experiment Experiment + ExtCacheURL ExternalCache + ExternalURL string + GDPR GDPR + GarbageCollectorThreshold int + GenerateBidID bool + GenerateRequestID bool + Hooks Hooks + Host string + HostCookie HostCookie + HostSChainNode *openrtb2.SupplyChainNode + LMT LMT + MaxRequestSize int64 + Metrics Metrics + PemCertsFile string + Port int + PriceFloors PriceFloors + RecaptchaSecret string + RequestTimeoutHeaders RequestTimeoutHeaders + RequestValidation RequestValidation + StatusResponse string + StoredRequests StoredRequests + StoredRequestsAMP StoredRequests + StoredRequestsTimeout int + StoredResponses StoredRequests + StoredVideo StoredRequests + TmaxAdjustments TmaxAdjustments + UnixSocketEnable bool + UnixSocketName string + UserSync UserSync + VTrack VTrack + Validations Validations + VideoStoredRequestRequired bool + func New(v *viper.Viper, bidderInfos BidderInfos, ...) (*Configuration, error) + func (cfg *Configuration) AccountDefaultsJSON() json.RawMessage + func (cfg *Configuration) GetCachedAssetURL(uuid string) string + func (cfg *Configuration) MarshalAccountDefaults() error + type Cookie struct + Name string + Value string + type CookieDeprecation struct + Enabled bool + TTLSec int + type CookieSync struct + DefaultCoopSync *bool + DefaultLimit *int + MaxLimit *int + type CurrencyConverter struct + FetchIntervalSeconds int + FetchURL string + StaleRatesSeconds int + type DataType string + const AMPRequestDataType + const AccountDataType + const CategoryDataType + const RequestDataType + const ResponseDataType + const VideoDataType + func (dataType DataType) Section() string + type DatabaseCacheInitializer struct + AmpQuery string + Query string + Timeout int + type DatabaseConfig struct + CacheInitialization DatabaseCacheInitializer + ConnectionInfo DatabaseConnection + FetcherQueries DatabaseFetcherQueries + PollUpdates DatabaseUpdatePolling + type DatabaseConnection struct + Database string + Driver string + Host string + Password string + Port int + QueryString string + TLS TLS + Username string + type DatabaseFetcherQueries struct + AmpQueryTemplate string + QueryTemplate string + type DatabaseUpdatePolling struct + AmpQuery string + Query string + RefreshRate int + Timeout int + type Debug struct + OverrideToken string + TimeoutNotification TimeoutNotification + type DebugInfo struct + Allow bool + type DefReqConfig struct + AliasInfo bool + FileSystem DefReqFiles + Type string + type DefReqFiles struct + FileName string + type DefaultTTLs struct + Audio int + Banner int + Native int + Video int + type DisabledMetrics struct + AccountAdapterDetails bool + AccountDebug bool + AccountModulesMetrics bool + AccountStoredResponses bool + AdapterBuyerUIDScrubbed bool + AdapterConnectionMetrics bool + AdapterGDPRRequestBlocked bool + type Event struct + TimeoutMS int64 + type Events struct + DefaultURL string + Enabled bool + VASTEvents []VASTEvent + type Experiment struct + AdCerts ExperimentAdsCert + type ExperimentAdsCert struct + InProcess AdsCertInProcess + Mode string + Remote AdsCertRemote + type ExternalCache struct + Host string + Path string + Scheme string + type FileFetcherConfig struct + Enabled bool + Path string + type FileLogs struct + Filename string + type GDPR struct + AMPException bool + DefaultValue string + EEACountries []string + EEACountriesMap map[string]struct{} + Enabled bool + HostVendorID int + NonStandardPublisherMap map[string]struct{} + NonStandardPublishers []string + TCF2 TCF2 + Timeouts GDPRTimeouts + type GDPRTimeouts struct + ActiveVendorlistFetch int + InitVendorlistFetch int + func (t *GDPRTimeouts) ActiveTimeout() time.Duration + func (t *GDPRTimeouts) InitTimeout() time.Duration + type HTTPClient struct + IdleConnTimeout int + MaxConnsPerHost int + MaxIdleConns int + MaxIdleConnsPerHost int + type HTTPEventsConfig struct + AmpEndpoint string + Endpoint string + RefreshRate int64 + Timeout int + func (cfg HTTPEventsConfig) RefreshRateDuration() time.Duration + func (cfg HTTPEventsConfig) TimeoutDuration() time.Duration + type HTTPFetcherConfig struct + AmpEndpoint string + Endpoint string + type HookExecutionGroup struct + HookSequence []struct{ ... } + Timeout int + type HookExecutionPlan struct + Endpoints map[string]struct{ ... } + type Hooks struct + DefaultAccountExecutionPlan HookExecutionPlan + Enabled bool + HostExecutionPlan HookExecutionPlan + Modules Modules + type HostCookie struct + CookieName string + Domain string + Family string + MaxCookieSizeBytes int + OptInURL string + OptOutCookie Cookie + OptOutURL string + TTL int64 + func (cfg *HostCookie) TTLDuration() time.Duration + type IPv4 struct + AnonKeepBits int + func (ip *IPv4) Validate(errs []error) []error + type IPv6 struct + AnonKeepBits int + func (ip *IPv6) Validate(errs []error) []error + type InMemoryCache struct + ImpCacheSize int + RequestCacheSize int + RespCacheSize int + Size int + TTL int + Type string + type InfluxMetrics struct + AlignTimestamps bool + Database string + Host string + Measurement string + MetricSendInterval int + Password string + Username string + type InfoReader interface + Read func() (map[string][]byte, error) + type InfoReaderFromDisk struct + Path string + func (r InfoReaderFromDisk) Read() (map[string][]byte, error) + type InterstitialSize struct + Height uint64 + Width uint64 + type LMT struct + Enforce bool + type MaintainerInfo struct + Email string + type Metrics struct + Disabled DisabledMetrics + Influxdb InfluxMetrics + Prometheus PrometheusMetrics + type Modules map[string]map[string]interface + type OpenRTBInfo struct + GPPSupported bool + Version string + type PlatformInfo struct + MediaTypes []openrtb_ext.BidType + type PriceFloorFetcher struct + CacheSize int + Capacity int + HttpClient HTTPClient + MaxRetries int + Worker int + type PriceFloors struct + Enabled bool + Fetcher PriceFloorFetcher + type Privacy struct + CCPA CCPA + GDPR GDPR + LMT LMT + type PrivacySandbox struct + CookieDeprecation CookieDeprecation + TopicsDomain string + type PrometheusMetrics struct + Namespace string + Port int + Subsystem string + TimeoutMillisRaw int + func (m *PrometheusMetrics) Timeout() time.Duration + type Pubstack struct + Buffers PubstackBuffer + ConfRefresh string + Enabled bool + IntakeUrl string + ScopeId string + type PubstackBuffer struct + BufferSize string + EventCount int + Timeout string + type RequestTimeoutHeaders struct + RequestTimeInQueue string + RequestTimeoutInQueue string + type RequestValidation struct + IPv4PrivateNetworks []string + IPv4PrivateNetworksParsed []net.IPNet + IPv6PrivateNetworks []string + IPv6PrivateNetworksParsed []net.IPNet + func (r *RequestValidation) Parse() error + type Server struct + DataCenter string + ExternalUrl string + GvlID int + func (server *Server) Empty() bool + type SkipWhen struct + GDPR bool + GPPSID []string + type StoredRequests struct + CacheEvents CacheEventsConfig + Database DatabaseConfig + Files FileFetcherConfig + HTTP HTTPFetcherConfig + HTTPEvents HTTPEventsConfig + InMemoryCache InMemoryCache + func (sr *StoredRequests) DataType() DataType + func (sr *StoredRequests) Section() string + func (sr *StoredRequests) SetDataType(dataType DataType) + type Syncer struct + Enabled *bool + ExternalURL string + FormatOverride string + IFrame *SyncerEndpoint + Key string + Redirect *SyncerEndpoint + SkipWhen *SkipWhen + SupportCORS *bool + Supports []string + func (s *Syncer) Defined() bool + func (s *Syncer) Override(original *Syncer) *Syncer + type SyncerEndpoint struct + ExternalURL string + RedirectURL string + URL string + UserMacro string + func (s *SyncerEndpoint) Override(original *SyncerEndpoint) *SyncerEndpoint + type TCF2 struct + Enabled bool + Purpose1 TCF2Purpose + Purpose10 TCF2Purpose + Purpose2 TCF2Purpose + Purpose3 TCF2Purpose + Purpose4 TCF2Purpose + Purpose5 TCF2Purpose + Purpose6 TCF2Purpose + Purpose7 TCF2Purpose + Purpose8 TCF2Purpose + Purpose9 TCF2Purpose + PurposeConfigs map[consentconstants.Purpose]*TCF2Purpose + PurposeOneTreatment TCF2PurposeOneTreatment + SpecialFeature1 TCF2SpecialFeature + func (t *TCF2) ChannelEnabled(channelType ChannelType) bool + func (t *TCF2) FeatureOneEnforced() bool + func (t *TCF2) FeatureOneVendorException(bidder openrtb_ext.BidderName) bool + func (t *TCF2) IsEnabled() bool + func (t *TCF2) PurposeEnforced(purpose consentconstants.Purpose) (enforce bool) + func (t *TCF2) PurposeEnforcementAlgo(purpose consentconstants.Purpose) (enforcement TCF2EnforcementAlgo) + func (t *TCF2) PurposeEnforcingVendors(purpose consentconstants.Purpose) (enforce bool) + func (t *TCF2) PurposeOneTreatmentAccessAllowed() bool + func (t *TCF2) PurposeOneTreatmentEnabled() bool + func (t *TCF2) PurposeVendorExceptions(purpose consentconstants.Purpose) (vendorExceptions map[string]struct{}) + type TCF2EnforcementAlgo int + const TCF2BasicEnforcement + const TCF2FullEnforcement + const TCF2UndefinedEnforcement + type TCF2Purpose struct + EnforceAlgo string + EnforceAlgoID TCF2EnforcementAlgo + EnforcePurpose bool + EnforceVendors bool + VendorExceptionMap map[string]struct{} + VendorExceptions []string + type TCF2PurposeOneTreatment struct + AccessAllowed bool + Enabled bool + type TCF2SpecialFeature struct + Enforce bool + VendorExceptionMap map[openrtb_ext.BidderName]struct{} + VendorExceptions []openrtb_ext.BidderName + type TLS struct + ClientCert string + ClientKey string + RootCert string + type TimeoutNotification struct + FailOnly bool + Log bool + SamplingRate float32 + type TmaxAdjustments struct + BidderNetworkLatencyBuffer uint + BidderResponseDurationMin uint + Enabled bool + PBSResponsePreparationDuration uint + type TrackingEventType string + const Complete + const FirstQuartile + const MidPoint + const Start + const ThirdQuartile + type UserSync struct + Cooperative UserSyncCooperative + ExternalURL string + PriorityGroups [][]string + RedirectURL string + type UserSyncCooperative struct + EnabledByDefault bool + type VASTEvent struct + CreateElement VASTEventElement + ExcludeDefaultURL bool + Type TrackingEventType + URLs []string + type VASTEventElement string + const ClickTrackingVASTElement + const CompanionClickThroughVASTElement + const ErrorVASTElement + const ImpressionVASTElement + const NonLinearClickTrackingVASTElement + const TrackingVASTElement + type VTrack struct + AllowUnknownBidder bool + Enabled bool + TimeoutMS int64 + type Validations struct + BannerCreativeMaxSize string + MaxCreativeHeight int64 + MaxCreativeWidth int64 + SecureMarkup string + func (host *Validations) SetBannerCreativeMaxSize(account Validations) Other modules containing this package github.com/prebid/prebid-server github.com/prebid/prebid-server/v2