The TCF designates certain Features as special, that is, a CMP must afford
the user a means to opt in to their use. These Special Features are
published and numbered in the GVL separately from normal Features.
Provides for up to 12 special features.
Renamed from PurposesAllowed in TCF v1.1
The user’s consent value for each Purpose established on the legal basis
of consent. Purposes are published in the Global Vendor List (see. GVL).
The user’s consent value for each Purpose established on the legal basis
of consent, for the publisher. Purposes are published in the Global
Vendor List.
The user’s permission for each Purpose established on the legal basis of
legitimate interest. If the user has exercised right-to-object for a
purpose.
The user’s permission for each Purpose established on the legal basis of
legitimate interest. If the user has exercised right-to-object for a
purpose.
The user’s consent value for each Purpose established on the legal basis
of consent, for the publisher. Purposes are published in the Global
Vendor List.
The user’s permission for each Purpose established on the legal basis of
legitimate interest. If the user has exercised right-to-object for a
purpose that is established in the publisher's custom purposes.
Each Vendor is keyed by id. Their consent value is true if it is in
the Vector
Each Vendor is keyed by id. Whether their Legitimate Interest
Disclosures have been established is stored as boolean.
see: Vector
The value included for disclosed vendors signals which vendors have been
disclosed to the user in the interface surfaced by the CMP. This section
content is required when writing a TC string to the global (consensu)
scope. When a CMP has read from and is updating a TC string from the
global consensu.org storage, the CMP MUST retain the existing disclosure
information and only add information for vendors that it has disclosed
that had not been disclosed by other CMPs in prior interactions with this
device/user agent.
Signals which vendors the publisher permits to use OOB legal bases.
Each change to an operating CMP should receive a
new version number, for logging proof of consent. CmpVersion defined by
each CMP.
The screen number is CMP and CmpVersion
specific, and is for logging proof of consent.(For example, a CMP could
keep records so that a publisher can request information about the context
in which consent was gathered.)
Version of the GVL used to create this TCModel. Global
Vendor List versions will be released periodically.
From the corresponding field in the GVL that was
used for obtaining consent. A new policy version invalidates existing
strings and requires CMPs to re-establish transparency and consent from
users.
Incremented when TC String format changes. Indicates
what encoding format the TCString will follow v1 or v2. v1 fields will
omit fields.
Whether the signals encoded in this TC String were from site-specific
storage true versus ‘global’ consensu.org shared storage false. A
string intended to be stored in global/shared scope but the CMP is unable
to store due to a user agent not accepting third-party cookies would be
considered site-specific true.
Non-standard stacks means that a CMP is using publisher-customized stack
descriptions. Stacks (in terms of purposes in a stack) are pre-set by the
IAB. As are titles. Descriptions are pre-set, but publishers can customize
them. If they do, they need to set this bit to indicate that they've
customized descriptions.
false There is no special Purpose 1 status.
Purpose 1 was disclosed normally (consent) as expected by Policy. true
Purpose 1 not disclosed at all. CMPs use PublisherCC to indicate the
publisher’s country of establishment to help Vendors determine whether the
vendor requires Purpose 1 consent. In global scope TC strings, this field
must always have a value of false. When a CMP encounters a global scope
string with purposeOneTreatment=true then that string should be
considered invalid and the CMP must re-establish transparency and consent.
If a TCF policy version number is different from the one from the latest GVL, the CMP must re-establish transparency and consent.
set by a publisher if they wish to collect consent and LI Transparency for purposes outside of the TCF
Set of available consent languages published by the IAB
sets the GVL with side effects of also setting the vendorListVersion, policyVersion, and consentLanguage
clone - returns a copy of the classes with new values and not references
setAll - calls:
setAllVendorConsents();
setAllPurposeLegitimateInterest();
setAllSpecialFeatureOptIns();
setAllPurposeConsents();
setAllVendorLegitimateInterest();setAllPurposeConsents - sets all purposes on the GVL Consent (true)
setAllPurposeLegitimateInterest - sets all purposes on the GVL LI Transparency (true)
setAllSpecialFeatureOptIns - sets all special featuresOptins on the GVL (true)
setAllVendorConsents - sets all vendors on the GVL Consent (true)
setAllVendorLegitimateInterest - sets all vendors on the GVL LegitimateInterest (true)
setAllVendorsAllowed - sets all vendors on the GVL Consent (true)
setAllVendorsDisclosed - sets all vendors on the GVL Vendors Disclosed (true)
unsetAll - calls:
unsetAllVendorConsents();
unsetAllPurposeLegitimateInterest();
unsetAllSpecialFeatureOptIns();
unsetAllPurposeConsents();
unsetAllVendorLegitimateInterest();unsetAllPurposeConsents - unsets all purposes on the GVL Consent (false)
unsetAllPurposeLegitimateInterest - unsets all purposes on the GVL LI Transparency (false)
unsetAllSpecialFeatureOptIns - unsets all special featuresOptins on the GVL (true)
unsetAllVendorConsents - unsets all vendors on the GVL Consent (false)
unsetAllVendorLegitimateInterest - unsets all vendors on the GVL LegitimateInterest (false)
unsetAllVendorsAllowed - unsets all vendors on the GVL Consent (false)
unsetAllVendorsDisclosed - unsets all vendors on the GVL Consent (false)
updated - updates the lastUpdatedDate with a 'now' timestamp
Generated using TypeDoc
Constructs the TCModel. Passing a GVL is optional when constructing as this TCModel may be constructed from decoding an existing encoded TCString.