Consent for Privacy, Personalization and Marketing Preferences Schema

https://ns.adobe.com/xdm/datatypes/consents-and-preferences

This mixin captures consumer consent for collection and use of data related to privacy, personalization and marketing preferences.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stable	No	Forbidden	Permitted	datatypes/consent-preferences.schema.json

Consent for Privacy, Personalization and Marketing Preferences Example

{
  "xdm:consents": {
    "xdm:collect": {
      "xdm:val": "y"
    },
    "xdm:adID": {
      "xdm:val": "VI"
    },
    "xdm:share": {
      "xdm:val": "n"
    },
    "xdm:personalize": {
      "xdm:content": {
        "xdm:val": "y"
      }
    },
    "xdm:marketing": {
      "xdm:preferred": "email",
      "xdm:any": {
        "xdm:val": "y"
      },
      "xdm:email": {
        "xdm:val": "y"
      },
      "xdm:push": {
        "xdm:val": "n",
        "xdm:reason": "Too Frequent"
      }
    },
    "xdm:metadata": {
      "xdm:time": "2019-01-01T15:52:25+00:00"
    }
  }
}

Consent for Privacy, Personalization and Marketing Preferences Properties

Property	Type	Required	Defined by
xdm:consents	complex	Optional	Consent for Privacy, Personalization and Marketing Preferences (this schema)
`*`	any	Additional	this schema allows additional properties

xdm:consents

Consents and Preferences

Specific Consent and Preference Options

xdm:consents

is optional
type: complex
defined in this schema

xdm:consents Type

All of the following requirements need to be fulfilled.

Requirement 1

– #/definitions/choices

Requirement 2

Consent for Privacy, Personalization and Marketing Preferences Definitions

Property	Type	Group
xdm:adID	reference	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/choices`
xdm:collect	reference	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/choices`
xdm:marketing	`object`	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/choices`
xdm:personalize	`object`	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/choices`
xdm:reason	`string`	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/marketing-fields`
xdm:share	reference	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/choices`
xdm:time	`string`	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/metadata`
xdm:val	reference	`https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/marketing-fields`

xdm:adID

Use Advertiser ID

The Advertiser ID (IDFA / AAID) can be used to link user across apps on this device

xdm:adID

is optional
type: reference
defined in this schema

xdm:adID Type

– #/definitions/consent-fields

xdm:collect

Data Collection

Data collection is permitted

xdm:collect

is optional
type: reference
defined in this schema

xdm:collect Type

– #/definitions/consent-fields

xdm:marketing

Marketing Preferences

User's Direct Marketing Preferences

xdm:marketing

is optional
type: object
defined in this schema

xdm:marketing Type

object with following properties:

Property	Type	Required
`xdm:any`		Optional
`xdm:email`		Optional
`xdm:preferred`	string	Optional
`xdm:push`		Optional
`xdm:sms`		Optional

xdm:any

General Direct Marketing Preference

Does user permit any type of direct marketing

xdm:any

is optional
type: reference

xdm:any Type

– #/definitions/marketing-fields

xdm:email

Receive email

User agrees to receive email

xdm:email

is optional
type: reference

xdm:email Type

– #/definitions/marketing-fields

xdm:preferred

Preferred Channel

User's preferred channel for receiving communications

xdm:preferred

is optional
type: enum

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

xdm:preferred Known Values

Value	Description
`email`	email
`push`	Push Notifications
`inApp`	In-app Messages
`sms`	SMS (Text Messages)
`phone`	Phone Calls
`phyMail`	Physical Mail
`inVehicle`	In-vehicle Messages
`inHome`	In-home Messages
`iot`	IoT Messages
`social`	Social Media
`other`	Other
`none`	No Preferred Channel
`unknown`	Unknown

xdm:push

Receive push notifications

User permits receiving push notifications

xdm:push

is optional
type: reference

xdm:push Type

– #/definitions/marketing-fields

xdm:sms

Receive SMS

User agrees to receive text messages

xdm:sms

is optional
type: reference

xdm:sms Type

– #/definitions/marketing-fields

xdm:personalize

Personalization Preferences

User's Personalization Preferences

xdm:personalize

is optional
type: object
defined in this schema

xdm:personalize Type

object with following properties:

Property	Type	Required
`xdm:content`		Optional

xdm:content

Personalize Content

Allow personalization of the content on my site or in my apps

xdm:content

is optional
type: reference

xdm:content Type

– #/definitions/personalization-fields

xdm:reason

Opt-out reason

Reason for opting out

xdm:reason

is optional
type: string
defined in this schema

xdm:reason Type

string

maximum length: 16 characters

xdm:share

Share Data

Sharing of user's data with 2nd or 3rd parties is permitted

xdm:share

is optional
type: reference
defined in this schema

xdm:share Type

– #/definitions/consent-fields

xdm:time

Consent/Preferences timestamp

Timestamp of this complete set of user consents and preferences. This value should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

xdm:time

is optional
type: string
defined in this schema

xdm:time Type