privacy

Documentation

Index

• Constants
• func ScrubDeviceIDsIPsUserDemoExt(reqWrapper *openrtb_ext.RequestWrapper, ipConf IPConf, fieldName string, ...)
• func ScrubEIDs(reqWrapper *openrtb_ext.RequestWrapper) error
• func ScrubGdprID(reqWrapper *openrtb_ext.RequestWrapper)
• func ScrubGeoAndDeviceIP(reqWrapper *openrtb_ext.RequestWrapper, ipConf IPConf)
• func ScrubTID(reqWrapper *openrtb_ext.RequestWrapper)
• func ScrubUserFPD(reqWrapper *openrtb_ext.RequestWrapper)
• type Activity
  • func (a Activity) String() string
• type ActivityControl
  • func NewActivityControl(cfg *config.AccountPrivacy) ActivityControl
  • func (e ActivityControl) Allow(activity Activity, target Component, request ActivityRequest) bool
• type ActivityPlan
  • func (p ActivityPlan) Evaluate(target Component, request ActivityRequest) bool
• type ActivityRequest
  • func NewRequestFromBidRequest(r openrtb_ext.RequestWrapper) ActivityRequest
  • func NewRequestFromPolicies(p Policies) ActivityRequest
  • func (r ActivityRequest) IsBidRequest() bool
  • func (r ActivityRequest) IsPolicies() bool
• type ActivityResult
• type Component
  • func (c Component) MatchesName(v string) bool
  • func (c Component) MatchesType(v string) bool
• type ConditionRule
  • func (r ConditionRule) Evaluate(target Component, request ActivityRequest) ActivityResult
• type EnabledPolicyEnforcer
  • func (p EnabledPolicyEnforcer) CanEnforce() bool
  • func (p EnabledPolicyEnforcer) ShouldEnforce(bidder string) bool
• type IPConf
• type NilPolicyEnforcer
  • func (NilPolicyEnforcer) CanEnforce() bool
  • func (NilPolicyEnforcer) ShouldEnforce(bidder string) bool
• type NilPolicyWriter
  • func (NilPolicyWriter) Write(req *openrtb2.BidRequest) error
• type Policies
• type PolicyEnforcer
• type PolicyWriter
• type Rule

Constants

const (
	ComponentTypeBidder       = "bidder"
	ComponentTypeAnalytics    = "analytics"
	ComponentTypeRealTimeData = "rtd"
	ComponentTypeGeneral      = "general"
)

Functions

func ScrubDeviceIDsIPsUserDemoExt

func ScrubDeviceIDsIPsUserDemoExt(reqWrapper *openrtb_ext.RequestWrapper, ipConf IPConf, fieldName string, scrubFullGeo bool)

func ScrubEIDs

func ScrubEIDs(reqWrapper *openrtb_ext.RequestWrapper) error

func ScrubGdprID

func ScrubGdprID(reqWrapper *openrtb_ext.RequestWrapper)

func ScrubGeoAndDeviceIP

func ScrubGeoAndDeviceIP(reqWrapper *openrtb_ext.RequestWrapper, ipConf IPConf)

func ScrubTID

func ScrubTID(reqWrapper *openrtb_ext.RequestWrapper)

func ScrubUserFPD

func ScrubUserFPD(reqWrapper *openrtb_ext.RequestWrapper)

Types

type Activity

type Activity int

Activity defines Prebid Server actions which can be controlled directly by the publisher or via privacy policies.

const (
	ActivitySyncUser Activity = iota + 1
	ActivityFetchBids
	ActivityEnrichUserFPD
	ActivityReportAnalytics
	ActivityTransmitUserFPD
	ActivityTransmitPreciseGeo
	ActivityTransmitUniqueRequestIDs
	ActivityTransmitTIDs
)

func (Activity) String

func (a Activity) String() string

type ActivityControl

type ActivityControl struct {
	IPv6Config config.IPv6
	IPv4Config config.IPv4
	// contains filtered or unexported fields
}

func NewActivityControl

func NewActivityControl(cfg *config.AccountPrivacy) ActivityControl

func (ActivityControl) Allow

func (e ActivityControl) Allow(activity Activity, target Component, request ActivityRequest) bool

type ActivityPlan

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

func (ActivityPlan) Evaluate

func (p ActivityPlan) Evaluate(target Component, request ActivityRequest) bool

type ActivityRequest

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

func NewRequestFromBidRequest

func NewRequestFromBidRequest(r openrtb_ext.RequestWrapper) ActivityRequest

func NewRequestFromPolicies

func NewRequestFromPolicies(p Policies) ActivityRequest

func (ActivityRequest) IsBidRequest

func (r ActivityRequest) IsBidRequest() bool

func (ActivityRequest) IsPolicies

func (r ActivityRequest) IsPolicies() bool

type ActivityResult

type ActivityResult int

const (
	ActivityAbstain ActivityResult = iota
	ActivityAllow
	ActivityDeny
)

type Component

type Component struct {
	Type string
	Name string
}

func (Component) MatchesName

func (c Component) MatchesName(v string) bool

func (Component) MatchesType

func (c Component) MatchesType(v string) bool

type ConditionRule

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

func (ConditionRule) Evaluate

func (r ConditionRule) Evaluate(target Component, request ActivityRequest) ActivityResult

type EnabledPolicyEnforcer

type EnabledPolicyEnforcer struct {
	Enabled        bool
	PolicyEnforcer PolicyEnforcer
}

EnabledPolicyEnforcer decorates a PolicyEnforcer with an enabled flag.

func (EnabledPolicyEnforcer) CanEnforce

func (p EnabledPolicyEnforcer) CanEnforce() bool

CanEnforce returns true when the PolicyEnforcer can enforce.

func (EnabledPolicyEnforcer) ShouldEnforce

func (p EnabledPolicyEnforcer) ShouldEnforce(bidder string) bool

ShouldEnforce returns true when the enforcer is enabled the PolicyEnforcer allows enforcement.

type IPConf

type IPConf struct {
	IPV6 config.IPv6
	IPV4 config.IPv4
}

type NilPolicyEnforcer

type NilPolicyEnforcer struct{}

NilPolicyEnforcer implements the PolicyEnforcer interface but will always return false.

func (NilPolicyEnforcer) CanEnforce

func (NilPolicyEnforcer) CanEnforce() bool

CanEnforce is hardcoded to always return false.

func (NilPolicyEnforcer) ShouldEnforce

func (NilPolicyEnforcer) ShouldEnforce(bidder string) bool

ShouldEnforce is hardcoded to always return false.

type NilPolicyWriter

type NilPolicyWriter struct{}

NilPolicyWriter implements the PolicyWriter interface but performs no action.

func (NilPolicyWriter) Write

func (NilPolicyWriter) Write(req *openrtb2.BidRequest) error

Write is hardcoded to perform no action with the OpenRTB bid request.

type Policies

type Policies struct {
	GPPSID []int8
}

Policies contains privacy signals and consent for non-OpenRTB activities.

type PolicyEnforcer

type PolicyEnforcer interface {
	// CanEnforce returns true when policy information is specifically provided by the publisher.
	CanEnforce() bool

	// ShouldEnforce returns true when the OpenRTB request should have personally identifiable
	// information (PII) removed or anonymized per the policy.
	ShouldEnforce(bidder string) bool
}

PolicyEnforcer determines if personally identifiable information (PII) should be removed or anonymized per the policy.

type PolicyWriter

type PolicyWriter interface {
	Write(req *openrtb2.BidRequest) error
}

PolicyWriter mutates an OpenRTB bid request with a policy's regulatory information.

type Rule

type Rule interface {
	Evaluate(target Component, request ActivityRequest) ActivityResult
}