Versions in this module Expand all Collapse all v4 v4.0.0 Mar 5, 2026 Changes in this version + var ErrSyncerEndpointRequired = errors.New("at least one endpoint (iframe and/or redirect) is required") + var ErrSyncerKeyRequired = errors.New("key is required") + func BuildSyncers(hostConfig *config.Configuration, bidderInfos config.BidderInfos) (map[string]Syncer, []error) + func SyncHostCookie(r *http.Request, requestCookie *Cookie, host *config.HostCookie) + func WriteCookie(w http.ResponseWriter, encodedCookie string, cfg *config.HostCookie, ...) + type Base64Decoder struct + func (d Base64Decoder) Decode(encodedValue string) *Cookie + type Base64Encoder struct + func (e Base64Encoder) Encode(c *Cookie) (string, error) + type BidderEvaluation struct + Bidder string + Status Status + SyncerKey string + type BidderFilter interface + Allowed func(bidder string) bool + func NewSpecificBidderFilter(bidders []string, mode BidderFilterMode) BidderFilter + func NewUniformBidderFilter(mode BidderFilterMode) BidderFilter + type BidderFilterMode int + const BidderFilterModeExclude + const BidderFilterModeInclude + type Chooser interface + Choose func(request Request, cookie *Cookie) Result + func NewChooser(bidderSyncerLookup map[string]Syncer, biddersKnown map[string]struct{}, ...) Chooser + type Cookie struct + func NewCookie() *Cookie + func ReadCookie(r *http.Request, decoder Decoder, host *config.HostCookie) *Cookie + func (cookie *Cookie) AllowSyncs() bool + func (cookie *Cookie) GetUID(key string) (uid string, isUIDFound bool, isUIDActive bool) + func (cookie *Cookie) GetUIDs() map[string]string + func (cookie *Cookie) HasAnyLiveSyncs() bool + func (cookie *Cookie) HasLiveSync(key string) bool + func (cookie *Cookie) MarshalJSON() ([]byte, error) + func (cookie *Cookie) PrepareCookieForWrite(cfg *config.HostCookie, encoder Encoder, ejector Ejector) (string, error) + func (cookie *Cookie) SetOptOut(optOut bool) + func (cookie *Cookie) Sync(key string, uid string) error + func (cookie *Cookie) UnmarshalJSON(b []byte) error + func (cookie *Cookie) Unsync(key string) + type Cooperative struct + Enabled bool + PriorityGroups [][]string + type Decoder interface + Decode func(encodedValue string) *Cookie + type Ejector interface + Choose func(uids map[string]UIDEntry) (string, error) + type Encoder interface + Encode func(c *Cookie) (string, error) + type OldestEjector struct + func (o *OldestEjector) Choose(uids map[string]UIDEntry) (string, error) + type PriorityBidderEjector struct + IsSyncerPriority bool + PriorityGroups [][]string + SyncersByBidder map[string]Syncer + TieEjector Ejector + func (p *PriorityBidderEjector) Choose(uids map[string]UIDEntry) (string, error) + type Privacy interface + ActivityAllowsUserSync func(bidder string) bool + CCPAAllowsBidderSync func(bidder string) bool + GDPRAllowsBidderSync func(bidder string) bool + GDPRAllowsHostCookie func() bool + GDPRInScope func() bool + type Request struct + Bidders []string + Cooperative Cooperative + Debug bool + GPPSID string + Limit int + Privacy Privacy + SyncTypeFilter SyncTypeFilter + type Result struct + BiddersEvaluated []BidderEvaluation + Status Status + SyncersChosen []SyncerChoice + type SpecificBidderFilter struct + func (f SpecificBidderFilter) Allowed(bidder string) bool + type Status int + const StatusAlreadySynced + const StatusBlockedByDisabledUsersync + const StatusBlockedByPrivacy + const StatusBlockedByRegulationScope + const StatusBlockedByUserOptOut + const StatusDuplicate + const StatusOK + const StatusRejectedByFilter + const StatusUnconfiguredBidder + const StatusUnknownBidder + type Sync struct + Type SyncType + URL string + type SyncType string + const SyncTypeIFrame + const SyncTypeRedirect + const SyncTypeUnknown + type SyncTypeFilter struct + IFrame BidderFilter + Redirect BidderFilter + func (t SyncTypeFilter) ForBidder(bidder string) []SyncType + type Syncer interface + DefaultResponseFormat func() SyncType + GetSync func(syncTypes []SyncType, userSyncMacros macros.UserSyncPrivacy) (Sync, error) + Key func() string + SupportsType func(syncTypes []SyncType) bool + func NewSyncer(hostConfig config.UserSync, syncerConfig config.Syncer, bidder string) (Syncer, error) + type SyncerBuildError struct + Bidder string + Err error + SyncerKey string + func (e SyncerBuildError) Error() string + type SyncerChoice struct + Bidder string + Syncer Syncer + type UIDEntry struct + Expires time.Time + UID string + type UniformBidderFilter struct + func (f UniformBidderFilter) Allowed(bidder string) bool Other modules containing this package github.com/prebid/prebid-server github.com/prebid/prebid-server/v2 github.com/prebid/prebid-server/v3
Go to main page