api

Documentation

Index

• type Vendor
• type VendorConsents
• type VendorList

Types

type Vendor

type Vendor interface {
	// Purpose returns true if this vendor claims to use data for the given purpose, or false otherwise
	Purpose(purposeID consentconstants.Purpose) bool
	// PurposeStrict checks only for the primary purpose, not considering flex purposes.
	PurposeStrict(purposeID consentconstants.Purpose) bool

	// LegitimateInterest returns true if this vendor claims a "Legitimate Interest" to
	// use data for the given purpose.
	//
	// For an explanation of legitimate interest, see https://www.gdpreu.org/the-regulation/key-concepts/legitimate-interest/
	LegitimateInterest(purposeID consentconstants.Purpose) bool
	// LegitimateInterestStrict checks only for the primary legitimate, not considering flex purposes.
	LegitimateInterestStrict(purposeID consentconstants.Purpose) (hasLegitimateInterest bool)
	// SpecialPurpose returns true if this vendor claims a need for the given special purpose
	SpecialPurpose(purposeID consentconstants.Purpose) (hasSpecialPurpose bool)
	// SpecialFeature returns true if this vendor claims a need for the given special feature
	SpecialFeature(featureID consentconstants.SpecialFeature) (hasSpecialFeature bool)
}

Vendor describes which purposes a given vendor claims to use data for, in this vendor list.

type VendorConsents

type VendorConsents interface {
	// The version of the Consent string.
	Version() uint8

	// The time that the consent string was first created
	Created() time.Time

	// The time that the consent string was last updated
	LastUpdated() time.Time

	// The ID of the CMP used to update the consent string.
	CmpID() uint16

	// The version of the CMP used to update the consent string
	CmpVersion() uint16

	// The number of the CMP screen where consent was given
	ConsentScreen() uint8

	// The two-letter ISO639-1 language code used by the CMP to ask for consent, in uppercase.
	ConsentLanguage() string

	// The VendorListVersion which is needed to interpret this consent string.
	//
	// The IAB is hosting these on their webpage. For example, version 2 of the
	// Vendor List can be found at https://vendorlist.consensu.org/v-2/vendorlist.json
	//
	// For other versions, just replace the "v-*" path with the value returned here.
	// The latest version can always be found at https://vendorlist.consensu.org/vendorlist.json
	VendorListVersion() uint16

	// MaxVendorID describes how many vendors are encoded into the string.
	// This is the upper bound (inclusive) on valid inputs for HasConsent(id).
	MaxVendorID() uint16

	// Determine if the user has consented to use data for the given Purpose.
	//
	// If the purpose is converted from an int > 24, the return value is undefined because
	// the consent string doesn't have room for more purposes than that.
	PurposeAllowed(id consentconstants.Purpose) bool

	// Determine if a given vendor has consent to collect or receive user info.
	//
	// This function's behavior is undefined for "invalid" IDs.
	// IDs with value < 1 or value > MaxVendorID() are definitely invalid, but IDs within that range
	// may still be invalid, depending on the Vendor List.
	//
	// It is the caller's responsibility to get the right Vendor List version for the semantics of the ID.
	// For more information, see VendorListVersion().
	VendorConsent(id uint16) bool
}

VendorConsents is a GDPR Vendor Consent string, as defined by IAB Europe. For technical details, see https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/Consent%20string%20and%20vendor%20list%20formats%20v1.1%20Final.md#vendor-consent-string-format-

type VendorList

type VendorList interface {
	// Version returns the version of the vendor list which this is.
	//
	// If the input was malformed, this will return 0.
	Version() uint16

	// Vendor returns info about the vendor with the given ID.
	// This returns nil if that vendor isn't in this list, or the input was malformed somehow.
	//
	// If callers need to query multiple Purpose or LegitimateInterest statuses from the same vendor,
	// they should call this function once and then reuse the object it returns for future queries.
	Vendor(vendorID uint16) Vendor
}

VendorList is an interface used to fetch information about an IAB Global Vendor list. For the latest version, see: https://vendorlist.consensu.org/vendorlist.json