Skip to content

Latest commit

 

History

History
207 lines (120 loc) · 4.52 KB

profile-privacy.schema.md

File metadata and controls

207 lines (120 loc) · 4.52 KB

IAB TCF 2.0 Consent Details Schema

https://ns.adobe.com/xdm/context/profile-privacy

Record the IAB TCF 2.0 string in a user's profile.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/profile/profile-privacy.schema.json

Schema Hierarchy

  • IAB TCF 2.0 Consent Details https://ns.adobe.com/xdm/context/profile-privacy

IAB TCF 2.0 Consent Details Example

{
  "xdm:optOutConsentLevel": {
    "xdm:privacyOptOuts": [
      {
        "xdm:optOutType": "general_opt_out",
        "xdm:optOutValue": "out",
        "xdm:timestamp": "2019-01-01T15:52:25+00:00"
      }
    ]
  },
  "xdm:identityPrivacyInfo": {
    "ECID": {
      "11112222233333444": {
        "xdm:identityIABConsent": {
          "xdm:consentTimestamp": "2020-04-11T05:05:05Z",
          "xdm:consentString": {
            "xdm:consentStandard": "IAB TCF",
            "xdm:consentStandardVersion": "2.0",
            "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA",
            "xdm:gdprApplies": true,
            "xdm:containsPersonalData": false
          }
        }
      }
    }
  }
}

IAB TCF 2.0 Consent Details Properties

Property Type Required Defined by
xdm:identityPrivacyInfo object Optional IAB TCF 2.0 Consent Details (this schema)
xdm:optOutConsentLevel object Optional IAB TCF 2.0 Consent Details (this schema)
* any Additional this schema allows additional properties

xdm:identityPrivacyInfo

Identity level privacy information

Captured privacy information for identities in profile.

xdm:identityPrivacyInfo

  • is optional
  • type: object
  • defined in this schema

xdm:identityPrivacyInfo Type

object with following properties:

Property Type Required

xdm:optOutConsentLevel

Opt-out consent level (deprecated)

Opt-out consent level (deprecated).

xdm:optOutConsentLevel

  • is optional
  • type: object
  • defined in this schema

xdm:optOutConsentLevel Type

object with following properties:

Property Type Required
xdm:privacyOptOuts array Optional

xdm:privacyOptOuts

Privacy opt-outs (deprecated)

Encapsulates different opt-out types for data privacy (deprecated).

xdm:privacyOptOuts

  • is optional
  • type: object[]
xdm:privacyOptOuts Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
xdm:optOutType string Optional
xdm:optOutValue string Optional
xdm:timestamp string Optional

xdm:optOutType

Opt-out type

The type of opt-out.

xdm:optOutType

  • is optional
  • type: enum

The value of this property must be equal to one of the known values below.

xdm:optOutType Known Values
Value Description
general_opt_out General opt-out
sales_sharing_opt_out Sales sharing opt-out

xdm:optOutValue

Opt-out value

The value of opt-out signal.

xdm:optOutValue

  • is optional
  • type: enum

The value of this property must be equal to one of the known values below.

xdm:optOutValue Known Values
Value Description
not_provided Not provided
pending Pending verification
in Opt-in
out Opt-out

xdm:timestamp

Opt-out timestamp

Timestamp of the received opt-out signal.

xdm:timestamp

  • is optional
  • type: string
xdm:timestamp Type

string