usersync

type Base64Decoder struct{}

type Base64Encoder struct{}

type BidderEvaluation struct {
	Bidder    string
	SyncerKey string
	Status    Status
}

type BidderFilter interface {
	// Allowed returns true if the filter determines the bidder has permission and false if either
	// the bidder does not have permission or if the filter has an invalid mode.
	Allowed(bidder string) bool
}

type BidderFilterMode int

type Chooser interface {
	// Choose considers bidders to sync, filters the bidders, and returns the result of the
	// user sync selection.
	Choose(request Request, cookie *Cookie) Result
}

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

type Cooperative struct {
	Enabled        bool
	PriorityGroups [][]string
}

type Decoder interface {
	Decode(encodedValue string) *Cookie
}

type Ejector interface {
	Choose(uids map[string]UIDEntry) (string, error)
}

type Encoder interface {
	// Encode a cookie into a base 64 string
	Encode(c *Cookie) (string, error)
}

type OldestEjector struct{}

type PriorityBidderEjector struct {
	PriorityGroups   [][]string
	SyncersByBidder  map[string]Syncer
	IsSyncerPriority bool
	TieEjector       Ejector
}

type Privacy interface {
	GDPRAllowsHostCookie() bool
	GDPRInScope() bool
	GDPRAllowsBidderSync(bidder string) bool
	CCPAAllowsBidderSync(bidder string) bool
	ActivityAllowsUserSync(bidder string) bool
}

type Request struct {
	Bidders        []string
	Cooperative    Cooperative
	Limit          int
	Privacy        Privacy
	SyncTypeFilter SyncTypeFilter
	GPPSID         string
	Debug          bool
}

type Result struct {
	BiddersEvaluated []BidderEvaluation
	Status           Status
	SyncersChosen    []SyncerChoice
}

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

type Status int

type Sync struct {
	URL         string
	Type        SyncType
	SupportCORS bool
}

type SyncType string

type SyncTypeFilter struct {
	IFrame   BidderFilter
	Redirect BidderFilter
}

type Syncer interface {
	// Key is the name of the syncer as stored in the user's cookie. This is often, but not
	// necessarily, a one-to-one mapping with a bidder.
	Key() string

	// DefaultResponseFormat is the default SyncType for this syncer.
	DefaultResponseFormat() SyncType

	// SupportsType returns true if the syncer supports at least one of the specified sync types.
	SupportsType(syncTypes []SyncType) bool

	// GetSync returns a user sync for the user's device to perform, or an error if the none of the
	// sync types are supported or if macro substitution fails.
	GetSync(syncTypes []SyncType, userSyncMacros macros.UserSyncPrivacy) (Sync, error)
}

type SyncerBuildError struct {
	Bidder    string
	SyncerKey string
	Err       error
}

type SyncerChoice struct {
	Bidder string
	Syncer Syncer
}

type UIDEntry struct {
	// UID is the ID given to a user by a particular bidder
	UID string `json:"uid"`
	// Expires is the time at which this UID should no longer apply.
	Expires time.Time `json:"expires"`
}

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