Skip to content

Latest commit

 

History

History
166 lines (92 loc) · 3.41 KB

profile-privacy.schema.md

File metadata and controls

166 lines (92 loc) · 3.41 KB

Profile privacy Schema

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

Profile privacy schema captures general and sales sharing opt-out signals.

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

Schema Hierarchy

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

Profile privacy Example

{
  "xdm:optOutConsentLevel": {
    "xdm:privacyOptOuts": [
      {
        "xdm:optOutType": "general_opt_out",
        "xdm:optOutValue": "out",
        "xdm:timestamp": "2019-01-01T15:52:25+00:00"
      }
    ]
  }
}

Profile privacy Properties

Property Type Required Defined by
xdm:optOutConsentLevel object Optional Profile privacy (this schema)
* any Additional this schema allows additional properties

xdm:optOutConsentLevel

Opt-out consent level

Opt-out consent level.

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

Encapsulates different opt-out types for data privacy.

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