Versions in this module Expand all Collapse all v1 v1.200.0 Nov 11, 2022 v1.100.0 Nov 11, 2022 v0 v0.400.1 Nov 11, 2022 Changes in this version + const AdCertsSignerModeInprocess + const AdCertsSignerModeOff + const AdCertsSignerModeRemote + const MIN_COOKIE_SIZE_BYTES + const TCF2FullEnforcement + const TCF2NoEnforcement + 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) + type Account struct + AlternateBidderCodes AlternateBidderCodes + CCPA AccountCCPA + CacheTTL DefaultTTLs + CookieSync CookieSync + DebugAllow bool + DefaultIntegration string + Disabled bool + Events Events + EventsEnabled bool + GDPR AccountGDPR + ID string + PriceFloors AccountPriceFloors + TruncateTargetAttribute *int + type AccountCCPA struct + Enabled *bool + IntegrationEnabled AccountIntegration + func (a *AccountCCPA) EnabledForIntegrationType(integrationType IntegrationType) *bool + type AccountFloorFetch struct + Enabled bool + MaxAge int + MaxFileSize int + MaxRules int + Period int + Timeout int + URL string + type AccountGDPR struct + BasicEnforcementVendors []string + BasicEnforcementVendorsMap map[string]struct{} + Enabled *bool + IntegrationEnabled AccountIntegration + 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) BasicEnforcementVendor(bidder openrtb_ext.BidderName) (value, exists bool) + func (a *AccountGDPR) EnabledForIntegrationType(integrationType IntegrationType) *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) PurposeEnforcingVendors(purpose consentconstants.Purpose) (value, exists bool) + func (a *AccountGDPR) PurposeOneTreatmentAccessAllowed() (value, exists bool) + func (a *AccountGDPR) PurposeOneTreatmentEnabled() (value, exists bool) + func (a *AccountGDPR) PurposeVendorException(purpose consentconstants.Purpose, bidder openrtb_ext.BidderName) (value, exists bool) + type AccountGDPRPurpose struct + EnforcePurpose string + EnforceVendors *bool + VendorExceptionMap map[openrtb_ext.BidderName]struct{} + VendorExceptions []openrtb_ext.BidderName + type AccountGDPRPurposeOneTreatment struct + AccessAllowed *bool + Enabled *bool + type AccountGDPRSpecialFeature struct + Enforce *bool + VendorExceptionMap map[openrtb_ext.BidderName]struct{} + VendorExceptions []openrtb_ext.BidderName + type AccountIntegration struct + AMP *bool + App *bool + Video *bool + Web *bool + func (a *AccountIntegration) GetByIntegrationType(integrationType IntegrationType) *bool + type AccountPriceFloors struct + BidAdjustment bool + Enabled bool + EnforceDealFloors bool + EnforceFloorRate int + Fetch AccountFloorFetch + UseDynamicData bool + type Adapter struct + AppSecret string + Disabled bool + Endpoint string + ExtraAdapterInfo string + PlatformID string + Syncer *Syncer + UserSyncURL string + XAPI AdapterXAPI + type AdapterAlternateBidderCodes struct + AllowedBidderCodes []string + Enabled bool + type AdapterXAPI struct + Password string + Tracker string + Username string + type AdsCertInProcess struct + DNSCheckIntervalInSeconds int + DNSRenewalIntervalInSeconds int + Origin string + PrivateKey string + type AdsCertRemote struct + SigningTimeoutMs int + Url string + type AlternateBidderCodes struct + Bidders map[string]AdapterAlternateBidderCodes + Enabled bool + func (bidderCodes *AlternateBidderCodes) IsValidBidderCode(bidder, alternateBidder string) (bool, error) + type Analytics struct + 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 + Capabilities *CapabilitiesInfo + Debug *DebugInfo + Enabled bool + EndpointCompression string + Experiment BidderInfoExperiment + GVLVendorID uint16 + Maintainer *MaintainerInfo + ModifyingVastXmlAllowed bool + Syncer *Syncer + type BidderInfoExperiment struct + AdsCert BidderAdsCert + type BidderInfos map[string]BidderInfo + func LoadBidderInfoFromDisk(path string, adapterConfigs map[string]Adapter, bidders []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 + Site *PlatformInfo + type Configuration struct + AMPTimeoutAdjustment int64 + AccountDefaults Account + AccountRequired bool + Accounts StoredRequests + Adapters map[string]Adapter + AdminPort int + Analytics Analytics + AuctionTimeouts AuctionTimeouts + AutoGenSourceTID bool + BlacklistedAcctMap map[string]bool + BlacklistedAccts []string + BlacklistedAppMap map[string]bool + BlacklistedApps []string + CCPA CCPA + CacheClient HTTPClient + CacheURL Cache + CategoryMapping StoredRequests + Client HTTPClient + CurrencyConverter CurrencyConverter + Debug Debug + DefReqConfig DefReqConfig + EnableGzip bool + Event Event + Experiment Experiment + ExtCacheURL ExternalCache + ExternalURL string + GDPR GDPR + GarbageCollectorThreshold int + GenerateBidID bool + GenerateRequestID bool + 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 + StoredResponses StoredRequests + StoredVideo StoredRequests + TrackerURL string + UnixSocketEnable bool + UnixSocketName string + UserSync UserSync + VTrack VTrack + VendorListScheduler VendorListScheduler + VideoStoredRequestRequired bool + func New(v *viper.Viper) (*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 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 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 + AccountStoredResponses 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 + DialKeepAlive int + DialTimeout int + IdleConnTimeout int + MaxConnsPerHost int + MaxIdleConns int + MaxIdleConnsPerHost int + ResponseHeaderTimeout int + TLSHandshakeTimeout 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 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 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 IntegrationType string + const IntegrationTypeAMP + const IntegrationTypeApp + const IntegrationTypeVideo + const IntegrationTypeWeb + 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 PlatformInfo struct + MediaTypes []openrtb_ext.BidType + type PostgresCacheInitializer struct + AmpQuery string + Query string + Timeout int + type PostgresConfig struct + CacheInitialization PostgresCacheInitializer + ConnectionInfo PostgresConnection + FetcherQueries PostgresFetcherQueries + PollUpdates PostgresUpdatePolling + type PostgresConnection struct + Database string + Host string + Password string + Port int + Username string + func (cfg *PostgresConnection) ConnString() string + type PostgresFetcherQueries struct + AmpQueryTemplate string + QueryTemplate string + func (cfg *PostgresFetcherQueries) MakeQuery(numReqs int, numImps int) (query string) + func (cfg *PostgresFetcherQueries) MakeQueryResponses(numIds int) (query string) + type PostgresUpdatePolling struct + AmpQuery string + Query string + RefreshRate int + Timeout int + type PriceFloors struct + Enabled bool + EnforceDealFloors bool + EnforceFloorsRate int + UseDynamicData bool + type Privacy struct + CCPA CCPA + GDPR GDPR + LMT LMT + 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 StoredRequests struct + CacheEvents CacheEventsConfig + Files FileFetcherConfig + HTTP HTTPFetcherConfig + HTTPEvents HTTPEventsConfig + InMemoryCache InMemoryCache + Postgres PostgresConfig + func (sr *StoredRequests) DataType() DataType + func (sr *StoredRequests) Section() string + func (sr *StoredRequests) SetDataType(dataType DataType) + type Syncer struct + ExternalURL string + IFrame *SyncerEndpoint + Key string + Redirect *SyncerEndpoint + SupportCORS *bool + Supports []string + 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) BasicEnforcementVendor(openrtb_ext.BidderName) bool + func (t *TCF2) FeatureOneEnforced() (value bool) + func (t *TCF2) FeatureOneVendorException(bidder openrtb_ext.BidderName) (value bool) + func (t *TCF2) IntegrationEnabled(integrationType IntegrationType) bool + func (t *TCF2) IsEnabled() bool + func (t *TCF2) PurposeEnforced(purpose consentconstants.Purpose) (value bool) + func (t *TCF2) PurposeEnforcingVendors(purpose consentconstants.Purpose) (value bool) + func (t *TCF2) PurposeOneTreatmentAccessAllowed() (value bool) + func (t *TCF2) PurposeOneTreatmentEnabled() (value bool) + func (t *TCF2) PurposeVendorException(purpose consentconstants.Purpose, bidder openrtb_ext.BidderName) (value bool) + type TCF2Purpose struct + Enabled bool + EnforcePurpose string + EnforceVendors bool + VendorExceptionMap map[openrtb_ext.BidderName]struct{} + VendorExceptions []openrtb_ext.BidderName + type TCF2PurposeOneTreatment struct + AccessAllowed bool + Enabled bool + type TCF2SpecialFeature struct + Enforce bool + VendorExceptionMap map[openrtb_ext.BidderName]struct{} + VendorExceptions []openrtb_ext.BidderName + type TimeoutNotification struct + FailOnly bool + Log bool + SamplingRate float32 + type TrackingEventType string + const Complete + const FirstQuartile + const MidPoint + const Start + const ThirdQuartile + type UserSync struct + Cooperative UserSyncCooperative + ExternalURL string + RedirectURL string + type UserSyncCooperative struct + EnabledByDefault bool + PriorityGroups [][]string + 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 VendorListScheduler struct + Enabled bool + Interval string + Timeout string Other modules containing this package github.com/PubMatic-OpenWrap/prebid-server/v2